unique-webhooks-key
Overview
This rule belongs to the openapi-v3-standards-validation
ruleset and states that:
The key name assigned to the entries in the OpenAPI Object webhooks
map must be a unique string to refer to each webhook.
Property | Value |
---|---|
Enabled | Yes |
Maximum Severity | Error |
Message | Duplicate webhooks key found. |
Code | OPENAPI3STANDARDS_V006 |
Type | Validation |
Rule System | Semantic |
Broad Category | OpenAPI Root Information |
Products Impacted | API Transformer, Code Generation, Developer Experience Portal |
Tags | openapi3 openapi standards semantic validation key webhooks |
Suggested Fixes
- Rename duplicate entries from the webhooks map.
- Key names of the webhooks are compared in a case-sensitive manner.
For More Information
- https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#oasWebhooks
- https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#openapi-object
- https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#openapi-specification
- https://docs.apimatic.io/rulesets/overview/