Upsert A Guide Page
A 3-step recipe with ReadMe. We can help you get access.
Recipe · 3 steps
Upsert A Guide Page
with ReadMe · Developer Portal Management
Update a guide if its slug already exists on the branch, otherwise create it.
- List guides on the branch to detect whether the target slug exists.
- Update the existing guide identified by slug with the new content.
- Create a new guide when no guide with the target slug exists.
What you'll need to have ready
- branch: The branch (version) the guide lives on.
- slug: The slug of the guide to upsert.
- title: The guide title to write.
- body: The Markdown body content to write.
- apiKey: ReadMe API key used as a Bearer token.
For your developer
Arazzo workflow readme:upsert-guide, 3 operations: {$sourceDescriptions.guidesApi.url}#/paths/~1branches~1{branch}~1guides/get → {$sourceDescriptions.guidesApi.url}#/paths/~1branches~1{branch}~1guides~1{slug}/put → {$sourceDescriptions.guidesApi.url}#/paths/~1branches~1{branch}~1guides/post. Specs on APIs.io.