Commit Graph

1238 Commits

Author SHA1 Message Date
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
Adam Altman
eb82725463 fix: improve detection accuracy on no-server-example.com rule (#1270) 2023-09-22 08:05:03 -05:00
Andrew Tatomyr
cfe66a79a9 chore: set minimal required NPM version to 7 (#1267) 2023-09-21 15:46:15 +02:00
Andrew Tatomyr
f4da2c9df8 chore: send release message even if post release smokes fail (#1266) 2023-09-21 14:26:17 +02:00
github-actions[bot]
e16f1fd3a2 chore: 🔖 release new versions (#1264) 2023-09-18 15:55:23 +02:00
Adam Altman
0a73f1f557 refactor: rename to API description for consistency (#1239) 2023-09-18 15:22:26 +02:00
Roman Hotsiy
680c431cbb AsyncAPI linting support (#1127)
* chore: progress on asyncapi

* chore: more progress

* chore: enable assertions

* Feat: Start adding protocol-specific channel bindings

* Feat: flesh out components fields

* Fix: remove link and x-code-sample, not supported for asyncapi

* Feat: Add solace protocol support

* chore: refactor channel/server bindings to define and add to collection

* chore: re-order nodes to group by protocol

* chore: re-order node listings to also group by protocol

* feat: add topicConfiguration for Kafka and fix a typo

* feat: rename ServerMap for clarity

* feat: Add message bindings, remove incomplete protocols

* fix: a few tests were failing after original refactoring

* feat: add MessageTrait object

* feat: Add operation bindings, export operation and message bindings

* Feat: add a few rules for asyncapi, create channels-kebab-case

* fix: Add messageBindings and operationBindings to components section

* feat: Add no-channel-trailing-slash rule for asyncapi

* fix: Update allowed/required list for httpAPIkey

* chore: add tests for new AsyncAPI rules

* Feat: Add sample asyncapi descriptions as tests

* chore: generate snapshot.js for async-api tests

* chore: fix some minor drift between main branch and this one after
rebasing

* docs: add a guide to linting AsyncAPI

* fix: broken links in guide

* chore: run prettier

* chore: update test snapshot

* chore: clean up comments and stray log message

* docs: Update from review feedback, and add a health warning

* Update packages/core/src/config/config-resolvers.ts

Co-authored-by: Andrew Tatomyr <andrew.tatomyr@redocly.com>

* fix: allow async2 as the only feature in custom plugins

* chore: add tests and tweak error messages for document type detection

* chore: fix tests and rename majorSpecVersion->getMajorSpecVersion

* chore: run prettier

* chore: Tidy and improve comments in main asyncapi types file

* chore: remove outdated comment

* fix: remove extraneous empty extends from guide and tests

* docs: Add changeset for AsyncAPI feature

* Update .changeset/quick-emus-punch.md

Co-authored-by: Andrew Tatomyr <andrew.tatomyr@redocly.com>

---------

Co-authored-by: Lorna Mitchell <lorna.mitchell@redocly.com>
Co-authored-by: SmoliyY <yevhen.smoliy@gmail.com>
Co-authored-by: Lorna Jane Mitchell <github@lornajane.net>
Co-authored-by: Andrew Tatomyr <andrew.tatomyr@redocly.com>
2023-09-15 13:52:03 +01:00
github-actions[bot]
b8bf0075ac chore: 🔖 release new versions (#1218) 2023-09-14 16:12:57 +02:00
Andrew Tatomyr
0ea1b59f7e fix: update redocly.yaml validation (#1259) 2023-09-14 10:38:57 +02:00
Andrew Tatomyr
58a567e96a chore: update changeset descriptions (#1257) 2023-09-13 14:14:50 +02:00
Arif Kurkchi
cb7e3edf42 feat: add ignoreCase for tags-alphabetical rule (#1258) 2023-09-13 12:18:07 +02:00
Andrew Tatomyr
6c1f7948e9 chore: update changeset descriptions (#1256) 2023-09-12 08:36:54 +02:00
Andrew Tatomyr
b0d4686a73 feat: add support for Redoc 2.1.2 (#1252) 2023-09-12 08:27:13 +02:00
Ihor Karpiuk
0928bde43f chore: remove assert-node-version after #1234 (#1235) 2023-09-08 14:29:17 +02:00
Ihor Karpiuk
c4c7e21880 fix: smoke tests and update redoc to v2.1 (#1242) 2023-08-22 17:57:57 +03:00
redocly-bot
06c8fda196 sync: Synced local 'docs/' with remote 'docs/cli/' 2023-08-21 16:58:19 +00:00
redocly-bot
068db392ae sync: Synced local 'docs/' with remote 'docs/cli/' 2023-08-18 13:10:39 +00:00
Ihor Karpiuk
8199d11716 chore: replace stale dependencies (#1234) 2023-08-17 16:58:22 +03: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