Skip to content

Add OpenRPC example demonstrating x-* specification extensions#9

Open
BelfordZ wants to merge 1 commit intomasterfrom
fix/add-example-openrpc-documents-with-extensions
Open

Add OpenRPC example demonstrating x-* specification extensions#9
BelfordZ wants to merge 1 commit intomasterfrom
fix/add-example-openrpc-documents-with-extensions

Conversation

@BelfordZ
Copy link
Copy Markdown
Member

Motivation

  • Provide a concrete OpenRPC document that demonstrates usage of the bundled specification extensions so consumers can see how to apply x-transport, x-notification, and x-error-group in a real document.

Description

  • Add a new example OpenRPC document at src/examples/example-openrpc-with-spec-extensions.json that uses x-transport on servers and x-notification / x-error-group on methods in a Wallet Service example.
  • Export the new example through both ESM and CJS entrypoints by adding openrpcUsingExtensions to the examples object in src/index.mts and src/index.cts.
  • Document the example location by adding an ### Example OpenRPC document reference to README.md that links to the new example file.

Testing

  • Ran npm run build which completed successfully.

Codex Task

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant