We've expanded the openapi-v3-apimatic-linting,openapi-v3-codegen-linting, openapi-v3-standard-linting, and openapi-v3-standards-validation rulesets with new linting and validation rules covering Pagination, Webhooks, and Callbacks.
Details
As part of our continued investment in API quality tooling, the openapi-v3-apimatic-linting, openapi-v3-codegen-linting, openapi-v3-standards-linting, and openapi-v3-standards-validation rulesets now include dedicated rules for Pagination, Webhooks, and Callbacks. These additions help catch structural and semantic issues in your OpenAPI definitions early, before they result in incorrect SDK generation or documentation gaps.
Pagination Rules
12 new linting rules have been added to validate the use of APIMatic's pagination extension:
- valid-pagination-type
- pagination-type-required
- valid-pagination-json-pointer
- pagination-result-points-to-array
- pagination-pointer-points-valid-property
- pagination-input-must-point-to-integer-property
- non-empty-pagination-input
- non-empty-pagination-output
- non-empty-pagination-result
- non-empty-pagination-next
- cursor-input-cursor-output-types-should-match
- link-pagination-next-must-be-string
Webhook Rules
24 new linting rules have been added to validate OpenAPI Webhooks definitions:
- webhook-only-post-method-allowed
- webhook-valid-key
- webhook-valid-placeholder-delimiter
- webhook-no-group-assigned
- webhook-group-non-empty-description
- webhook-extension-group-must-exist-when-referenced
- webhook-payload-verification-algorithm-required
- webhook-payload-verification-invalid-algorithm
- webhook-payload-verification-signature-header-required
- webhook-payload-verification-valid-digest-encoding
- webhook-payload-verification-digest-encoding-requires-hmac-algorithm
- webhook-payload-verification-valid-message-template
- webhook-payload-verification-valid-signature-value-template
- webhook-discriminator-property-pointer-required
- webhook-discriminator-property-pointer-empty-path
- webhook-discriminator-property-pointer-invalid-format
- webhook-discriminator-property-pointer-invalid-location
- webhook-discriminator-property-pointer-points-to-valid-property
- webhook-discriminator-property-pointer-references-string-type
- webhook-discriminator-property-pointer-missing-request-body
- webhook-discriminator-property-pointer-missing-request-body-content
- webhook-discriminator-mapping-value-empty
- webhook-discriminator-mapping-value-references-existing-definition
- webhook-missing-request-body
Callback Rules
26 new linting rules have been added to validate OpenAPI Callbacks definitions:
- callback-only-post-method-allowed
- callback-valid-key
- callback-valid-placeholder-delimiter
- callback-no-group-assigned-warning
- callback-group-non-empty-description
- callback-extension-group-must-exist-when-referenced
- callback-payload-verification-algorithm-required
- callback-payload-verification-invalid-algorithm
- callback-payload-verification-signature-header-required
- callback-payload-verification-valid-digest-encoding
- callback-payload-verification-digest-encoding-requires-hmac-algorithm
- callback-payload-verification-valid-message-template
- callback-payload-verification-valid-signature-value-template
- callback-discriminator-property-pointer-required
- callback-discriminator-property-pointer-empty-path
- callback-discriminator-property-pointer-invalid-format
- callback-discriminator-property-pointer-invalid-location
- callback-discriminator-property-pointer-points-to-valid-property
- callback-discriminator-property-pointer-references-string-type
- callback-discriminator-property-pointer-missing-request-body
- callback-discriminator-property-pointer-missing-request-body-content
- callback-discriminator-mapping-value-empty
- callback-discriminator-mapping-value-references-existing-definition
- callback-missing-request-body
- callback-operation-required-warning
- valid-callback-url-expression