ReadMe Metrics Api Specification API
The Api Specification API from ReadMe Metrics — 1 operation(s) for api specification.
ReadMe Metrics Api Specification API is one of 5 APIs that ReadMe Metrics publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Api Specification. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a getting-started guide, and authentication docs.
This API exposes 2 operations across 1 path, and defines 2 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.
Requests are made against a single base URL, https://dash.readme.com/api/v1.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
ReadMe Metrics Api Specification API declares
1 security scheme
for authenticating requests.
It accepts HTTP basic authentication (basicAuth).
By default, every request must be authenticated.
basicAuth— ReadMe API key supplied as the HTTP Basic username (password empty).
Paths & Operations 2
Across 1 path, the API surfaces 2 operations — 1 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.
Schemas 2
The contract defines 2 schemas that model the data the API accepts and returns. The most detailed are APISpecification (7 properties), Error (6 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from ReadMe Metrics 4
Other APIs ReadMe Metrics publishes across the network.