LukeParke/redocly-cli
1
0
Fork 0
mirror of https://github.com/LukeHagar/redocly-cli.git synced 2025-12-06 04:21:09 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: Fix an outdated admonition format (#1711)

Browse Source
This commit is contained in:
Lorna Jane Mitchell
2024-09-04 13:56:32 +01:00
committed by GitHub
parent ed52a9121f
commit 1002e80f40
2 changed files with 2 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
docs/guides/lint-asyncapi.md
View File

@@ -99,13 +99,12 @@ opportunities to make sure that your AsyncAPI spec conforms with expectations
(we'd also love to see what you're building, it helps us know how things are (we'd also love to see what you're building, it helps us know how things are
going!). going!).
:::info Custom plugins {% admonition type="info" name="Custom plugins" %}
For those users with advanced requirements and JavaScript skills, the [custom For those users with advanced requirements and JavaScript skills, the [custom
plugins](../custom-plugins/index.md) feature offers some extension points if you need plugins](../custom-plugins/index.md) feature offers some extension points if you need
them. them.
::: {% /admonition %}
## Supported protocols ## Supported protocols

6
docs/guides/migrate-from-swagger-cli.md
View File

@@ -46,14 +46,8 @@ redocly lint openapi.yml
You can add more [built-in rules](../rules/built-in-rules.md) by adding them in the configuration file, and adjust the level of the messages by using `warn` rather than `error`. You can add more [built-in rules](../rules/built-in-rules.md) by adding them in the configuration file, and adjust the level of the messages by using `warn` rather than `error`.
<!-- :::info Redocly configuration -->
<!-- :::info Redocly configuration -->
Learn more about [configuring Redocly CLI](../configuration/index.md) in the documentation. Learn more about [configuring Redocly CLI](../configuration/index.md) in the documentation.
<!-- ::: -->
## Bundle OpenAPI/Swagger into a single file ## Bundle OpenAPI/Swagger into a single file
While the OpenAPI (and earlier Swagger) standards were designed to use `$ref` reference syntax and re-use elements of API descriptions across mulitple files, not all tools support this. If there's a tool in your API lifecycle that needs a single file, you can still use mulitple files for the day-to-day work, and then "bundle" the API description into a single file for use by another tool. While the OpenAPI (and earlier Swagger) standards were designed to use `$ref` reference syntax and re-use elements of API descriptions across mulitple files, not all tools support this. If there's a tool in your API lifecycle that needs a single file, you can still use mulitple files for the day-to-day work, and then "bundle" the API description into a single file for use by another tool.