Qodex.ai

Ops - Governance - Design

Number of APIs: 6

This is a suite of design governance tests for this API, using Spectral rules to lint the OpenAPI for this API, looking for common design patterns. The first Info title request pulls the OpenAPI using the Qodex API, but then every request after that just uses the stored OpenAPI as a collection variable, minimizing the number of calls made to the Qodex API.

  1. Versioning - Version Property POST {{baseUrl}}/linter?rulesUrl=https://rules.linting.org/rules/openapi-v3-info-version/

  2. Operations - Operation IDs Camel Case POST {{baseUrl}}/linter?rulesUrl=https://rules.linting.org/rules/openapi-v3-operations-operation-ids-camel-case/

  3. Parameters - Description POST {{baseUrl}}/linter?rulesUrl=https://rules.linting.org/rules/openapi-v3-parameters-description/

  4. Responses - Status Code 200 Media Type POST {{baseUrl}}/linter?rulesUrl=https://rules.linting.org/rules/openapi-v3-response-get-200-media-type/

  5. Schema - Property Descriptions POST {{baseUrl}}/linter?rulesUrl=https://rules.linting.org/rules/openapi-v3-schema-properties-descriptions/

  6. Info - Description POST {{baseUrl}}/linter?rulesUrl=https://rules.linting.org/rules/swagger-v2-info-description/