Commit Graph

1256 Commits

Author SHA1 Message Date
minaelee
23eeb3ce85 Update README.md (#1368)
* Update README.md

Multiple minor grammar/punctuation/coherence edits.

* Redocly -> Redocly CLI

Co-authored-by: Lorna Jane Mitchell <github@lornajane.net>

* Implement suggested changes

"Minimum" -> "The minimum"
Replace comma splice with semicolon

---------

Co-authored-by: Lorna Jane Mitchell <github@lornajane.net>
2023-12-29 11:02:14 +00:00
Sergey Shishkin
b4c1274b37 Fix schema type of AsyncAPI operation tags (#1339)
* fix: Schema type of AsyncAPI operation tags

* add tests

* test: Expand tags test for AsyncAPI

---------

Co-authored-by: Lorna Mitchell <lorna.mitchell@redocly.com>
2023-12-28 11:52:35 +00:00
Julien
918f570203 docs: fix typo in the migration guide (#1366) 2023-12-21 19:20:16 +02:00
Andrew Tatomyr
9930c3c339 docs: explain using refs in a config file (#1364)
Co-authored-by: Heather Cloward <heathercloward@gmail.com>
2023-12-21 18:41:54 +02:00
github-actions[bot]
122ce07670 chore: 🔖 release new versions (#1361) 2023-12-21 16:09:59 +02:00
Andrew Tatomyr
d44ad9ee53 feat: resolve refs in config (#1345)
Co-authored-by: IhorKarpiuk <ihor.karpiuk@redocly.com>
2023-12-21 15:32:09 +02:00
Lorna Jane Mitchell
cddec3327f Docs: Add examples for the filter decorators (#1360)
* docs: Add an example for filter out decorator

* docs: Add a filter-in example

* Chore: run prettier
2023-12-15 10:59:34 +00:00
Ihor Karpiuk
588b956d85 chore: deprecate lint option in the join command (#1349) 2023-12-14 18:09:40 +02:00
Lorna Jane Mitchell
513a6a1b8d docs: Minor fix to code sample from website feedback (#1359) 2023-12-14 13:22:21 +00:00
Ihor Karpiuk
d5e2e289b8 chore: update link to async api specification (#1350) 2023-12-07 18:35:28 +02:00
Lorna Jane Mitchell
88cd624d7a Docs updates spotted when crafting Advent content (#1346)
* docs: Fix typo and remove reference to feature we're planning to drop

* docs: re-word the rule explanation, add link to operationId blog post

* docs: simplify rule description, pick more relevant related rules to link to

* docs: simplify kebab-case explanation
2023-12-04 12:02:01 +00:00
github-actions[bot]
70e5133708 chore: 🔖 release new versions (#1337) 2023-11-29 12:54:55 +02: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
Andrew Tatomyr
744fab0032 chore: update Redoc to v2.1.3 (#1344) 2023-11-28 16:20:59 +02:00
Andrew Tatomyr
4497e75ef6 chore: adjust the clean command and remove redundant changeset (#1343) 2023-11-28 14:42:20 +02:00
Lorna Jane Mitchell
c6831826d4 docs: Add a cookbook mention to the configurable rules page (#1341)
* docs: Add a cookbook mention to the configurable rules page

* chore: Run prettier.
2023-11-28 10:12:25 +00:00
Ihor Karpiuk
efb6a453f5 feat: create new rule to enforce array parameters format (#1338) 2023-11-24 16:18:58 +02:00
uxmatthew
cf35f76121 Update README.md (#1340)
remove slash from link
2023-11-24 11:24:54 +00:00
Lorna Jane Mitchell
afb5d9425f docs: Update docs tooling and checks (#1330)
* fix: Remove github token with incorrect access

* docs: Improve uninstall CTA in migration guide

* fix: Update checkout action version for vale

* docs: Vale reports errors in any edited file

* docs: Update to make Vale happy

* docs: Markdownlint fixes

* fix: Remove sync actions as this integration is no longer used

* core: Add markdownlint config and github action

Uses rules from https://github.com/Redocly/marketing-site-portal/pull/1142

* chore: Move contributing file to top level

* chore: Add markdown to the file types that we want prettier to operate on

* fix: Make files fit prettier rules, ignore LICENSE since we can't change that

* chore: Combine docs-related workflows into one for simplicity

* docs: Add instructions for running the CLI docs standalone from this repo

* chore: Add changeset, this docs change is quite large

* Update .changeset/bright-steaks-walk.md

Co-authored-by: Ihor Karpiuk <106662428+IgorKarpiuk@users.noreply.github.com>

---------

Co-authored-by: Ihor Karpiuk <106662428+IgorKarpiuk@users.noreply.github.com>
2023-11-20 16:00:32 +00:00
Lorna Jane Mitchell
de80612b55 chore: Run prettier on all docs files (#1334) 2023-11-17 09:45:03 +00:00
github-actions[bot]
166e16d6ca chore: 🔖 release new versions (#1315) 2023-11-15 15:14:37 +01:00
Ciprian Caba
6097ff769f fix: improve browser detection when running with Bun (#1319) 2023-11-15 12:06:23 +01:00
billytrend-cohere
bf4b8f2fa2 fix: add explicit node-fetch dependency (#1327) 2023-11-15 11:50:48 +01:00
Lorna Jane Mitchell
2ad0ffb0c2 docs: decorators in main sidebar (#1324) 2023-11-10 16:02:28 +00:00
redocly-bot
d008291a32 sync: Synced local 'docs/' with remote 'docs/cli/' 2023-11-09 15:56:27 +00:00
Andrew Tatomyr
3f13cb9ada chore: move remove-unused-components decorator to decorators folder (#1316) 2023-11-09 09:36:13 +01:00
redocly-bot
828290ea23 sync: Synced local 'docs/' with remote 'docs/cli/' 2023-11-08 11:55:24 +00:00
Phil Sturgeon
8af478b038 Lets talk about API Style Guides (#1261)
* Lets talk about API Style Guides

* docs: tweaking API guidelines language and light editing

---------

Co-authored-by: Lorna Mitchell <lorna.mitchell@redocly.com>
2023-11-08 11:25:50 +00:00
redocly-bot
eadf29f6a8 sync: Synced local 'docs/' with remote 'docs/cli/' 2023-11-03 15:28:27 +00:00
Jeremy Fiel
f83fc54d35 OAS3_1 types SchemaProperties updated per JSON Schema draft 2020-12 (#1310) 2023-10-27 15:17:58 +02:00
github-actions[bot]
b50ae469c4 chore: 🔖 release new versions (#1313) 2023-10-26 16:31:02 +03:00
Andrew Tatomyr
4620f79f29 feat: add built-in recommeded-strict ruleset (#1311) 2023-10-26 15:07:19 +03:00
Frederik Fenger
73d96a2d0f fix: use same host for websocket server as for http server when previewing locally (#1309) 2023-10-26 13:55:45 +02:00
Ihor Karpiuk
1510e471b7 feat: extend split and join commands to produce JSON output (#1305) 2023-10-26 14:42:06 +03:00
Andrew Tatomyr
72b225a698 chore: update typescript to v5 and synchronise predefined rulesets through strict typing (#1308) 2023-10-24 14:52:12 +02:00
github-actions[bot]
4e712a8c70 chore: 🔖 release new versions (#1306) 2023-10-19 17:02:17 +03:00
Ihor Karpiuk
0c52110c80 chore: set default severity for lint config (#1292) 2023-10-19 16:23:18 +03:00
Jeremy Fiel
fcae48e9f4 fix(docs): update example (#1281) 2023-10-19 10:54:11 +02:00
redocly-bot
1280b08336 sync: Synced local 'docs/' with remote 'docs/cli/' 2023-10-18 14:49:40 +00:00
dependabot[bot]
e8aedd7f28 chore(deps): bump @babel/traverse from 7.22.10 to 7.23.2 (#1302) 2023-10-18 13:19:46 +02:00
github-actions[bot]
45b31e6640 chore: 🔖 release new versions (#1272) 2023-10-18 08:48:35 +02:00
Andrew Tatomyr
73c1999297 chore: update changeset description (#1300) 2023-10-17 17:29:13 +02:00
Andrew Tatomyr
d703d22bbf fix: report on child keys when using pattern or notPattern assertions (#1299) 2023-10-17 16:36:07 +02:00
dependabot[bot]
2b2429b90d chore(deps): bump postcss from 8.4.28 to 8.4.31 (#1289) 2023-10-16 14:17:16 +02:00
Roman Hotsiy
4d66ace6b8 fix: document openapi-core package usage + slightly improve the API (#1284)
* fix: document openapi-core package usage + slightly improve the API

* chore: fix tests

* Apply suggestions from code review

* docs: test code and add some explanations for each section

* fix: make the bundle output variables match in both examples

* chore: add tests for lint and bundle

* chore: add tests for bundleFromString and createConfig with a plugin

* chore: apply prettier

* Update packages/core/src/__tests__/bundle.test.ts

---------

Co-authored-by: Lorna Mitchell <lorna.mitchell@redocly.com>
Co-authored-by: Andrew Tatomyr <andrew.tatomyr@redocly.com>
2023-10-15 23:38:40 +00:00
Jeremy Fiel
be16c5898a fix(types): update unevaluatedItems type defintion (#1295) 2023-10-13 18:18:25 +02:00
Ihor Karpiuk
4769ca5579 fix: use separate resolvers for each file in join (#1291) 2023-10-13 11:45:44 +03:00
redocly-bot
c4ae8fac66 sync: Synced local 'docs/' with remote 'docs/cli/' 2023-10-10 13:31:02 +00:00
redocly-bot
85a5c6b281 sync: Synced local 'docs/' with remote 'docs/cli/' 2023-10-09 19:12:22 +00:00
redocly-bot
9199b2bab7 sync: Synced local 'docs/' with remote 'docs/cli/' 2023-10-09 16:35:49 +00:00