security-options-meta-count-matches-security-items-count
Overview
This rule belongs to the openapi-v3-codegen-linting
ruleset and states that:
You can extend the security information you apply globally or at operation level by using the x-security-options-meta
extension. It can help you provide more details for each of the security options available. However, the number of items inside the x-security-options-meta
extension must match the number of items inside the security
list. If that is not the case, the extension data will be ignored automatically during import/transformations in APIMatic.
Property | Value |
---|---|
Enabled | Yes |
Maximum Severity | Warning |
Message | Number of items inside the x-security-options-meta extension do not match the number of items in the security list. |
Code | OPENAPI3CODEGEN_L783 |
Type | Linting |
Rule System | Semantic |
Broad Category | OpenAPI Security Requirements |
Products Impacted | Code Generation, Developer Experience Portal |
Tags | code generation sdks openapi3 openapi semantic linting apimatic count metadata security |
Suggested Fixes
- Ensure that a metadata object has been added in the
x-security-options-meta
extension corresponding to eachsecurity
item. - Ensure that the count of
x-security-options-meta
andsecurity
lists match exactly.
For More Information
- https://docs.apimatic.io/specification-extensions/swagger-codegen-extensions/#applied-authentication-options-extension
- 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-object
- https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#operation-object
- https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#operation-object
- https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md
- https://docs.apimatic.io/rulesets/overview/