United States National Library of Medicine · API Governance Rules

United States National Library of Medicine API Rules

Spectral linting rules defining API design standards and conventions for United States National Library of Medicine.

7 Rules error 3 warn 4

View Rules File View on GitHub

Rule Categories

ncbi

Rules

error

ncbi-operation-ids-required

All operations must have operationIds.

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

error

ncbi-db-param-for-eutils

E-utilities operations require a db parameter.

$.paths[?(@property =~ /esearch|efetch|esummary|elink/)][get].parameters[?(@.name == 'db')]

warn

ncbi-operations-have-tags

All operations should have tags for grouping.

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

warn

ncbi-parameters-have-descriptions

All parameters should have descriptions.

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

error

ncbi-success-responses

Operations must document 200 success responses.

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

warn

ncbi-schemas-have-descriptions

Schema components should have descriptions.

$.components.schemas[*]

warn

ncbi-info-contact

API info should include contact information.

$.info

Spectral Ruleset

rules:
  ncbi-operation-ids-required:
    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

  ncbi-db-param-for-eutils:
    description: E-utilities operations require a db parameter.
    message: E-utilities operations should include a db query parameter.
    given: "$.paths[?(@property =~ /esearch|efetch|esummary|elink/)][get].parameters[?(@.name == 'db')]"
    then:
      field: required
      function: truthy
    severity: error

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

  ncbi-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

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

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

  ncbi-info-contact:
    description: API info should include contact information.
    message: API info block must contain a contact object.
    given: "$.info"
    then:
      field: contact
      function: truthy
    severity: warn