sync: Synced local 'docs/' with remote 'docs/cli/'

This commit is contained in:
redocly-bot
2022-08-01 23:30:33 +00:00
parent 26ea2c0016
commit 296ffe5637
57 changed files with 4236 additions and 465 deletions

View File

@@ -0,0 +1,79 @@
# info-license-url
Requires the license URL in your API definitions.
|OAS|Compatibility|
|---|---|
|2.0|✅|
|3.0|✅|
|3.1|✅|
```mermaid
flowchart TD
root ==> Info --> License --> url
style url fill:#codaf9,stroke:#0044d4,stroke-width:5px
```
## API design principles
The principle of providing your users with accurate and relevant information does not apply to API design only, but to any product-related communication in general.
Before they can work with your API, your users must understand the terms and conditions of your API usage.
"Can I use your API? Will I get in trouble? Will I lose my job?"
Sometimes questions like these go through consumers' minds.
By being upfront with the API license, you can reduce friction towards usage.
## Configuration
|Option|Type|Description|
|---|---|---|
|severity|string|Possible values: `off`, `warn`, `error`. Default `warn` (in `recommended` configuration). |
An example configuration:
```yaml
lint:
rules:
info-license-url: error
```
## Examples
Given the following configuration:
```yaml
lint:
rules:
info-license-url: error
```
Example of an **incorrect** license URL:
```yaml Object example
info:
license:
name: MIT
```
Example of a **correct** license URL:
```yaml Object example
info:
license:
name: Apache 2.0
url: https://www.apache.org/licenses/LICENSE-2.0.html
```
## Related rules
- [info-contact](./info-contact.md)
- [info-license](./info-license.md)
## Resources
- [Rule source](https://github.com/Redocly/redocly-cli/blob/master/packages/core/src/rules/common/info-license-url.ts)
- [License object docs](https://redocly.com/docs/openapi-visual-reference/license/)