Gopuff · API Governance Rules

Gopuff API Rules

Spectral linting rules defining API design standards and conventions for Gopuff.

Gopuff API Rules is a Spectral governance ruleset published by Gopuff on the APIs.io network, containing 8 lint rules.

The ruleset includes 7 error-severity rules and 1 warning-severity rule.

Tagged areas include Quick Commerce, Instant Delivery, Last Mile, Grocery, and Fulfillment.

Rulesets can be applied to your own OpenAPI specs via Spectral to enforce the same governance standards.

8 Rules error 7 warn 1
View Rules File View on GitHub

Rule Categories

gopuff

Rules

error
gopuff-info-contact-defined
Powered by Gopuff specs must include a contact for partner support.
$.info
error
gopuff-info-terms-defined
Powered by Gopuff specs must reference the Gopuff terms of service.
$.info
error
gopuff-server-must-be-partner-host
All servers must point at fulfillment-api-eus.partners.gopuff.com under the /shopify/v1 base.
$.servers[*].url
warn
gopuff-operation-summary-title-case
Operation summaries must use Title Case.
$.paths[*][get,post,put,patch,delete].summary
error
gopuff-operation-id-camel-case
operationId values must use camelCase.
$.paths[*][get,post,put,patch,delete].operationId
error
gopuff-operation-must-have-tag
Every operation must declare exactly one tag.
$.paths[*][get,post,put,patch,delete].tags
error
gopuff-security-required
The partner API requires the X-Gopuff-Partner-Key apiKey scheme on every operation.
$.paths[*][get,post,put,patch,delete]
error
gopuff-error-schema-defined
A reusable Error schema must be defined in components.
$.components.schemas

Spectral Ruleset

Raw ↑ 
extends:
  - [spectral:oas, all]
documentationUrl: https://github.com/api-evangelist/gopuff/blob/main/rules/gopuff-fulfillment-rules.yml
rules:
  gopuff-info-contact-defined:
    description: Powered by Gopuff specs must include a contact for partner support.
    given: $.info
    severity: error
    then:
      field: contact
      function: truthy
  gopuff-info-terms-defined:
    description: Powered by Gopuff specs must reference the Gopuff terms of service.
    given: $.info
    severity: error
    then:
      field: termsOfService
      function: truthy
  gopuff-server-must-be-partner-host:
    description: All servers must point at fulfillment-api-eus.partners.gopuff.com under the /shopify/v1 base.
    given: $.servers[*].url
    severity: error
    then:
      function: pattern
      functionOptions:
        match: '^https:\\/\\/fulfillment-api-[a-z]+\\.partners\\.gopuff\\.com\\/shopify\\/v1$'
  gopuff-operation-summary-title-case:
    description: Operation summaries must use Title Case.
    given: $.paths[*][get,post,put,patch,delete].summary
    severity: warn
    then:
      function: pattern
      functionOptions:
        match: '^([A-Z][a-zA-Z0-9]*)( [A-Z][a-zA-Z0-9]*)*$'
  gopuff-operation-id-camel-case:
    description: operationId values must use camelCase.
    given: $.paths[*][get,post,put,patch,delete].operationId
    severity: error
    then:
      function: pattern
      functionOptions:
        match: '^[a-z][a-zA-Z0-9]+$'
  gopuff-operation-must-have-tag:
    description: Every operation must declare exactly one tag.
    given: $.paths[*][get,post,put,patch,delete].tags
    severity: error
    then:
      function: length
      functionOptions:
        min: 1
        max: 1
  gopuff-security-required:
    description: The partner API requires the X-Gopuff-Partner-Key apiKey scheme on every operation.
    given: $.paths[*][get,post,put,patch,delete]
    severity: error
    then:
      field: security
      function: truthy
  gopuff-error-schema-defined:
    description: A reusable Error schema must be defined in components.
    given: $.components.schemas
    severity: error
    then:
      field: Error
      function: truthy