Commit Graph

29 Commits

Author SHA1 Message Date
Andrew Tatomyr
0eee406b98 fix: bundling multiple files specified as CLI arguments (#1717) 2024-09-06 18:52:09 +03:00
Andrew Tatomyr
e1ddf8e12e feat: add output as a per-API configuration option (#1708) 2024-09-06 13:56:02 +03:00
dianacheung
4c3d8cf84f docs: update commands documentation (issue 1429) and minor corrections (#1560)
* docs: updated commands documentation per issue 1429 and minor corrections, ran prettier

* docs: updated commands documentation per issue 1429 and included pr 1560 feedback

* docs: minor formatting and copyedits

---------

Co-authored-by: Diana Cheung <18452752+dianacheung@users.noreply.github.com>
Co-authored-by: Lorna Mitchell <lorna.mitchell@redocly.com>
2024-07-05 20:59:59 +01:00
Dmytro Anansky
9343b35cdd feat: drop linting option from bundle command (#1503) 2024-04-02 12:12:16 +03:00
Lorna Jane Mitchell
fd79f7d4c5 docs: Use Museum API instead of Petstore examples (#1386)
* docs: add museum examples to installation and bundle/join commands

* docs: removed petstore examples and updated formatting for readability

* docs: Update petstore to museum examples in decorators section

* chore: Prettier wants to fix a file

* chore: Fix Vale-detected future tense mistakes

* Update docs/decorators/media-type-examples-override.md

* Update docs/commands/lint.md

* Update docs/commands/lint.md

---------

Co-authored-by: Heather Cloward <heathercloward@gmail.com>
2024-02-12 18:06:11 +00:00
Ihor Karpiuk
79936f2bb3 chore: add deprecate warning for the lint-related options (#1342)
Co-authored-by: Lorna Jane Mitchell <github@lornajane.net>
2023-11-29 11:06:10 +02:00
Ihor Karpiuk
0c52110c80 chore: set default severity for lint config (#1292) 2023-10-19 16:23:18 +03:00
redocly-bot
9199b2bab7 sync: Synced local 'docs/' with remote 'docs/cli/' 2023-10-09 16:35:49 +00:00
Adam Altman
0a73f1f557 refactor: rename to API description for consistency (#1239) 2023-09-18 15:22:26 +02:00
Lorna Jane Mitchell
daf030b7a8 Custom plugin documentation (#1222)
* Remove extra 'resources' landing page, redirect from main one

* Move custom plugins file to its own directory, add redirect to handle

* docs: split the custom plugins page into one page per feature

* docs: extend decorators explanation and link to it from the custom plugins section

* docs: Fix all the links that were broken when I moved things

* Apply excellent suggestions from code review

Co-authored-by: Heather Cloward <heathercloward@gmail.com>

* docs: Add examples of how to use the custom rule

* docs: Replace the nested visitor example with an object rather than a function

* Update custom-rules.md

minor consistency edits

* Apply suggestions from code review

Co-authored-by: Heather Cloward <heathercloward@gmail.com>

* docs: clearer explanation of skip, and finish a broken sentence

* Update docs/custom-plugins/index.md

Co-authored-by: Heather Cloward <heathercloward@gmail.com>

* Apply suggestions from code review

Co-authored-by: Adam Altman <adam@redoc.ly>

* docs: use object rather than function for visitor

---------

Co-authored-by: Heather Cloward <heathercloward@gmail.com>
Co-authored-by: Adam Altman <adam@redoc.ly>
2023-08-16 14:26:56 +01:00
Lorna Jane Mitchell
9dc78a6d3f docs: Improve CLI usage wording (#1162)
* chore: Tidy up usage options and wording

* docs: Update/refresh command docs pages, add completion page

* chore: run prettier

* fix: keep the previous push command format for backward compatibility

* fix: update test snapshots to match new usage output

* chore: run prettier

* Apply suggestions from code review

Co-authored-by: Heather Cloward <heathercloward@gmail.com>

---------

Co-authored-by: Heather Cloward <heathercloward@gmail.com>
2023-07-12 10:30:05 +01:00
Andrew Tatomyr
6729869869 docs: make greedy arrays false in yargs (#1084) 2023-05-25 16:28:29 +02:00
Adam Altman
9cad7e2e8d docs: rework assertions into custom rules (#917) 2022-11-02 06:58:54 -05:00
Andrew Tatomyr
b325e6f503 chore: rename 'entrypoints' into 'apis' (#802) 2022-08-09 18:07:23 +02:00
Roman Hotsiy
c3ce34af84 docs: add missing --remove-unused-components (#774) 2022-07-26 06:48:24 -05:00
redocly-bot
417c28b6a8 sync: Synced local 'docs/' with remote 'docs/cli/' 2022-07-18 22:16:28 +00:00
Pascal von Rickenbach
d1960063db add bundle option to keep url references (#688) 2022-05-19 14:06:21 +02:00
redocly-bot
4d8cf1f186 sync: Synced local 'docs/' with remote 'docs/cli/' 2022-05-14 18:42:52 +00:00
Roman Hotsiy
1cacff2044 chore: rename package to @redocly/cli (#672)
Co-authored-by: Andrew Tatomyr <andrew.tatomyr@gmail.com>
Co-authored-by: Ivana Isadora Devcic <skadinna@gmail.com>
2022-05-06 16:12:56 +02:00
redocly-bot
297082a16b sync: Synced local 'docs/' with remote 'docs/cli/' 2022-03-23 22:07:26 +00:00
redocly-bot
5b9cc9d714 sync: Synced local 'docs/' with remote 'docs/cli/' 2022-02-10 17:33:10 +00:00
redocly-bot
2dc8bcd13b sync: Synced local 'docs/' with remote 'docs/cli/' 2022-01-13 02:47:11 +00:00
Slavik Bezkorovainyi
145a364fef feat: remove-x-internal decorator (#443)
Co-authored-by: Andriy Leliv <andrii.leliv@gmail.com>
Co-authored-by: romanhotsiy <gotsijroman@gmail.com>
2022-01-06 19:56:53 +02:00
Tom Wieczorek
9981ddafb9 feat: add checkstyle as a new lint format (#496) 2022-01-04 17:30:18 +02:00
Anatolii Sieryi
aa3a24cd33 chore: add docs for 1.0.0-beta.69 (#458) 2021-11-24 21:57:27 +02:00
Antonio
03ce0afc98 docs: revised openapi-cli bundle command (#350)
* docs: revised openapi-cli bundle command

* docs: fixed mentions, added missing examples for options

* docs: fixed missing --format=json option for bundle command

* docs: added links to the skip preprocessor, rule, decorator section from the options table

* fix: links to custom rules page

* fix: Json to JSON

* Minor style fixes

Co-authored-by: Ivana Isadora Devcic <33730345+skadinna@users.noreply.github.com>
Co-authored-by: Swapnil Ogale <swapnilogale@gmail.com>
2021-09-23 17:35:14 -05:00
redocly-bot
4ff120daba sync: Synced local 'docs/' with remote 'docs/cli/' 2021-08-30 21:24:14 +00:00
redocly-bot
2143028637 sync: Synced local 'docs/' with remote 'docs/cli/' 2021-08-05 01:36:10 +00:00
redocly-bot
acc0e31e22 sync: Synced local 'docs/' with remote 'docs/cli/' 2021-07-06 12:49:53 +00:00