docs: Use Museum API instead of Petstore examples #1386
Merged
Conversation
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
|
|
Coverage report
Test suite run success699 tests passing in 100 suites. Report generated by 🧪jest coverage report action from 86eb996 |
lornajane
force-pushed
the
use-museum-example
branch
from
6f8826f
to
03e42c8
Compare
adamaltman
reviewed
Jan 25, 2024
lornajane
force-pushed
the
use-museum-example
branch
from
b082343
to
13fb555
Compare
Comment on lines
-93
to
-184
| ### Format | ||
|
|
||
| #### Codeframe (default) | ||
|
|
||
| ```bash | ||
| redocly bundle pet.yaml store.yaml -o ./bundled --format=codeframe | ||
| ## equivalent to: redocly bundle pet.yaml store.yaml -o ./bundled | ||
| ``` | ||
|
|
||
| Note: Errors display in the following format: `file:line:column`. For example, `petstore-with-errors.yaml:16:3`. | ||
|
|
||
| Depending on the terminal emulator you use, it may be possible to directly click this indicator to edit the file in place. | ||
|
|
||
| #### Stylish | ||
|
|
||
| ```bash | ||
| redocly bundle pet.yaml store.yaml -o ./bundled --format=stylish | ||
| ``` | ||
|
|
||
| In this format, `bundle` shows the filename, line number, and column where the problem occurred. | ||
|
|
||
| The compressed output omits other contexts and suggestions. | ||
|
|
||
| #### JSON | ||
|
|
||
| {% tabs %} | ||
| {% tab label="Command" %} | ||
|
|
||
| ```bash | ||
| redocly bundle pet.yaml store.yaml -o ./bundled --format=json | ||
| ``` | ||
|
|
||
| {% /tab %} | ||
| {% tab label="Output" %} | ||
|
|
||
| ```bash | ||
| bundling pet.yaml... | ||
| { | ||
| "totals": { | ||
| "errors": 0, | ||
| "warnings": 0, | ||
| "ignored": 0 | ||
| }, | ||
| "version": "1.0.0-beta.54", | ||
| "problems": [] | ||
| }📦 Created a bundle for pet.yaml at bundled/pet.yaml 28ms. | ||
| bundling store.yaml... | ||
| { | ||
| "totals": { | ||
| "errors": 0, | ||
| "warnings": 0, | ||
| "ignored": 0 | ||
| }, | ||
| "version": "1.0.0-beta.54", | ||
| "problems": [] | ||
| }📦 Created a bundle for store.yaml at bundled/store.yaml 15ms. | ||
| ``` | ||
|
|
||
| {% /tab %} | ||
| {% /tabs %} | ||
|
|
||
| In this format, `bundle` shows the result of bundling (including the number of errors and warnings and their descriptions) in JSON-like output. | ||
|
|
||
| #### Checkstyle | ||
|
|
||
| {% tabs %} | ||
| {% tab label="Command" %} | ||
|
|
||
| ```bash | ||
| redocly bundle pet.yaml -o ./bundled --lint --format=checkstyle | ||
| ``` | ||
|
|
||
| {% /tab %} | ||
| {% tab label="Output" %} | ||
|
|
||
| ```bash | ||
| bundling pet.yaml... | ||
| <?xml version="1.0" encoding="UTF-8"?> | ||
| <checkstyle version="4.3"> | ||
| <file name="pet.yaml"> | ||
| </file> | ||
| </checkstyle> | ||
| 📦 Created a bundle for pet.yaml at bundled/pet.yaml 35ms. | ||
| ``` | ||
|
|
||
| {% /tab %} | ||
| {% /tabs %} | ||
| In this format, `bundle` uses the [Checkstyle](https://checkstyle.org/) XML report format. | ||
| Due to the limitations of this format, the output _only_ includes the filename, line, column, severity, | ||
| and rule ID (in the `source` attribute). | ||
| All other information is omitted. | ||
|
|
There was a problem hiding this comment.
Just to confirm, did we remove these formats from the CLI?
There was a problem hiding this comment.
There's an open ticket to drop linting from the bundle command, which is what this is the output for. So I figured we'd be dropping this section soon.
TaylorKrusen
approved these changes
Feb 12, 2024
HCloward
reviewed
Feb 12, 2024
HCloward
reviewed
Feb 12, 2024
HCloward
reviewed
Feb 12, 2024
HCloward
approved these changes
Feb 12, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What/Why/How?
Fixes #1374
Reference
https://github.com/Redocly/museum-openapi-example/
Check yourself
Security