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

chore: Run prettier on all docs files (#1334)

Browse Source
This commit is contained in:
Lorna Jane Mitchell
2023-11-17 09:45:03 +00:00
committed by GitHub
parent 166e16d6ca
commit de80612b55
83 changed files with 792 additions and 743 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
docs/rules/info-license-url.md
View File

@@ -1,16 +1,16 @@
---
slug: /docs/cli/rules/info-license-url
---
# info-license-url
Requires the license URL in your API descriptions.
|OAS|Compatibility|
|---|---|
|2.0|✅|
|3.0|✅|
|3.1|✅|
| OAS | Compatibility |
| --- | ------------- |
| 2.0 | ✅ |
| 3.0 | ✅ |
| 3.1 | ✅ |
```mermaid
flowchart TD
@@ -30,9 +30,9 @@ By being upfront with the API license, you can reduce friction and encourage API
## Configuration
|Option|Type|Description|
|---|---|---|
|severity|string|Possible values: `off`, `warn`, `error`. Default `warn` (in `recommended` configuration). |
| Option | Type | Description |
| -------- | ------ | ----------------------------------------------------------------------------------------- |
| severity | string | Possible values: `off`, `warn`, `error`. Default `warn` (in `recommended` configuration). |
An example configuration:
@@ -44,6 +44,7 @@ rules:
## Examples
Given the following configuration:
```yaml
rules:
info-license-url: error
@@ -75,4 +76,3 @@ info:
- [Rule source](https://github.com/Redocly/redocly-cli/blob/main/packages/core/src/rules/common/info-license-url.ts)
- [License object docs](https://redocly.com/docs/openapi-visual-reference/license/)