You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: spec.md
+4-4
Original file line number
Diff line number
Diff line change
@@ -176,7 +176,7 @@ An object representing a Server Variable for server URL template substitution.
176
176
Field Name | Type | Description
177
177
---|:---:|---
178
178
<aname="server-variable-enum"></a>enum | `[string]` | An enumeration of string values to be used if the substitution options are from a limited set.
179
-
<aname="server-variable-default"></a>default | `string` | **REQUIRED**. The default value to use for substitution, which SHALL be sent if an alternate value is _not_ supplied. Note this behavior is different than the [Schema Object's](#schema-object) treatment of default values, because in those cases parameter values are optional.
179
+
<aname="server-variable-default"></a>default | `string` | **REQUIRED**. The default value to use for substitution, which SHALL be sent if an alternate value is *not* supplied. Note this behavior is different than the [Schema Object's](#schema-object) treatment of default values, because in those cases parameter values are optional.
180
180
<aname="server-variable-description"></a>description | `string` | An optional description for the server variable. [GitHub Flavored Markdown syntax](https://github.github.com/gfm/) MAY be used for rich text representation.
181
181
182
182
This object MAY be extended with [Specification Extensions](#specification-extensions).
@@ -209,7 +209,7 @@ Content Descriptors are objects that do just as they suggest - describe content.
209
209
210
210
Field Name | Type | Description
211
211
---|:---:|---
212
-
<aname="content-descriptor-name"></a>name | `string` | **REQUIRED**. Name of the content that is being described. If the content described is a method parameter assignable [`by-name`](#method-param-structure), this field SHALL define the parameter's key (_ie_ name).
212
+
<aname="content-descriptor-name"></a>name | `string` | **REQUIRED**. Name of the content that is being described. If the content described is a method parameter assignable [`by-name`](#method-param-structure), this field SHALL define the parameter's key (*ie* name).
213
213
<aname="content-descriptor-summary"></a>summary | `string` | A short summary of the content that is being described.
214
214
<aname="content-descriptor-description"></a>description | `string` | A verbose explanation of the content descriptor behavior. [GitHub Flavored Markdown syntax](https://github.github.com/gfm/) MAY be used for rich text representation.
215
215
<aname="content-descriptor-required"></a>required | `boolean` | Determines if the content is a required field. Default value is `false`.
@@ -261,7 +261,7 @@ In all cases, the example value is expected to be compatible with the type schem
261
261
The `Link object` represents a possible design-time link for a result.
262
262
The presence of a link does not guarantee the caller's ability to successfully invoke it, rather it provides a known relationship and traversal mechanism between results and other methods.
263
263
264
-
Unlike _dynamic_ links (i.e. links provided **in** the result payload), the OpenRPC linking mechanism does not require link information in the runtime result.
264
+
Unlike *dynamic* links (i.e. links provided **in** the result payload), the OpenRPC linking mechanism does not require link information in the runtime result.
265
265
266
266
For computing links, and providing instructions to execute them, a [runtime expression](#runtime-expression) is used for accessing values in an method and using them as parameters while invoking the linked method.
267
267
@@ -270,7 +270,7 @@ Field Name | Type | Description
270
270
<aname="link-name"></a>name | `string` | **REQUIRED**. Cannonical name of the link.
271
271
<aname="link-description"></a>description | `string` | A description of the link. [GitHub Flavored Markdown syntax](https://github.github.com/gfm/) MAY be used for rich text representation.
272
272
<aname="link-summary"></a>summary | `string` | Short description for the link.
273
-
<aname="link-method"></a>method | `string` | The name of an _existing_, resolvable OpenRPC method, as defined with a unique `method`. This field MUST resolve to a unique [Method Object](#method-object). As opposed to Open Api, Relative `method` values ARE NOT permitted.
273
+
<aname="link-method"></a>method | `string` | The name of an *existing*, resolvable OpenRPC method, as defined with a unique `method`. This field MUST resolve to a unique [Method Object](#method-object). As opposed to Open Api, Relative `method` values ARE NOT permitted.
274
274
<aname="link-parameters"></a>params | Map[`string`, `Any`\|[Runtime Expression](#runtime-expression)] | A map representing parameters to pass to a method as specified with `method`. The key is the parameter name to be used, whereas the value can be a constant or a [runtime expression](#runtime-expression) to be evaluated and passed to the linked method.
275
275
<aname="link-server"></a>server | [Server Object](#server-object) | A server object to be used by the target method.
0 commit comments