Sony · API Governance Rules

Sony API Rules

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

3 Rules error 1 warn 1 info 1
View Rules File View on GitHub

Rule Categories

sony

Rules

warn
sony-tags-title-case
Tags should be Title Case
$.tags[*].name
error
sony-operation-id-camel-case
operationId should be camelCase
$.paths.*.*.operationId
info
sony-license-required
Repos should declare an Apache 2.0 or MIT license
$.info.license.name

Spectral Ruleset

sony-spectral-rules.yml Raw ↑ 
extends: [[spectral:oas, all]]
rules:
  sony-tags-title-case:
    description: Tags should be Title Case
    given: $.tags[*].name
    severity: warn
    then:
      function: pattern
      functionOptions:
        match: '^([A-Z][a-zA-Z0-9]*)( [A-Z][a-zA-Z0-9]*)*$'
  sony-operation-id-camel-case:
    description: operationId should be camelCase
    given: $.paths.*.*.operationId
    severity: error
    then:
      function: pattern
      functionOptions:
        match: '^[a-z][a-zA-Z0-9]+$'
  sony-license-required:
    description: Repos should declare an Apache 2.0 or MIT license
    given: $.info.license.name
    severity: info
    then:
      function: pattern
      functionOptions:
        match: '(Apache-2\\.0|MIT)'