Add rpc.describe RPC method: JSON Schema Service Descriptor #412
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
It is the first change related to JSON-RPC Service Descriptor and
enhancement of Web Browsable API. The aim of these changes is to
create Metadata of the RPC method to be used by Web Browsable API.
The idea here is open the space to use `typing.Annotated`[1] in
parameters (and returns) and reflecting that in Web Browsable API,
such as:
```
def fn(
name: typing.Annotated[str, MaxLenght(60), "First and last name of person"],
age: typing.Annotated[int, ValueRange(1, 110), "Age of person"],
...
) -> typing.Annotated[str, "The data information of person"]:
```
The service descriptor was based on JSON Schema Service Descriptor
from JSON-RPC Spec[2], some changes were made to be more seems like
OpenRPC Spec[3], and others will do to adapt to the use case of Web
Browsable API.
**Note:** The RPC method `system.describe` was removed (replaced
by `rcp.describe`).
Resolves: #409
See also: #376
[1] - https://docs.python.org/3/library/typing.html#typing.Annotated
[2] - https://www.jsonrpc.org/historical/json-schema-service-descriptor.html
[3] - https://spec.open-rpc.org/
nycholas
added a commit
that referenced
this pull request
Jan 19, 2024
* Add support to Python 3.12 (#431) * Drop support to Python 3.7 * Bump Flask version to >=3.0.0 * Bump JQuery version from 1.8.1 to 3.7.1 (fix security issue) * Bump several dependencies versions * Migrate configuration to pyproject.toml * Reorganizze requirements files * Remove flask_jsonrpc.__version__ attribute in favor to pyproject.toml version attribute * Add multi Python version on update workflow (#332) * Add new param to allow/disallow JSON-RPC Notification (#385) * Unified API Browser when using modular server (#391) * Add tests to all Python versions supported by the project (#395) * Add e2e tests to Web Browsable API (#401) * Goodbye Python 3.6 (#404) * Add support to Python 3.11 (#408) * Add rpc.describe RPC method: JSON Schema Service Descriptor (#412) * Project links fixed (#429)
Merged
nycholas
added a commit
that referenced
this pull request
Jan 19, 2024
* Add GitHub Action for coveralls * Version 3.0.0 * Add support to Python 3.12 (#431) * Drop support to Python 3.7 * Bump Flask version to >=3.0.0 * Bump JQuery version from 1.8.1 to 3.7.1 (fix security issue) * Bump several dependencies versions * Migrate configuration to pyproject.toml * Reorganizze requirements files * Remove flask_jsonrpc.__version__ attribute in favor to pyproject.toml version attribute * Add multi Python version on update workflow (#332) * Add new param to allow/disallow JSON-RPC Notification (#385) * Unified API Browser when using modular server (#391) * Add tests to all Python versions supported by the project (#395) * Add e2e tests to Web Browsable API (#401) * Goodbye Python 3.6 (#404) * Add support to Python 3.11 (#408) * Add rpc.describe RPC method: JSON Schema Service Descriptor (#412) * Project links fixed (#429)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
It is the first change related to JSON-RPC Service Descriptor and enhancement of Web Browsable API. The aim of these changes is to create Metadata of the RPC method to be used by Web Browsable API. The idea here is open the space to use
typing.Annotated[1] in parameters (and returns) and reflecting that in Web Browsable API, such as:The service descriptor was based on JSON Schema Service Descriptor from JSON-RPC Spec[2], some changes were made to be more seems like OpenRPC Spec[3], and others will do to adapt to the use case of Web Browsable API.
Note: The RPC method
system.describewas removed (replaced byrcp.describe).Resolves: #409
See also: #376
[1] - https://docs.python.org/3/library/typing.html#typing.Annotated
[2] - https://www.jsonrpc.org/historical/json-schema-service-descriptor.html
[3] - https://spec.open-rpc.org/