Readme

Connector for the readme API, generated deterministically from its OpenAPI spec (endpoints, auth, and methods match the spec exactly — nothing is invented).

• Base URL: https://dash.readme.io/api/v1
• Auth: basic (pass your key via the apiKey input)

Operations

• getproject — GET / — Get metadata about the current project
• getapispecification — GET /api-specification — Get API specification metadata
• getcategory — GET /categories/{slug} — Get category
• getcategorydocs — GET /categories/{slug}/docs — Get docs for category
• getchangelogs — GET /changelogs — Get changelogs
• getchangelog — GET /changelogs/{slug} — Get changelog

Inputs

• apiKey — your readme API key
• operation — one of the operations above
• path parameters when an operation's path contains {...}
• query — optional JSON object of query params
• body — JSON object for create/update ops

Example

operation: getproject
apiKey: <your key>