mirror of
https://github.com/LukeHagar/redocly-cli.git
synced 2025-12-06 04:21:09 +00:00
79 lines
1.8 KiB
Markdown
79 lines
1.8 KiB
Markdown
---
|
|
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 | ✅ |
|
|
|
|
```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.
|
|
|
|
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:
|
|
|
|
```yaml
|
|
rules:
|
|
info-license-url: error
|
|
```
|
|
|
|
## Examples
|
|
|
|
Given the following configuration:
|
|
|
|
```yaml
|
|
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/main/packages/core/src/rules/common/info-license-url.ts)
|
|
- [License object docs](https://redocly.com/docs/openapi-visual-reference/license/)
|