United States Department of Agriculture · API Governance Rules

United States Department of Agriculture API Rules

Spectral linting rules defining API design standards and conventions for United States Department of Agriculture.

7 Rules error 3 warn 4

View Rules File View on GitHub

Rule Categories

usda

Rules

error

usda-fdc-operation-ids

All operations must have operationIds.

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

error

usda-fdc-api-key-param

FoodData Central endpoints require api_key parameter.

$.paths[*][get].parameters[?(@.name == 'api_key')]

warn

usda-fdc-operations-have-tags

All operations must have tags.

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

warn

usda-fdc-parameters-have-descriptions

All parameters should have descriptions.

$.paths[*][*].parameters[*]

error

usda-fdc-success-responses

Operations must document 200 responses.

$.paths[*][get,post].responses

warn

usda-fdc-json-responses

FoodData Central operations should return JSON.

$.paths[*][get,post].responses.200.content

warn

usda-fdc-schemas-have-descriptions

All schema components should have descriptions.

$.components.schemas[*]

Spectral Ruleset

rules:
  usda-fdc-operation-ids:
    description: All operations must have operationIds.
    message: Operation must have an operationId.
    given: "$.paths[*][get,post,put,delete,patch]"
    then:
      field: operationId
      function: truthy
    severity: error

  usda-fdc-api-key-param:
    description: FoodData Central endpoints require api_key parameter.
    message: FDC operations must include api_key query parameter.
    given: "$.paths[*][get].parameters[?(@.name == 'api_key')]"
    then:
      field: required
      function: truthy
    severity: error

  usda-fdc-operations-have-tags:
    description: All operations must have tags.
    message: Operation must include at least one tag.
    given: "$.paths[*][get,post,put,delete,patch]"
    then:
      field: tags
      function: truthy
    severity: warn

  usda-fdc-parameters-have-descriptions:
    description: All parameters should have descriptions.
    message: Parameter must have a description.
    given: "$.paths[*][*].parameters[*]"
    then:
      field: description
      function: truthy
    severity: warn

  usda-fdc-success-responses:
    description: Operations must document 200 responses.
    message: Operation must document a 200 success response.
    given: "$.paths[*][get,post].responses"
    then:
      field: "200"
      function: truthy
    severity: error

  usda-fdc-json-responses:
    description: FoodData Central operations should return JSON.
    message: >-
      FDC API operations should document application/json response content type.
    given: "$.paths[*][get,post].responses.200.content"
    then:
      function: schema
      functionOptions:
        schema:
          type: object
          properties:
            application/json:
              type: object
    severity: warn

  usda-fdc-schemas-have-descriptions:
    description: All schema components should have descriptions.
    message: Schema component must have a description.
    given: "$.components.schemas[*]"
    then:
      field: description
      function: truthy
    severity: warn