mkdocs-ringcentral-api-index
A MkDocs plugin created by RingCentral to assist in the creation of an API Quick Reference based upon a swagger specification. The output of this plugin can be seen here:
https://developers.ringcentral.com/guide/basics/api-index
At RingCentral we had the desire to publish an API Quick Reference that would make it easier for developers to scan for the endpoint they are looking for and quickly access the documentation for that endpoint in our API Reference. To solve this problem, we created a plugin that will take as input an OAS 3.0 API specification, and output a markdown file that can rendered within mkdocs.
The output file can be modified by editing a template file.
This plugin may not work as expected out-of-the-box for any OAS specification, as it makes use of a number of proprietary OAS elements specific to RingCentral, including:
- x-availability
- x-user-permission
- x-app-permission
- x-throttling-group
Setup
Install the plugin using pip:
pip install mkdocs-ringcentral-api-index
Activate the plugin in mkdocs.yml:
plugins:
- search
- ringcentral-api-index:
spec_url: 'https://netstorage.ringcentral.com/dpw/api-reference/specs/rc-platform.yml'
outfile: 'docs/api-index.md'
Note: If you have no
pluginsentry in your config file yet, you'll likely also want to add thesearchplugin. MkDocs enables it by default if there is nopluginsentry set, but now you have to enable it explicitly.
Options
spec_url: Sets the URL to the Swagger specification for the RingCentral platform. This should default to the official URL. Override this for development purposes only.outfile: The file to output. This file is typically somewhere in your docs folder.
More information about plugins in the MkDocs documentation.
How the plugin works
This plugin works by generating a markdown file prior to the rest of a mkdocs project being built. In other words, as soon as mkdocs is started, this plugin downloads a spec file, parses it, generates a markdown file, and saves that file into the documentation tree. Then to make the generated page appear in your documentation, you add the file to your pages tree. For example:
plugins:
- ringcentral-api-index:
outfile: api/quick-reference.md
pages:
- 'Home': index.md
- 'Quick Reference': api/quick-reference.md
See Also
More information about templates here.
More information about blocks here.
Metadata
Release files for mkdocs-ringcentral-api-index 0.1.7
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| mkdocs-ringcentral-api-index-0.1.7.tar.gz | 5.6 kB | Without provenance | Details for mkdocs-ringcentral-api-index-0.1.7.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| mkdocs_ringcentral_api_index-0.1.7-py3-none-any.whl | Python 3 | none | any | Details for mkdocs_ringcentral_api_index-0.1.7-py3-none-any.whl |
Total release size: 11.9 kB
Release files / mkdocs-ringcentral-api-index-0.1.7.tar.gz
| Download URL | mkdocs-ringcentral-api-index-0.1.7.tar.gz |
|---|---|
| Size | 5.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
53402962f147dc379db40f240cabb757de9da28aef771aa2b30c3015c78f9cff
|
|
BLAKE2b-256 checksum How to use checksums |
5e35b1a4c01df39960bd87e9bbfe02ab8da404edaae970fd4e351707d58eaef2
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.0 CPython/3.9.12
|
Release files / mkdocs_ringcentral_api_index-0.1.7-py3-none-any.whl
| Download URL | mkdocs_ringcentral_api_index-0.1.7-py3-none-any.whl |
|---|---|
| Size | 6.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
766bf7609063f1ce5c670f8942797e94375838b89e3b07de238d450c07b48b6f
|
|
BLAKE2b-256 checksum How to use checksums |
48f166fff4a90c185a731c543a2dac350b921b7e5cbdf3bc253da60faa2f46e2
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.0 CPython/3.9.12
|
Security for mkdocs-ringcentral-api-index 0.1.7
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.