diff --git a/documentation/rdme.md b/documentation/rdme.md index 66994c762..7fb1d193f 100644 --- a/documentation/rdme.md +++ b/documentation/rdme.md @@ -103,10 +103,22 @@ To execute this command via GitHub Actions, the step would look like this: rdme: openapi [path-to-file.json] --key=<> --id=API_DEFINITION_ID ``` -We'll dive into several full GitHub Workflow file examples below! +We'll dive into several full GitHub Workflow file examples (including a video demo) below! ### Example: Syncing an OpenAPI Definition + + +[block:html] +{ +"html": "
" +} +[/block] + To sync an OpenAPI or Swagger definition, you'll first want to obtain a unique API definition ID from ReadMe so we know which definition you want to update on subsequent re-syncs. You can obtain this API definition ID in one of several ways, but we'll dive into two below: uploading a file directly into the ReadMe dashboard and using the `rdme` CLI locally.
@@ -224,8 +236,13 @@ To use a GitHub secret in your `rdme` GitHub Action, first [create a new reposit Since `rdme` is a command-line tool at its core, you can use `rdme` to sync your documentation from virtually any CI/CD environment that runs shell commands—[Bitbucket Pipelines](https://support.atlassian.com/bitbucket-cloud/docs/get-started-with-bitbucket-pipelines/), [GitLab CI/CD](https://docs.gitlab.com/ee/ci/), you name it! You can do this by invoking `rdme` with `npx -y rdme@RDME_VERSION` in a Node.js environment. See below for several examples. - + + ```yml Bitbucket Pipelines (bitbucket-pipelines.yml) # Official framework image. Look for the different tagged releases at: # https://hub.docker.com/r/library/node/tags/ @@ -245,6 +262,7 @@ sync-via-rdme: script: - npx -y rdme@RDME_VERSION openapi [path-to-file.json] --key=<> --id=API_DEFINITION_ID ``` + ## Troubleshooting