Google Nest Smart Device Management · API Governance Rules

Google Nest Smart Device Management API Rules

Spectral linting rules defining API design standards and conventions for Google Nest Smart Device Management.

17 Rules error 11 warn 4 info 2
View Rules File View on GitHub

Rule Categories

deprecated info no operation operationid paths response schema servers tags

Rules

error
info-title-required
$.info
error
info-description-required
$.info
error
info-version-required
$.info
error
servers-defined
$
error
servers-https-only
$.servers[*].url
error
paths-no-trailing-slash
$.paths
error
operation-description-required
$.paths[*][get,post,put,patch,delete]
error
operation-operationid-required
$.paths[*][get,post,put,patch,delete]
error
operation-operationid-unique
$
info
tags-title-case
$.tags[*].name
error
response-success-required
$.paths[*][get,post,put,patch,delete].responses
warn
deprecated-description
Deprecated operations should explain the deprecation.
$.paths[*][get,post,put,patch,delete][?(@.deprecated==true)]
error
no-empty-descriptions
$..description
warn
servers-expected-domain
Server URLs should be on the googleapis.com domain.
$.servers[*].url
warn
operationid-casing
Operation IDs should be camelCase (the dominant convention in this API).
$.paths[*][get,post,put,patch,delete].operationId
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

Spectral Ruleset

Raw ↑
# google-nest — 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: 100% of servers already https (error)
#   - servers-expected-domain: 1/1 servers on googleapis.com
#   - path-params-casing: camel @ 100% (n=8)
#   - operationid-casing: camel @ 100% (n=5)
#   - schema-names-casing: pascal @ 100% (n=9)
#   - schema-properties-casing: snake @ 88% (n=16)
#   - merge: kept 13 existing, added 4 measured, upgraded 0
#   - added: servers-expected-domain, operationid-casing, schema-names-casing, schema-properties-casing
extends:
  - spectral:oas
rules:
  info-title-required:
    severity: error
    given: $.info
    then:
      field: title
      function: truthy
  info-description-required:
    severity: error
    given: $.info
    then:
      field: description
      function: truthy
  info-version-required:
    severity: error
    given: $.info
    then:
      field: version
      function: truthy
  servers-defined:
    severity: error
    given: $
    then:
      field: servers
      function: truthy
  servers-https-only:
    severity: error
    given: $.servers[*].url
    then:
      function: pattern
      functionOptions:
        match: ^https://
  paths-no-trailing-slash:
    severity: error
    given: $.paths
    then:
      field: '@key'
      function: pattern
      functionOptions:
        notMatch: \/$
  operation-description-required:
    severity: error
    given: $.paths[*][get,post,put,patch,delete]
    then:
      field: description
      function: truthy
  operation-operationid-required:
    severity: error
    given: $.paths[*][get,post,put,patch,delete]
    then:
      field: operationId
      function: truthy
  operation-operationid-unique:
    severity: error
    given: $
    then:
      function: oasOpId
  tags-title-case:
    severity: info
    given: $.tags[*].name
    then:
      function: pattern
      functionOptions:
        match: ^[A-Z][a-zA-Z0-9]*(\s[A-Za-z0-9]+)*$
  response-success-required:
    severity: error
    given: $.paths[*][get,post,put,patch,delete].responses
    then:
      function: schema
      functionOptions:
        schema:
          anyOf:
          - required:
            - '200'
          - required:
            - '201'
          - required:
            - '204'
  deprecated-description:
    severity: warn
    description: Deprecated operations should explain the deprecation.
    given: $.paths[*][get,post,put,patch,delete][?(@.deprecated==true)]
    then:
      field: description
      function: pattern
      functionOptions:
        match: '[Dd]eprecated|[Ss]unset'
  no-empty-descriptions:
    severity: error
    given: $..description
    then:
      function: truthy
  servers-expected-domain:
    description: Server URLs should be on the googleapis.com domain.
    severity: warn
    given: $.servers[*].url
    then:
      function: pattern
      functionOptions:
        match: googleapis\.com
  operationid-casing:
    description: Operation IDs should be camelCase (the dominant convention in this API).
    severity: warn
    given: $.paths[*][get,post,put,patch,delete].operationId
    then:
      function: casing
      functionOptions:
        type: camel
  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: casing
      functionOptions:
        type: pascal
  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