mirror of
https://github.com/LukeHagar/redocly-cli.git
synced 2025-12-10 12:47:49 +00:00
1.7 KiB
1.7 KiB
slug
| slug |
|---|
| /docs/cli/rules/info-license |
info-license
Requires the license info in your API descriptions.
| OAS | Compatibility |
|---|---|
| 2.0 | ✅ |
| 3.0 | ✅ |
| 3.1 | ✅ |
flowchart TD
root ==> Info --> License
style License 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.
By being upfront with the API license, you can reduce friction and encourage API adoption.
Configuration
| Option | Type | Description |
|---|---|---|
| severity | string | Possible values: off, warn, error. Default warn (in recommended configuration). |
An example configuration:
rules:
info-license: error
Examples
Given the following configuration:
rules:
info-license: error
Example of an incorrect license:
info:
version: v1.1
Example of a correct license:
info:
license:
name: Apache 2.0