Skip to content

Commit

Permalink
docs: remove references from our docs
Browse files Browse the repository at this point in the history
  • Loading branch information
kanadgupta committed Sep 15, 2023
1 parent 147632a commit ff94560
Showing 1 changed file with 0 additions and 8 deletions.
8 changes: 0 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -241,14 +241,6 @@ You can add `--update` to the command so if there's only one API definition for
rdme openapi [url-or-local-path-to-file] --version={project-version} --update
```

##### Override the Working Directory

By default, `rdme` bundles all [references](https://swagger.io/docs/specification/using-ref/) with paths based on the directory that `rdme` is being run in. You can override the working directory using the `--workingDirectory` option, which can be helpful for bundling certain external references (see [here](__tests__/__fixtures__/relative-ref-oas/petstore.json) for an example file).

```sh
rdme openapi petstore.json --workingDirectory=[path to directory]
```

#### Validating an API Definition

You can also perform a local validation of your API definition (no ReadMe account required!), which can be useful when constructing or editing your API definition.
Expand Down

0 comments on commit ff94560

Please sign in to comment.