Shopper Approved · API Governance Rules

Shopper Approved API Rules

Spectral linting rules defining API design standards and conventions for Shopper Approved.

7 Rules error 3 warn 4

View Rules File View on GitHub

Rule Categories

shopper

Rules

warn

shopper-approved-site-id-path

Shopper Approved API uses site_id as a path parameter in all endpoints

$.paths[*]~

warn

shopper-approved-token-query-param

Shopper Approved API requires token as a query parameter

$.paths[*][get,post,put].parameters[?(@.in == 'query' && @.name == 'token')]

error

shopper-approved-operation-ids

All Shopper Approved API operations must have operationIds

$.paths[*][get,post,put,delete,patch]

warn

shopper-approved-tag-required

All operations must be tagged for grouping

$.paths[*][get,post,put,delete,patch]

error

shopper-approved-response-200

GET operations must define a 200 response

$.paths[*].get

warn

shopper-approved-rating-schema

Review rating should be constrained to 1-5 range

$.components.schemas.Review.properties.rating

error

shopper-approved-https-server

Shopper Approved API should use HTTPS

$.servers[*].url

Spectral Ruleset

extends: spectral:oas
rules:
  shopper-approved-site-id-path:
    description: Shopper Approved API uses site_id as a path parameter in all endpoints
    severity: warn
    given: "$.paths[*]~"
    then:
      function: pattern
      functionOptions:
        match: "\\{site_id\\}"

  shopper-approved-token-query-param:
    description: Shopper Approved API requires token as a query parameter
    severity: warn
    given: "$.paths[*][get,post,put].parameters[?(@.in == 'query' && @.name == 'token')]"
    then:
      field: required
      function: truthy

  shopper-approved-operation-ids:
    description: All Shopper Approved API operations must have operationIds
    severity: error
    given: "$.paths[*][get,post,put,delete,patch]"
    then:
      field: operationId
      function: truthy

  shopper-approved-tag-required:
    description: All operations must be tagged for grouping
    severity: warn
    given: "$.paths[*][get,post,put,delete,patch]"
    then:
      field: tags
      function: truthy

  shopper-approved-response-200:
    description: GET operations must define a 200 response
    severity: error
    given: "$.paths[*].get"
    then:
      field: responses.200
      function: truthy

  shopper-approved-rating-schema:
    description: Review rating should be constrained to 1-5 range
    severity: warn
    given: "$.components.schemas.Review.properties.rating"
    then:
      function: schema
      functionOptions:
        schema:
          type: object
          required:
            - minimum
            - maximum

  shopper-approved-https-server:
    description: Shopper Approved API should use HTTPS
    severity: error
    given: "$.servers[*].url"
    then:
      function: pattern
      functionOptions:
        match: "^https://"