Amazon CodeArtifact · API Governance Rules

Amazon CodeArtifact API Rules

Spectral linting rules defining API design standards and conventions for Amazon CodeArtifact.

27 Rules error 11 warn 13 info 3
View Rules File View on GitHub

Rule Categories

delete error get info no openapi operation parameter query response schema security servers

Rules

warn
info-title-format
API title should identify CodeArtifact service
$.info.title
error
info-description-required
API must have a description
$.info
error
info-version-required
API must have a version
$.info
warn
openapi-version
Must use OpenAPI 3.0.x
$.openapi
error
servers-defined
Servers must be defined
$
error
servers-https
All server URLs must use HTTPS
$.servers[*].url
error
operation-summary-required
Every operation must have a summary
$.paths[*][get,post,put,delete,patch,head,options]
warn
operation-summary-amazon-prefix
Operation summaries should start with Amazon CodeArtifact
$.paths[*][get,post,put,delete,patch].summary
warn
operation-description-required
Every operation must have a description
$.paths[*][get,post,put,delete,patch,head,options]
error
operation-operationId-required
Every operation must have an operationId
$.paths[*][get,post,put,delete,patch,head,options]
warn
operation-operationId-camelcase
operationId should use camelCase
$.paths[*][get,post,put,delete,patch].operationId
warn
operation-tags-required
Every operation must have tags
$.paths[*][get,post,put,delete,patch]
warn
parameter-description-required
Every parameter must have a description
$.paths[*][*].parameters[*]
error
parameter-schema-required
Every parameter must have a schema
$.paths[*][*].parameters[*]
error
response-success-required
Every operation must define at least one 2xx response
$.paths[*][get,post,put,delete,patch]
error
response-description-required
Every response must have a description
$.paths[*][*].responses[*]
info
schema-property-description
Schema properties should have descriptions
$.components.schemas[*].properties[*]
warn
schema-type-required
Schema components should have a type defined
$.components.schemas[*]
error
security-schemes-defined
Security schemes must be defined in components
$.components
error
get-no-request-body
GET operations must not have a request body
$.paths[*].get
warn
delete-no-request-body
DELETE operations should not have a request body
$.paths[*].delete
warn
no-empty-descriptions
Descriptions must not be empty strings
$..description
info
operation-examples-encouraged
Operations should include examples for Microcks compatibility
$.paths[*][get,post,put,delete,patch]
warn
query-params-casing
Query parameters should be snake_case (the dominant convention in this API).
$.paths[*][get,post,put,patch,delete].parameters[?(@.in=='query')]
warn
schema-names-casing
Component schema names should be PascalCase (the dominant convention in this API).
$.components.schemas
info
schema-properties-casing
Schema properties should be snake_case (the dominant convention in this API).
$.components.schemas[*].properties
warn
error-schema-defined
A shared error schema (PackageVersionErrorMap) should be defined for error payloads.
$.components.schemas

Spectral Ruleset

Raw ↑
# amazon-codeartifact — Spectral ruleset (strengthened)
# Plain Spectral. Existing hand-authored rules preserved; measured rules added
# from this provider's own OpenAPI conventions by strengthen_ruleset.py,
# then self-validated against the spec.
#
# Provenance:
#   - servers-https-only: 50% of servers already https (warn)
#   - query-params-casing: snake @ 62% (n=184)
#   - operationid-casing: pascal @ 100% (n=38)
#   - schema-names-casing: pascal @ 99% (n=166)
#   - schema-properties-casing: snake @ 58% (n=191)
#   - security: global (root) — NOT emitting operation-security-required
#   - error-schema-defined: PackageVersionErrorMap
#   - pagination params observed: ['maxResults', 'nextToken']
#   - merge: kept 23 existing, added 4 measured, upgraded 0
#   - added: query-params-casing, schema-names-casing, schema-properties-casing, error-schema-defined
extends:
  - spectral:oas
