Unified API Browser when using modular server #391
Merged
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
nycholas
force-pushed
the
feature/388-unified-api-browser
branch
7 times, most recently
from
7c31635
to
bebd812
Compare
The expected behavior is that when using the modular way, the API Browser merges in one, instead of having one API Browser for each. Now, the server is aware of the `SERVER_NAME` Flask configuration, it is being used by API Browser to request the correct server, besides that, the API Browser is able to call servers in different domains. For that configuration, the `JSONRPCSite` generates the `path` and `base_url` variables from `SERVER_NAME`, `APPLICATION_ROOT`, and `PREFERRED_URL_SCHEME`. It is the first step to providing a Browse Schema to improve documentation and examples from API (JSON-RPC methods). Resolves: #388 See: #378, #377, #376, #374, #373, and #370
nycholas
force-pushed
the
feature/388-unified-api-browser
branch
from
bebd812
to
07691c0
Compare
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.
The expected behavior is that when using the modular way, the API Browser merges in one, instead of having one API Browser for each.
Now, the server is aware of the
SERVER_NAMEFlask configuration, it is being used by API Browser to request the correct server, besides that, the API Browser is able to call servers in different domains. For that configuration, theJSONRPCSitegenerates thepathandbase_urlvariables fromSERVER_NAME,APPLICATION_ROOT, andPREFERRED_URL_SCHEME.It is the first step to providing a Browse Schema to improve documentation and examples from API (JSON-RPC methods).
Resolves: #388
See also: #378, #377, #376, #374, #373, and #370