ReadMe is a platform for creating and managing API documentation and developer portals.

Provided free and as is, without warranty of any kind — including merchantability, fitness for a particular purpose, and the accuracy or completeness of any result. See the licence. You are responsible for checking what this produces before relying on it.

Readme

ReadMe is a platform for creating and managing API documentation and developer portals.

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>

Publishes

The keys a later task may reference as {{taskName.key}}. Referencing anything not listed here resolves to nothing at run time.

error
operation
result
status

Input Properties

Every property this tool accepts, from its own tool.iml.

Property	Type	Required	Default	Description
`apiKey`	string	yes	—	DEPRECATED — bind an API Key credential to the task with `credentialName` instead. A key pasted here is stored in the workflow definition in clear and appears in every export of it. Still honoured for workflows built before the change.
`operation`	string	yes	—	One of: getproject, getapispecification, getcategory, getcategorydocs, getchangelogs, getchangelog
`slug`	string	no	—	Path parameter slug (required by some operations).
`query`	string	no	—	Query-string parameters as a JSON object string, e.g. {"limit": 50}. Parsed and url-encoded onto the request.