Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add docs on validation, fix TOC #405

Merged
merged 3 commits into from
Dec 13, 2021
Merged

docs: add docs on validation, fix TOC #405

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
bbd3a61
docs: add docs on validation, fix TOC
kanadgupta Dec 13, 2021
1d987f0
chore: move validation subsection to bottom of openapi section
kanadgupta Dec 13, 2021
d3ba0e6
docs: add YAML callout
kanadgupta Dec 13, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 10 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
* [Authentication](#authentication)
* [Usage](#usage)
* [Common options](#common-rdme-options)
* [Swagger / OpenAPI](#swagger-/-openapi)
* [OpenAPI / Swagger](#openapi--swagger)
* [Docs](#docs)
* [Versions](#versions)
* [Opening a Project](#open)
Expand Down Expand Up @@ -42,6 +42,8 @@ If you wish to get more information about any command within `rdme`, you can exe
### OpenAPI / Swagger
ReadMe supports [OpenAPI 3.0](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md), [OpenAPI 3.1](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md), and [Swagger 2.x](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/2.0.md).

The following examples use JSON files, but we support API Definitions that are written in either JSON or YAML.

> ℹ️ Note that the `rdme openapi` command supports both OpenAPI and Swagger API definitions. The `rdme swagger` command is an alias for `rdme openapi` and is deprecated.

#### Uploading a New API Definition to ReadMe
Expand Down Expand Up @@ -76,6 +78,13 @@ If you run `rdme` within a directory that contains your OpenAPI or Swagger defin
rdme openapi
```

#### Validating an API Definition
You can also perform a local validation of your API definition without uploading it to ReadMe, which can be useful when constructing or editing your API definition.

```sh
rdme validate [path-to-file.json]
```

### Docs
#### Syncing a Folder of Markdown Docs to ReadMe
```sh
Expand Down