Roadie TechDocs API
Technical documentation (docs-like-code) metadata and static content. Modeled from Backstage.
Roadie TechDocs API is one of 6 APIs that Roadie publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include TechDocs. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes 2 operations across 2 paths, and defines 1 schema. It is described by OpenAPI 3.0.3, at version 1.0.
Requests are made against a single base URL, https://api.roadie.so/api.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Roadie TechDocs API declares
1 security scheme
for authenticating requests.
It accepts HTTP bearer tokens (bearerAuth).
By default, every request must be authenticated.
bearerAuth— Roadie API token (User Token or Service Token) created under Administration in the Roadie app. Passed as Authorization: Bearer YOURROADIEAPITOKEN.
Paths & Operations 2
Across 2 paths, the API surfaces 2 operations — 2 GET. Each is listed below with its method, path, parameters, and response codes.
Technical documentation (docs-like-code) metadata and static content. Modeled from Backstage.
Schemas 1
The contract defines 1 schema that model the data the API accepts and returns. The most detailed is Error (1 property). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Roadie 5
Other APIs Roadie publishes across the network.