rules:
  info-title-format:
    description: API title should identify CodeArtifact service
    severity: warn
    given: $.info.title
    then:
      function: pattern
      functionOptions:
        match: ^CodeArtifact
  info-description-required:
    description: API must have a description
    severity: error
    given: $.info
    then:
      field: description
      function: truthy
  info-version-required:
    description: API must have a version
    severity: error
    given: $.info
    then:
      field: version
      function: truthy
  openapi-version:
    description: Must use OpenAPI 3.0.x
    severity: warn
    given: $.openapi
    then:
      function: pattern
      functionOptions:
        match: ^3\.0\.
  servers-defined:
    description: Servers must be defined
    severity: error
    given: $
    then:
      field: servers
      function: truthy
  servers-https:
    description: All server URLs must use HTTPS
    severity: error
    given: $.servers[*].url
    then:
      function: pattern
      functionOptions:
        match: ^https://
  operation-summary-required:
    description: Every operation must have a summary
    severity: error
    given: $.paths[*][get,post,put,delete,patch,head,options]
    then:
      field: summary
      function: truthy
  operation-summary-amazon-prefix:
    description: Operation summaries should start with Amazon CodeArtifact
    severity: warn
    given: $.paths[*][get,post,put,delete,patch].summary
    then:
      function: pattern
      functionOptions:
        match: ^Amazon CodeArtifact
  operation-description-required:
    description: Every operation must have a description
    severity: warn
    given: $.paths[*][get,post,put,delete,patch,head,options]
    then:
      field: description
      function: truthy
  operation-operationId-required:
    description: Every operation must have an operationId
    severity: error
    given: $.paths[*][get,post,put,delete,patch,head,options]
    then:
      field: operationId
      function: truthy
  operation-operationId-camelcase:
    description: operationId should use camelCase
    severity: warn
    given: $.paths[*][get,post,put,delete,patch].operationId
    then:
      function: pattern
      functionOptions:
        match: ^[a-z][a-zA-Z0-9]*$
  operation-tags-required:
    description: Every operation must have tags
    severity: warn
    given: $.paths[*][get,post,put,delete,patch]
    then:
      field: tags
      function: truthy
  parameter-description-required:
    description: Every parameter must have a description
    severity: warn
    given: $.paths[*][*].parameters[*]
    then:
      field: description
      function: truthy
  parameter-schema-required:
    description: Every parameter must have a schema
    severity: error
    given: $.paths[*][*].parameters[*]
    then:
      field: schema
      function: truthy
  response-success-required:
    description: Every operation must define at least one 2xx response
    severity: error
    given: $.paths[*][get,post,put,delete,patch]
    then:
      field: responses
      function: schema
      functionOptions:
        schema:
          type: object
          minProperties: 1
  response-description-required:
    description: Every response must have a description
    severity: error
    given: $.paths[*][*].responses[*]
    then:
      field: description
      function: truthy
  schema-property-description:
    description: Schema properties should have descriptions
    severity: info
    given: $.components.schemas[*].properties[*]
    then:
      field: description
      function: truthy
  schema-type-required:
    description: Schema components should have a type defined
    severity: warn
    given: $.components.schemas[*]
    then:
      field: type
      function: truthy
  security-schemes-defined:
    description: Security schemes must be defined in components
    severity: error
    given: $.components
    then:
      field: securitySchemes
      function: truthy
  get-no-request-body:
    description: GET operations must not have a request body
    severity: error
    given: $.paths[*].get
    then:
      field: requestBody
      function: falsy
  delete-no-request-body:
    description: DELETE operations should not have a request body
    severity: warn
    given: $.paths[*].delete
    then:
      field: requestBody
      function: falsy
  no-empty-descriptions:
    description: Descriptions must not be empty strings
    severity: warn
    given: $..description
    then:
      function: pattern
      functionOptions:
        match: .+
  operation-examples-encouraged:
    description: Operations should include examples for Microcks compatibility
    severity: info
    given: $.paths[*][get,post,put,delete,patch]
    then:
      field: x-microcks-operation
      function: truthy
  query-params-casing:
    description: Query parameters should be snake_case (the dominant convention in this API).
    severity: warn
    given: $.paths[*][get,post,put,patch,delete].parameters[?(@.in=='query')]
    then:
      field: name
      function: casing
      functionOptions:
        type: snake
  schema-names-casing:
    description: Component schema names should be PascalCase (the dominant convention in this API).
    severity: warn
    given: $.components.schemas
    then:
      field: '@key'
      function: pattern
      functionOptions:
        match: ^[A-Z][A-Za-z0-9]*$
  schema-properties-casing:
    description: Schema properties should be snake_case (the dominant convention in this API).
    severity: info
    given: $.components.schemas[*].properties
    then:
      field: '@key'
      function: casing
      functionOptions:
        type: snake
  error-schema-defined:
    description: A shared error schema (PackageVersionErrorMap) should be defined for error payloads.
    severity: warn
    given: $.components.schemas
    then:
      field: PackageVersionErrorMap
      function: truthy