metadata.yml

rules:
  servers-description:
    description: Servers must have a description.
    message: >-
      Server {{path}} must have a description.
    given: $.servers[*]
    severity: error
    recommended: true
    then:
      field: description
      function: truthy

  servers-use-https:
    description: Servers must use https
    message: >-
      Non-sandbox url  {{value}} {{error}}. Add `x-sandbox: true` to declare the server as a sandbox.
    given: >-
      $.servers[?(@["x-sandbox"] != true)]
    severity: error
    recommended: true
    then:
      field: url
      function: pattern
      functionOptions:
        match: ^https://.*

  has-x-summary:
    description: >-
      API must have an one-liner summary field in x-summary {{path}}
    given: $
    severity: error
    recommended: true
    type: style
    formats:
    - oas3
    then:
      field: "info.x-summary"
      function: truthy

  has-termsOfService:
    description: >-
      API MUST reference the URL of the Terms of Service {{path}}
    given: $
    severity: error
    recommended: true
    type: style
    formats:
    - oas3
    then:
      field: "info.termsOfService"
      function: truthy

  has-contact:
    description: >-
      API MUST reference a contact, either url or email: {{path}}
    given: $
    severity: error
    recommended: true
    type: style
    formats:
    - oas3
    then:
      field: "info.contact"
      function: truthy

  has-x-api-id:
    description: >-
      API must have an unique identifier in x-api-id {{path}}
    given: $
    severity: error
    recommended: true
    type: style
    then:
      field: "info.x-api-id"
      function: truthy

  paths-kebab-case:
    description: |
      Paths should be kebab-case.
      See https://docs.italia.it/italia/piano-triennale-ict/lg-modellointeroperabilita-docs/it/bozza/doc/profili-di-interazione/regole-comuni-rest-soap.html#usare-parole-separate-da-trattino-per-i-path-kebab-case
    message: '{{property}} is not kebab-case: {{error}}'
    severity: warn
    recommended: true
    given: $.paths[*]~
    then:
      function: pattern
      functionOptions:
        match: "^(\/[a-z0-9-.]+|\/{[a-zA-Z0-9_]+})+$"