From a94ea517ae7a34840ec60f6f555b14fd57d4510b Mon Sep 17 00:00:00 2001 From: Zachary Belford Date: Thu, 7 Mar 2024 16:42:21 -0800 Subject: [PATCH] fix: markdownlint issues --- README.md | 4 ++-- spec.md | 8 ++++---- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index b4201a4..aafda96 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,5 @@ +# The OpenRPC Specification Repository +

open-rpc logo

@@ -6,8 +8,6 @@ Join us on Discord!

-# The OpenRPC Specification Repository - ## Purpose of this Repository This is a repository that contains the OpenRPC specification, and the tooling to build, maintain, and release the specification. diff --git a/spec.md b/spec.md index 54398d1..0f693bf 100644 --- a/spec.md +++ b/spec.md @@ -176,7 +176,7 @@ An object representing a Server Variable for server URL template substitution. Field Name | Type | Description ---|:---:|--- enum | `[string]` | An enumeration of string values to be used if the substitution options are from a limited set. -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. +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. 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. 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. Field Name | Type | Description ---|:---:|--- -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). +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). summary | `string` | A short summary of the content that is being described. 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. 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 The `Link object` represents a possible design-time link for a result. 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. -Unlike _dynamic_ links (i.e. links provided **in** the result payload), the OpenRPC linking mechanism does not require link information in the runtime result. +Unlike *dynamic* links (i.e. links provided **in** the result payload), the OpenRPC linking mechanism does not require link information in the runtime result. 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. @@ -270,7 +270,7 @@ Field Name | Type | Description name | `string` | **REQUIRED**. Cannonical name of the link. description | `string` | A description of the link. [GitHub Flavored Markdown syntax](https://github.github.com/gfm/) MAY be used for rich text representation. summary | `string` | Short description for the link. -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. +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. 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. server | [Server Object](#server-object) | A server object to be used by the target method.