Automate Readme Endpoints
HumDay reads Readme Endpoints’s own published API description and derives 28 operations from it. Describe the outcome you want in plain words — you get a program that is written, proven on real data, and run for you.
What Readme Endpoints is
Create beautiful product and API documentation with our developer friendly platform.
API host: dash.readme.io
What HumDay can do in Readme Endpoints
16 documented operations change something in Readme Endpoints.
- POSTCreate custom page
/custompages - POSTCreate doc
/docs - POSTCreate version
/version - POSTCreate changelog
/changelogs - POSTUpload an API specification to ReadMe.
/api-specification - POSTSearch docs
/docs/search - DELETEDelete custom page
/custompages/{slug} - PUTUpdate custom page
/custompages/{slug} - DELETEDelete doc
/docs/{slug} - PUTUpdate doc
/docs/{slug} - DELETEDelete changelog
/changelogs/{slug} - PUTUpdate changelog
/changelogs/{slug} - DELETEDelete version
/version/{versionId} - PUTUpdate version
/version/{versionId} - DELETEDelete an API specification in ReadMe
/api-specification/{id} - PUTUpdate an API specification in ReadMe
/api-specification/{id}
What HumDay can read from Readme Endpoints
These are the operations a schedule or a trigger can watch.
- GETGet custom page
/custompages/{slug} - GETGet metadata about the current project
/ - GETGet errors
/errors - GETGet versions
/version - GETGet changelogs
/changelogs - GETGet custom pages
/custompages - GETGet API specification metadata
/api-specification - GETGet doc
/docs/{slug} - GETGet category
/categories/{slug} - GETGet changelog
/changelogs/{slug} - GETGet version
/version/{versionId} - GETGet docs for category
/categories/{slug}/docs
How automating Readme Endpoints works
- Describe the outcome. Say what you want to happen, in your own words. No node graphs, no field mapping.
- Approve the contract. HumDay writes down exactly what it will do, what it will touch, and what it will never do. You approve it before anything is built.
- See it proven. The program runs and shows you the result before it is allowed near your live Readme Endpoints account.
- Grant access, then go live. You approve the specific Readme Endpoints operations it may use — and only those.
Popular Readme Endpoints integrations
Connect Readme Endpoints to the tools people pair it with most.
- Readme Endpoints and OData for namespace microsoft.graphintegration
- Readme Endpoints and Cloudflareintegration
- Readme Endpoints and NetBoxintegration
- Readme Endpoints and GitHubintegration
- Readme Endpoints and Mistintegration
- Readme Endpoints and Loket.nlintegration
- Readme Endpoints and Atlassian The Jira Cloud platformintegration
- Readme Endpoints and Magento B2Bintegration
- Readme Endpoints and Stripeintegration
- Readme Endpoints and Zuora Reference Billingintegration
- Readme Endpoints and bunqintegration
- Readme Endpoints and DocuSignintegration
Automate Readme Endpoints with these
- OData for namespace microsoft.graph11412 operations
- GitHub811 operations
- Atlassian The Jira Cloud platform474 operations
- Gitlab358 operations
- JIRA 7.6.1324 operations
- Appcenter App Center Client323 operations
- Gitea .321 operations
- Bitbucket292 operations
- Keycloak Admin281 operations
- Apple App Store Connect251 operations
- Files.com222 operations
- Vmware vRealize Network Insight Reference161 operations
Categories
Questions about Readme Endpoints automation
- Can HumDay connect to Readme Endpoints?
- Yes. HumDay reads Readme Endpoints's own published API description and derives the operations from it, so there is no hand-built connector to wait for. 28 operations are documented.
- Do I need to write code to automate Readme Endpoints?
- No. You describe the outcome you want in plain words. HumDay agrees a contract with you, writes the program, and shows you a test run before anything touches your Readme Endpoints account.
- What can HumDay do in Readme Endpoints?
- 16 of the 28 documented operations change something in Readme Endpoints, and 12 read from it. HumDay only ever uses the specific operations your approved contract needs.
- Is my Readme Endpoints account safe?
- Your credentials are stored encrypted and are never shown in chat, code, or logs. Every run is limited to the operations you explicitly approved, and anything that writes to Readme Endpoints is held behind that approval.
Where this came from
The operations above are read from a published API description for Readme Endpoints at raw.githubusercontent.com/readmeio/oas/master/packages/examples/3.0/json/readme.json. Descriptions are the provider’s own words, not ours. Last published 2020-07-22.