-
Notifications
You must be signed in to change notification settings - Fork 8.3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
John Schulz
committed
Sep 14, 2020
1 parent
a6da8cd
commit 63f9354
Showing
2 changed files
with
9 additions
and
6 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,10 @@ | ||
## The `openapi` folder | ||
|
||
This folder contains your entrypoint `openapi.yaml`. | ||
* `spec_entry.json` is the version which links to the various files on disk. | ||
* `spec_bundled.json` is the resolved output of that entry & other files in one file. It's currently generated with | ||
|
||
That file contains references to the entire API definition. | ||
|
||
* [Paths](paths/README.md): this defines each endpoint. A path can have one operation per http method. | ||
`npx swagger-cli bundle spec_entry.json -o spec_bundled.json` | ||
* [Paths](paths/README.md): this defines each endpoint. A path can have one operation per http method. | ||
* [Components](components/README.md): Reusable components like [`schemas`](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#schemaObject), | ||
[`responses`](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#responseObject) | ||
[`parameters`](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#parameterObject), etc |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters