Create beautiful product and API documentation with our developer friendly platform.
Every row below was read from the vendor's own OpenAPI document. The summary text is theirs. What this registry adds is that each operation is indexed with its method, path, base URL and auth scheme, so a search for a capability can answer with a call rather than a name, and that the endpoint is probed on a schedule.
Specifications as held by the APIs.guru corpus, whose newest record is 2023-04-21. Operations the vendor has added since are not listed here; the origin links above are the vendor's own current documents.
base URLs: https://dash.readme.io/api/v1
auth: b a s i c
find it by capability: POST /search {"query":{"text":"..."}} returns these
operations with their invocation detail. Connect any agent client.
Create beautiful product and API documentation with our developer friendly platform.
| method | path | what the vendor says it does |
|---|---|---|
GET | / | Get metadata about the current project Returns project data for API key Projects |
GET | /api-specification | Get API specification metadata API Specification |
POST | /api-specification | Upload an API specification to ReadMe. Or, to use a newer solution see https://docs.readme.com/guides/docs/aut |
PUT | /api-specification/{id} | Update an API specification in ReadMe API Specification |
DELETE | /api-specification/{id} | Delete an API specification in ReadMe API Specification |
GET | /categories/{slug} | Get category Returns the category with this slug Categories |
GET | /categories/{slug}/docs | Get docs for category Returns the docs and children docs within this category Categories |
GET | /changelogs | Get changelogs Returns a list of changelogs associated with the project API key Changelog |
POST | /changelogs | Create changelog Create a new changelog inside of this project Changelog |
GET | /changelogs/{slug} | Get changelog Returns the changelog with this slug Changelog |
PUT | /changelogs/{slug} | Update changelog Update a changelog with this slug Changelog |
DELETE | /changelogs/{slug} | Delete changelog Delete the changelog with this slug Changelog |
GET | /custompages | Get custom pages Returns a list of custom pages associated with the project API key Custom Pages |
POST | /custompages | Create custom page Create a new custom page inside of this project Custom Pages |
GET | /custompages/{slug} | Get custom page Returns the custom page with this slug Custom Pages |
PUT | /custompages/{slug} | Update custom page Update a custom page with this slug Custom Pages |
DELETE | /custompages/{slug} | Delete custom page Delete the custom page with this slug Custom Pages |
POST | /docs | Create doc Create a new doc inside of this project Docs |
POST | /docs/search | Search docs Returns all docs that match the search Docs |
GET | /docs/{slug} | Get doc Returns the doc with this slug Docs |
PUT | /docs/{slug} | Update doc Update a doc with this slug Docs |
DELETE | /docs/{slug} | Delete doc Delete the doc with this slug Docs |
GET | /errors | Get errors Returns with all of the error page types for this project Errors |
POST | /swagger | DEPRECATED. Instead use https://docs.readme.com/developers/reference/api-specification#uploadapispecification |
PUT | /swagger/{id} | DEPRECATED. Instead, use https://docs.readme.com/developers/reference/api-specification#updateapispecification |
DELETE | /swagger/{id} | DEPRECATED. Instead, use https://docs.readme.com/developers/reference/api-specification#deleteapispecification |
GET | /version | Get versions Retrieve a list of versions associated with a project API key Version |
POST | /version | Create version Create a new version Version |
GET | /version/{versionId} | Get version Returns the version with this version ID Version |
PUT | /version/{versionId} | Update version Update an existing version Version |
DELETE | /version/{versionId} | Delete version Delete a version Version |
specification origin: https://raw.githubusercontent.com/readmeio/oas/master/packages/examples/3.0/json/readme.js
nothing on this page is a rating, an endorsement or a claim about quality. Reachability is what our probes observed from one network; answering is a floor under usefulness, not a measure of it.