Merge pull request #22 from adidas/ruleset

Adding spectral ruleset from guidelines digest.
2025-10-25 15:19:19 +00:00 · 2019-11-26 17:24:52 +01:00
parent e252e9c45d 2b38b536df
commit d191a652a0
19 changed files with 3142 additions and 5 deletions
--- a/.gitignore
+++ b/.gitignore
@@ -0,0 +1,107 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+*.lcov
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# TypeScript v1 declaration files
+typings/
+
+# TypeScript cache
+*.tsbuildinfo
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Microbundle cache
+.rpt2_cache/
+.rts2_cache_cjs/
+.rts2_cache_es/
+.rts2_cache_umd/
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variables file
+.env
+.env.test
+
+# parcel-bundler cache (https://parceljs.org/)
+.cache
+
+# Next.js build output
+.next
+
+# Nuxt.js build / generate output
+.nuxt
+dist
+
+# Gatsby files
+.cache/
+# Comment in the public line in if your project uses Gatsby and *not* Next.js
+# https://nextjs.org/blog/next-9-1#public-directory-support
+# public
+
+# vuepress build output
+.vuepress/dist
+
+# Serverless directories
+.serverless/
+
+# FuseBox cache
+.fusebox/
+
+# DynamoDB Local files
+.dynamodb/
+
+# TernJS port file
+.tern-port
+
+# SSHFS
+._*
--- a/.spectral.yml
+++ b/.spectral.yml
@@ -0,0 +1,301 @@
+extends: [spectral:oas2, spectral:oas3]
+rules:
+
+  # ---------------------------------------------------------------------------
+  # General OAS rules
+  # ---------------------------------------------------------------------------
+
+  operation-operationId: false
+  operation-tags: false
+  operation-2xx-response: error
+
+  paths-camelCase:
+    description: All YAML/JSON paths MUST follow camelCase
+    severity: warn
+    recommended: true
+    message: "{{property}} is not camelCase: {{error}}"
+    given: $.paths[*]~
+    then:
+      function: pattern
+      functionOptions:
+        # match: "/^(\/{1}(([{]?[a-z])[A-Za-z0-9]*[}]?)*)+$/" # - more generic one, allows /asasd{asdas}sadas pattern but also not closed braces
+        match: "^\/([a-z][a-zA-Z0-9]+)?(\/[a-z][a-zA-Z0-9]+|\/{[a-z][a-zA-Z0-9]+})*$" # doesn't allow /asasd{asdas}sadas pattern or not closed braces
+
+  definitions-camelCase-alphanumeric:
+    description: All YAML/JSON definitions MUST follow fields-camelCase and be ASCII alphanumeric characters or `_` or `$`.
+    severity: error
+    recommended: true
+    message: "{{property}} MUST follow camelCase and be ASCII alphanumeric characters or `_` or `$`."
+    given: $.definitions[*]~
+    then:
+      function: pattern
+      functionOptions:
+        match: "/^[a-z$_]{1}[A-Z09$_]*/"
+
+  properties-camelCase-alphanumeric:
+    description: All JSON Schema properties MUST follow fields-camelCase and be ASCII alphanumeric characters or `_` or `$`.
+    severity: error
+    recommended: true
+    message: "{{property}} MUST follow camelCase and be ASCII alphanumeric characters or `_` or `$`."
+    given: $.definitions..properties[*]~
+    then:
+      function: pattern
+      functionOptions:
+        match: "/^[a-z$_]{1}[A-Z09$_]*/"
+
+  request-GET-no-body:
+    description: "A 'GET' request MUST NOT accept a 'body` parameter"
+    severity: error
+    given: $.paths..get.parameters..in
+    then:
+      function: pattern
+      functionOptions:
+        notMatch: "/^body$/"
+
+  uri-template-cannot-dash:
+    description: "The 'URI' template (RFC 6570 - https://tools.ietf.org/html/rfc6570) cannot contain a '-' character"
+    severity: error
+    recommended: true
+    message: "{{property}}: {{description}}"
+    given: "$.paths[*]~"
+    then:
+      function: pattern
+      functionOptions:
+        notMatch: "/-/"
+
+  headers-no-x-headers:
+    description: "All 'HTTP' headers SHOULD NOT include 'X-' headers (https://tools.ietf.org/html/rfc6648)."
+    severity: warn
+    given: "$..parameters[?(@.in == 'header')].name"
+    message: "HTTP headers SHOULD NOT include 'X-' prefix."
+    recommended: true
+    type: style
+    then: 
+      function: pattern
+      functionOptions:
+        notMatch: "/^(x|X)-/"
+
+  headers-hyphenated-pascal-case:
+    description: All `HTTP` headers MUST use `Hyphenated-Pascal-Case` notation
+    severity: error
+    given: "$..parameters[?(@.in == 'header')].name"
+    message: "'HTTP' headers MUST follow 'Hyphenated-Pascal-Case' notation"
+    recommended: true
+    type: style
+    then: 
+      function: pattern
+      functionOptions:
+        match: "/^([A-Z][a-z0-9]-)*([A-Z][a-z0-9])+/"
+
+  # ---------------------------------------------------------------------------
+  # Only OAS2 rules
+  # ---------------------------------------------------------------------------
+
+  protocol-https-only:
+    description: "ALL requests MUST go through `https` protocol only"
+    formats:
+      - oas2
+    recommended: true
+    severity: error
+    type: "style"
+    message: "Schemes MUST be https and no other value is allowed."
+    given: $
+    then:
+      field: schemes
+      function: schema
+      functionOptions:
+        schema:
+          type: array
+          items:
+            type: string
+            enum: ["https"]
+          maxItems: 1
+
+  request-support-json:
+    description: Every request SHOULD support `application/json` media type
+    formats:
+      - oas2
+    severity: warn
+    message: "{{description}}: {{error}}"
+    recommended: true
+    given: "$..consumes"
+    then:
+      function: schema
+      functionOptions:
+        schema:
+          type: array
+          contains:
+            type: string
+            enum:
+              - application/json
+
+  example-exists-in-parameters:
+    description: All models MUST have a valid example.
+    severity: error
+    recommended: true
+    formats:
+      - oas2
+    message: "{{ property }} MUST have a valid example."
+    given: "$..parameters..[?(@.in == 'body' && (@.example || @.schema.$ref))]"
+    then: 
+      function: truthy
+
+  # example-exists-in-definitions:
+  #   description: All models MUST have a valid example.
+  #   severity: error
+  #   recommended: true
+  #   formats:
+  #     - oas2
+  #   message: "{{ property }} MUST have a valid example."
+  #   given: "$..definitions..[?(!@.example || !@..$ref)]"
+  #   then:
+  #     function: falsy
+  # "$..parameters..[?(@.in == 'body')]..[?(@property !== 'properties' && @.example && ( @.type || @.format || @.$ref ))]"
+
+  response-success-hal: # schemes and/or produces
+    description: "All success responses MUST be of media type `application/hal+json`"
+    severity: error
+    given: $.paths..responses[?( @property >= 200 && @property < 300 && @property != 204)]
+    recommended: true
+    type: "style"
+    formats:
+      - oas2
+    message: "Response documents MUST follow application/hal+json: {{error}}"
+    then:
+      field: schema
+      function: schema
+      functionOptions:
+        schema:
+          $ref: "./supermodel/adidas/api/HAL.yaml"
+
+  response-error-problem: # schemas and/or produces
+    description: All error responses MUST be of media type `application/problem+json`
+    severity: error
+    formats:
+      - oas2
+    given: $.paths..responses[?( @property >= 400 && @property < 600 )]
+    recommended: true
+    type: "style"
+    message: "Error response document MUST follow application/problem+json: {{error}}"
+    then:
+      field: schema.example
+      function: schema
+      functionOptions:
+        schema:
+          $ref: "./supermodel/adidas/api/ProblemDetail.yaml"
+
+  # ---------------------------------------------------------------------------
+  # Only OAS3 rules
+  # ---------------------------------------------------------------------------
+
+  request-support-json-oas3:
+    description: Every request MUST support `application/json` media type
+    formats:
+      - oas3
+    recommended: true
+    severity: error
+    message: "{{description}}: {{error}}"
+    given: $.paths.[*].requestBody.content[?(@property.indexOf('json') === -1)]^
+    then:
+      function: falsy
+
+  valid-example-in-parameters:
+    description: Examples must be valid against their defined schema.
+    message: "{{error}}"
+    recommended: true
+    formats:
+      - oas3
+    severity: 0
+    type: validation
+    given: "$..parameters..[?(@.in == 'body')]..[?(@property !== 'properties' && @.example
+      && ( @.type || @.format || @.$ref ))]"
+    then:
+      function: schemaPath
+      functionOptions:
+        field: example
+        schemaPath: "$"
+
+  valid-example-in-definitions:
+    description: Examples must be valid against their defined schema.
+    message: "{{error}}"
+    recommended: true
+    formats:
+      - oas3
+    severity: 0
+    type: validation
+    given: "$..definitions..[?(@property !== 'properties' && @.example && (@.type ||
+      @.format || @.$ref))]"
+    then:
+      function: schemaPath
+      functionOptions:
+        field: example
+        schemaPath: "$"
+
+  protocol-https-only-oas3: # checks how does the servers array values start
+    description: "ALL requests MUST go through `https` protocol only"
+    formats:
+      - oas3
+    recommended: true
+    severity: error
+    message: "Servers MUST be https and no other protocol is allowed."
+    given: $.servers..url
+    then:
+      function: pattern
+      functionOptions:
+        match: "/^https:/"
+
+  response-success-hal-oas3:
+    description: "All success responses MUST be of media type `application/hal+json`"
+    severity: error
+    given: $.paths..responses[?( @property >= 200 && @property < 300 && @property != 204)].content[*]~
+    recommended: true
+    # type: "style"
+    formats:
+      - oas3
+    message: "Response documents MUST be of application/hal+json media type: {{error}}"
+    then:
+      function: enumeration
+      functionOptions:
+        values:
+          - application/hal+json
+          
+  response-success-hal-body-oas3: # schemes and/or produces
+    description: "All success responses MUST follow `application/hal+json` schema"
+    severity: error
+    given: $.paths..responses[?( @property >= 200 && @property < 300 && @property != 204)].content[?(@property === "application/hal+json")]
+    recommended: true
+    type: "style"
+    formats:
+      - oas3
+    message: "Response documents MUST follow application/hal+json schema: {{error}}"
+    then:
+      field: schema
+      function: schema
+      functionOptions:
+        schema:
+          $ref: "./supermodel/adidas/api/HAL.yaml"
+    
+
+  # ---------------------------------------------------------------------------
+  # Not implemented
+  # ---------------------------------------------------------------------------
+
+  # ---------------------------------------------------------------------------
+  # Other rules which are redundant or not feasible
+  # ---------------------------------------------------------------------------
+
+  # fields-date-iso8601:
+  #   description: Date and time MUST follow [`ISO 8601` standard](https://www.iso.org/iso-8601-date-and-time-format.html)
+  #   severity: error
+  # fields-language-iso639:
+  #   description: Language codes MUST follow [`ISO 639` standard](https://www.iso.org/iso-639-language-codes.html)
+  #   severity: error
+  # fields-country-iso3166:
+  #   description: Country codes MUST follow [`ISO 3166 alpha-2` standard](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)
+  #   severity: error
+  # fields-currency-iso4217:
+  #   description: Currency codes MUST follow [`ISO 4217` standard](https://en.wikipedia.org/wiki/ISO_4217)
+  #   severity: error
+  # response-303-async-link-header:
+  #   description: A successful and finished async api request returns `303` response code and sends the target resource location in the `Link` header
+  #   severity: hint
--- a/README.md
+++ b/README.md
@@ -41,9 +41,27 @@ The CAPITALIZED words throughout these guidelines have a special meaning:

 Refer to [RFC2119](https://www.ietf.org/rfc/rfc2119) for details.

+### Validating your API Guidelines against OpenAPI Specification
+
+In the `ruleset.md` file you can find a digest of API Guidelines rules which you can validating your API description documents with. If you are using OpenAPI Specification as the API description format you can also leverage the `spectral.yaml` ruleset to automatically verify your specification compliance using [Spectral](github.com/stoplightio/spectral).
+
+To install Spectral you will need Node.js and a package manager (npm or yarn).
+
+```
+npm install -g @stoplight/spectral
+
+# OR
+
+yarn global add @stoplight/spectral
+```
+
+Once installed, to verify your OAS file with spectral execute `spectral lint PATH_TO_YOUR_OAS -r spectral.yml`
+
+For further documentation on Spectral refer to their [documentation](https://stoplight.io/p/docs/gh/stoplightio/spectral/README.md).
+
 ### Questions & Comments

-_Please contact_ [_Zdenek.Nemec@externals.adidas-group.com_](mailto:Zdenek.Nemec@externals.adidas-group.com) or [_andrzej.jarzyna@adidas.com_](mailto:andrzej.jarzyna@adidas.com) _in the case of questions._
+_Please contact_ [_Zdenek.Nemec@externals.adidas-group.com_](mailto:Zdenek.Nemec@externals.adidas-group.com), [_andrzej.jarzyna@adidas.com_](mailto:andrzej.jarzyna@adidas.com) or [_samir.amzani@adidas.com_](mailto:samir.amzani@adidas.com) _in case of questions._

 ## Intended Use Cases

--- a/acknowledgements.md
+++ b/acknowledgements.md
@@ -12,6 +12,4 @@ This work is partly based on the work of many talented individuals and exception
 * [Zalando API Team](http://zalando.github.io/restful-api-guidelines)
 * [Facebook Graph API Team](https://developers.facebook.com/docs/graph-api/)
 * [Subbu Allamaraju: RESTFul Web Services Cookbook](http://shop.oreilly.com/product/9780596801694.do)
-* [Paolo De Lucia](https://www.linkedin.com/in/paolodelucia/)
-
-
+* [Paolo De Lucia](https://www.linkedin.com/in/paolodelucia/)
--- a/examples/invalid/api-with-examples.oas3.yaml
+++ b/examples/invalid/api-with-examples.oas3.yaml
@@ -0,0 +1,167 @@
+openapi: "3.0.0"
+info:
+  title: Simple API overview
+  version: 2.0.0
+paths:
+  /:
+    get:
+      operationId: listVersionsv2
+      summary: List API versions
+      responses:
+        '200':
+          description: |-
+            200 response
+          content:
+            application/json:
+              examples: 
+                foo:
+                  value: {
+                    "versions": [
+                        {
+                            "status": "CURRENT",
+                            "updated": "2011-01-21T11:33:21Z",
+                            "id": "v2.0",
+                            "links": [
+                                {
+                                    "href": "http://127.0.0.1:8774/v2/",
+                                    "rel": "self"
+                                }
+                            ]
+                        },
+                        {
+                            "status": "EXPERIMENTAL",
+                            "updated": "2013-07-23T11:33:21Z",
+                            "id": "v3.0",
+                            "links": [
+                                {
+                                    "href": "http://127.0.0.1:8774/v3/",
+                                    "rel": "self"
+                                }
+                            ]
+                        }
+                    ]
+                 }
+        '300':
+          description: |-
+            300 response
+          content:
+            application/json: 
+              examples: 
+                foo:
+                  value: |
+                   {
+                    "versions": [
+                          {
+                            "status": "CURRENT",
+                            "updated": "2011-01-21T11:33:21Z",
+                            "id": "v2.0",
+                            "links": [
+                                {
+                                    "href": "http://127.0.0.1:8774/v2/",
+                                    "rel": "self"
+                                }
+                            ]
+                        },
+                        {
+                            "status": "EXPERIMENTAL",
+                            "updated": "2013-07-23T11:33:21Z",
+                            "id": "v3.0",
+                            "links": [
+                                {
+                                    "href": "http://127.0.0.1:8774/v3/",
+                                    "rel": "self"
+                                }
+                            ]
+                        }
+                    ]
+                   }
+  /v2:
+    get:
+      operationId: getVersionDetailsv2
+      summary: Show API version details
+      responses:
+        '200':
+          description: |-
+            200 response
+          content:
+            application/json: 
+              examples:
+                foo:
+                  value: {
+                    "version": {
+                      "status": "CURRENT",
+                      "updated": "2011-01-21T11:33:21Z",
+                      "media-types": [
+                          {
+                              "base": "application/xml",
+                              "type": "application/vnd.openstack.compute+xml;version=2"
+                          },
+                          {
+                              "base": "application/json",
+                              "type": "application/vnd.openstack.compute+json;version=2"
+                          }
+                      ],
+                      "id": "v2.0",
+                      "links": [
+                          {
+                              "href": "http://127.0.0.1:8774/v2/",
+                              "rel": "self"
+                          },
+                          {
+                              "href": "http://docs.openstack.org/api/openstack-compute/2/os-compute-devguide-2.pdf",
+                              "type": "application/pdf",
+                              "rel": "describedby"
+                          },
+                          {
+                              "href": "http://docs.openstack.org/api/openstack-compute/2/wadl/os-compute-2.wadl",
+                              "type": "application/vnd.sun.wadl+xml",
+                              "rel": "describedby"
+                          },
+                          {
+                            "href": "http://docs.openstack.org/api/openstack-compute/2/wadl/os-compute-2.wadl",
+                            "type": "application/vnd.sun.wadl+xml",
+                            "rel": "describedby"
+                          }
+                      ]
+                    }
+                  }
+        '203':
+          description: |-
+            203 response
+          content:
+            application/json: 
+              examples:
+                foo:
+                  value: {
+                    "version": {
+                      "status": "CURRENT",
+                      "updated": "2011-01-21T11:33:21Z",
+                      "media-types": [
+                          {
+                              "base": "application/xml",
+                              "type": "application/vnd.openstack.compute+xml;version=2"
+                          },
+                          {
+                              "base": "application/json",
+                              "type": "application/vnd.openstack.compute+json;version=2"
+                          }
+                      ],
+                      "id": "v2.0",
+                      "links": [
+                          {
+                              "href": "http://23.253.228.211:8774/v2/",
+                              "rel": "self"
+                          },
+                          {
+                              "href": "http://docs.openstack.org/api/openstack-compute/2/os-compute-devguide-2.pdf",
+                              "type": "application/pdf",
+                              "rel": "describedby"
+                          },
+                          {
+                              "href": "http://docs.openstack.org/api/openstack-compute/2/wadl/os-compute-2.wadl",
+                              "type": "application/vnd.sun.wadl+xml",
+                              "rel": "describedby"
+                          }
+                      ]
+                    }
+                  }
--- a/examples/invalid/link-example.oas3.yaml
+++ b/examples/invalid/link-example.oas3.yaml
@@ -0,0 +1,203 @@
+openapi: 3.0.0
+info: 
+  title: Link Example
+  version: 1.0.0
+paths: 
+  /2.0/users/{username}: 
+    get: 
+      operationId: getUserByName
+      parameters: 
+      - name: username
+        in: path
+        required: true
+        schema:
+          type: string
+      responses: 
+        '200':
+          description: The User
+          content:
+            application/json:
+              schema: 
+                $ref: '#/components/schemas/user'
+          links:
+            userRepositories:
+              $ref: '#/components/links/UserRepositories'
+  /2.0/repositories/{username}:
+    get:
+      operationId: getRepositoriesByOwner
+      parameters:
+        - name: username
+          in: path
+          required: true
+          schema:
+            type: string
+      responses:
+        '200':
+          description: repositories owned by the supplied user
+          content: 
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: '#/components/schemas/repository'
+          links:
+            userRepository:
+              $ref: '#/components/links/UserRepository'
+  /2.0/repositories/{username}/{slug}: 
+    get: 
+      operationId: getRepository
+      parameters: 
+        - name: username
+          in: path
+          required: true
+          schema:
+            type: string
+        - name: slug
+          in: path
+          required: true
+          schema:
+            type: string
+      responses: 
+        '200':
+          description: The repository
+          content:
+              application/json: 
+                schema: 
+                  $ref: '#/components/schemas/repository'
+          links:
+            repositoryPullRequests:
+              $ref: '#/components/links/RepositoryPullRequests'
+  /2.0/repositories/{username}/{slug}/pullrequests: 
+    get: 
+      operationId: getPullRequestsByRepository
+      parameters: 
+      - name: username
+        in: path
+        required: true
+        schema:
+          type: string
+      - name: slug
+        in: path
+        required: true
+        schema:
+          type: string
+      - name: state
+        in: query
+        schema:
+          type: string
+          enum: 
+            - open
+            - merged
+            - declined
+      responses: 
+        '200':
+          description: an array of pull request objects
+          content:
+            application/json: 
+              schema: 
+                type: array
+                items: 
+                  $ref: '#/components/schemas/pullrequest'
+  /2.0/repositories/{username}/{slug}/pullrequests/{pid}: 
+    get: 
+      operationId: getPullRequestsById
+      parameters: 
+      - name: username
+        in: path
+        required: true
+        schema:
+          type: string
+      - name: slug
+        in: path
+        required: true
+        schema:
+          type: string
+      - name: pid
+        in: path
+        required: true
+        schema:
+          type: string
+      responses: 
+        '200':
+          description: a pull request object
+          content:
+            application/json: 
+              schema: 
+                $ref: '#/components/schemas/pullrequest'
+          links:
+            pullRequestMerge:
+              $ref: '#/components/links/PullRequestMerge'
+  /2.0/repositories/{username}/{slug}/pullrequests/{pid}/merge: 
+    post: 
+      operationId: mergePullRequest
+      parameters: 
+      - name: username
+        in: path
+        required: true
+        schema:
+          type: string
+      - name: slug
+        in: path
+        required: true
+        schema:
+          type: string
+      - name: pid
+        in: path
+        required: true
+        schema:
+          type: string
+      responses: 
+        '204':
+          description: the PR was successfully merged
+components:
+  links:
+    UserRepositories:
+      # returns array of '#/components/schemas/repository'
+      operationId: getRepositoriesByOwner
+      parameters:
+        username: $response.body#/username
+    UserRepository:
+      # returns '#/components/schemas/repository'
+      operationId: getRepository
+      parameters:
+        username: $response.body#/owner/username
+        slug: $response.body#/slug
+    RepositoryPullRequests:
+      # returns '#/components/schemas/pullrequest'
+      operationId: getPullRequestsByRepository
+      parameters: 
+          username: $response.body#/owner/username
+          slug: $response.body#/slug
+    PullRequestMerge:
+      # executes /2.0/repositories/{username}/{slug}/pullrequests/{pid}/merge
+      operationId: mergePullRequest
+      parameters:
+        username: $response.body#/author/username
+        slug: $response.body#/repository/slug
+        pid: $response.body#/id
+  schemas: 
+    user: 
+      type: object
+      properties: 
+        username: 
+          type: string
+        uuid: 
+          type: string
+    repository: 
+      type: object
+      properties: 
+        slug: 
+          type: string
+        owner: 
+          $ref: '#/components/schemas/user'
+    pullrequest: 
+      type: object
+      properties: 
+        id: 
+          type: integer
+        title: 
+          type: string
+        repository: 
+          $ref: '#/components/schemas/repository'
+        author: 
+          $ref: '#/components/schemas/user'
--- a/examples/invalid/petstore-expanded.oas3.yaml
+++ b/examples/invalid/petstore-expanded.oas3.yaml
@@ -0,0 +1,158 @@
+openapi: "3.0.0"
+info:
+  version: 1.0.0
+  title: Swagger Petstore
+  description: A sample API that uses a petstore as an example to demonstrate features in the OpenAPI 3.0 specification
+  termsOfService: http://swagger.io/terms/
+  contact:
+    name: Swagger API Team
+    email: apiteam@swagger.io
+    url: http://swagger.io
+  license:
+    name: Apache 2.0
+    url: https://www.apache.org/licenses/LICENSE-2.0.html
+servers:
+  - url: http://petstore.swagger.io/api
+paths:
+  /pets:
+    get:
+      description: |
+        Returns all pets from the system that the user has access to
+        Nam sed condimentum est. Maecenas tempor sagittis sapien, nec rhoncus sem sagittis sit amet. Aenean at gravida augue, ac iaculis sem. Curabitur odio lorem, ornare eget elementum nec, cursus id lectus. Duis mi turpis, pulvinar ac eros ac, tincidunt varius justo. In hac habitasse platea dictumst. Integer at adipiscing ante, a sagittis ligula. Aenean pharetra tempor ante molestie imperdiet. Vivamus id aliquam diam. Cras quis velit non tortor eleifend sagittis. Praesent at enim pharetra urna volutpat venenatis eget eget mauris. In eleifend fermentum facilisis. Praesent enim enim, gravida ac sodales sed, placerat id erat. Suspendisse lacus dolor, consectetur non augue vel, vehicula interdum libero. Morbi euismod sagittis libero sed lacinia.
+
+        Sed tempus felis lobortis leo pulvinar rutrum. Nam mattis velit nisl, eu condimentum ligula luctus nec. Phasellus semper velit eget aliquet faucibus. In a mattis elit. Phasellus vel urna viverra, condimentum lorem id, rhoncus nibh. Ut pellentesque posuere elementum. Sed a varius odio. Morbi rhoncus ligula libero, vel eleifend nunc tristique vitae. Fusce et sem dui. Aenean nec scelerisque tortor. Fusce malesuada accumsan magna vel tempus. Quisque mollis felis eu dolor tristique, sit amet auctor felis gravida. Sed libero lorem, molestie sed nisl in, accumsan tempor nisi. Fusce sollicitudin massa ut lacinia mattis. Sed vel eleifend lorem. Pellentesque vitae felis pretium, pulvinar elit eu, euismod sapien.
+      operationId: findPets
+      parameters:
+        - name: tags
+          in: query
+          description: tags to filter by
+          required: false
+          style: form
+          schema:
+            type: array
+            items:
+              type: string
+        - name: limit
+          in: query
+          description: maximum number of results to return
+          required: false
+          schema:
+            type: integer
+            format: int32
+      responses:
+        '200':
+          description: pet response
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: '#/components/schemas/Pet'
+        default:
+          description: unexpected error
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Error'
+    post:
+      description: Creates a new pet in the store.  Duplicates are allowed
+      operationId: addPet
+      requestBody:
+        description: Pet to add to the store
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/NewPet'
+      responses:
+        '200':
+          description: pet response
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Pet'
+        default:
+          description: unexpected error
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Error'
+  /pets/{id}:
+    get:
+      description: Returns a user based on a single ID, if the user does not have access to the pet
+      operationId: find pet by id
+      parameters:
+        - name: id
+          in: path
+          description: ID of pet to fetch
+          required: true
+          schema:
+            type: integer
+            format: int64
+      responses:
+        '200':
+          description: pet response
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Pet'
+        default:
+          description: unexpected error
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Error'
+    delete:
+      description: deletes a single pet based on the ID supplied
+      operationId: deletePet
+      parameters:
+        - name: id
+          in: path
+          description: ID of pet to delete
+          required: true
+          schema:
+            type: integer
+            format: int64
+      responses:
+        '204':
+          description: pet deleted
+        default:
+          description: unexpected error
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Error'
+components:
+  schemas:
+    Pet:
+      allOf:
+        - $ref: '#/components/schemas/NewPet'
+        - type: object
+          required:
+          - id
+          properties:
+            id:
+              type: integer
+              format: int64
+
+    NewPet:
+      type: object
+      required:
+        - name  
+      properties:
+        name:
+          type: string
+        tag:
+          type: string    
+
+    Error:
+      type: object
+      required:
+        - code
+        - message
+      properties:
+        code:
+          type: integer
+          format: int32
+        message:
+          type: string
--- a/examples/valid/demo-orderapi-v3.oas2.yaml
+++ b/examples/valid/demo-orderapi-v3.oas2.yaml
@@ -0,0 +1,368 @@
+swagger: '2.0'
+info:
+  version: '3.0.0'
+  title: '[Demo] Orders API'
+  contact: 
+    name: Z
+    email: "z@goodapi.co"
+  description: |
+    Sample API conforming to [adidas API Guidelines](https://adidas.gitbook.io/api-guidelines/).
+    
+    This API is [documented at Apiary](http://docs.demotemplate.apiary.io)
+    and stored on GitHub.
+
+produces:
+  - application/hal+json      # Representation message format
+  - application/problem+json  # Error message format
+
+schemes:
+  - https
+
+host: "example.com"
+
+securityDefinitions:
+   'API Key':
+     type: apiKey
+     in: header
+     name: x-api-key
+
+security:
+  - "API Key": []
+
+paths:
+  /:
+    x-summary: API Root
+
+    get:
+      summary: Retrieve API Root
+      description: The API Root contains the initial set of link relations.
+      responses:
+        200:
+          description: The root of the API
+          schema:
+            allOf:
+              - $ref: '#/definitions/supermodelIoAdidasApiHAL'
+            example:
+              _links:
+                self:
+                  href: /
+                orders:
+                  href: /orders
+
+  /orders:
+    x-summary: List of Orders
+
+    get:
+      summary: Retrieve List of Orders
+      description: Retrieves a list of orders with pagination.
+      parameters:
+        - $ref: '#/parameters/offset'
+        - $ref: '#/parameters/limit'
+      responses:
+        200:
+          description: The list of Orders
+          schema:
+            $ref: '#/definitions/supermodelIoAdidasExamplesOrderApiOrders'
+
+    post:
+      summary: Create a New Order
+      description: Creates a new order.
+      consumes:
+        - application/json
+      parameters:
+        - name: Order
+          in: body
+          description: Order to be created
+          required: true
+          schema:
+            $ref: '#/definitions/supermodelIoAdidasExamplesOrderOrder'
+      responses:
+        201:
+          description: Newly created order
+          schema:
+            $ref: '#/definitions/supermodelIoAdidasExamplesOrderApiOrder'
+
+  /orders/{orderId}:
+    x-summary: Order
+
+    parameters:
+      - name: orderId
+        in: path
+        description: Id of the Order
+        required: true
+        type: string
+        x-example: '1234'
+
+    get:
+      summary: Retrieve Order
+      description: Retrieves an order with specified fields.
+      parameters:
+        - $ref: '#/parameters/fields'
+      responses:
+        200:
+          description: A particular Order
+          schema:
+            $ref: '#/definitions/supermodelIoAdidasExamplesOrderApiOrder'
+        404:
+          description: The request Order wasn't found
+          headers:
+            Content-Type:
+              type: string
+              default: application/problem+json
+          schema:
+            allOf:
+              - $ref: '#/definitions/supermodelIoAdidasApiProblemDetail'
+            example:
+              title: 'Not Found'
+              detail: 'Cannot find the requested order'
+              status: 404
+              instance: '/orders/1234'
+
+    patch:
+      summary: Update Order
+      description: Does a partial update of an order.
+      consumes:
+        - application/json
+      parameters:
+        - name: Order
+          in: body
+          description: Partial order update
+          required: true
+          schema:
+            $ref: '#/definitions/supermodelIoAdidasExamplesOrderApiOrderPatch'
+      responses:
+        200:
+          description: The Order was updated
+          schema:
+            $ref: '#/definitions/supermodelIoAdidasExamplesOrderApiOrder'
+
+    delete:
+      summary: Delete Order
+      description: Deletes an order without returning its instance.
+      produces: []
+      responses:
+        204:
+          description: The Order was deleted
+
+parameters:
+  # adidas API guidelines: Pagination
+  offset:
+    name: offset
+    in: query
+    description: Number of results to skip from the start of the list
+    required: false
+    type: string
+    default: '0'
+    x-example: '10'
+
+  # adidas API guidelines: Pagination
+  limit:
+    name: limit
+    in: query
+    description: The maximum number of reusults to return
+    required: false
+    type: string
+    default: '10'
+    x-example: '5'
+
+  # adidas API guidelines: Sparse fieldset
+  fields:
+    name: fields
+    in: query
+    description: Comma-separated list of fields to include in the response
+    required: false
+    type: array
+    items:
+      type: string
+    collectionFormat: csv
+    x-example:
+      - articleNumber
+      - modelNumber
+
+  # adidas API guidelines: Sparse fieldset
+  embedded:
+    name: embedded
+    in: query
+    description: Comma-separated list of resource (relations) to embed in the response
+    required: false
+    type: array
+    items:
+      type: string
+    collectionFormat: csv
+    x-example:
+      - prices
+      - assets
+
+# DO NOT EDIT
+# This definitions section is automatically generated by supermodel.io
+#
+# http://supermodel.io
+# https://github.com/supermodel/supermodel-cli
+definitions:
+  supermodelIoAdidasExamplesOrderApiOrder:
+    title: Order HAL Representation
+    type: object
+    allOf:
+      - $ref: '#/definitions/supermodelIoAdidasApiHAL'
+      - $ref: '#/definitions/supermodelIoAdidasExamplesOrderOrder'
+    example:
+      _links:
+        self:
+          href: /orders/1234
+        edit:
+          href: /orders/1234
+        delete:
+          href: /orders/1234
+        profile:
+          href: 'https://adidas-group.com/gdm/OMS'
+      orderNumber: 1234
+      itemCount: 42
+      status: pending
+  supermodelIoAdidasExamplesOrderApiOrderPatch:
+    title: OrderPatch
+    description: OrderPatch model description
+    type: object
+    allOf:
+      - $ref: '#/definitions/supermodelIoAdidasExamplesOrderOrder'
+    example:
+      status: cancelled
+      orderNumber: 1
+      itemCount: 2
+  supermodelIoAdidasExamplesOrderApiOrders:
+    title: Collection of Orders HAL Representation
+    type: object
+    allOf:
+      - $ref: '#/definitions/supermodelIoAdidasApiHAL'
+    example:
+      _links:
+        self:
+          href: /orders
+        create:
+          href: /orders
+        next:
+          href: /orders?offset=5&limit=5
+        first:
+          href: /orders?offset=0&limit=5
+        last:
+          href: /orders?offset=40&limit=5
+      _embedded:
+        order:
+          - _links:
+              self:
+                href: /orders/1234
+              edit:
+                href: /orders/1234
+              delete:
+                href: /orders/1234
+              profile:
+                href: 'https://adidas-group.com/gdm/OMS'
+            orderNumber: 1234
+            itemCount: 42
+            status: pending
+  supermodelIoAdidasExamplesOrderApiProblemDetail:
+    title: Problem Detail
+    type: object
+    allOf:
+      - $ref: '#/definitions/supermodelIoAdidasApiProblemDetail'
+  supermodelIoAdidasApiHAL:
+    title: HAL
+    description: >-
+      JSON Hypertext Application Language. Definition of [HAL message
+      format](https://tools.ietf.org/html/draft-kelly-json-hal-08)
+    type: object
+    properties:
+      _links:
+        type: object
+        additionalProperties:
+          allOf:
+            - $ref: '#/definitions/supermodelIoAdidasApiHALDefinitionsHalLinkObject'
+            - type: array
+              items:
+                $ref: '#/definitions/supermodelIoAdidasApiHALDefinitionsHalLinkObject'
+        properties:
+          curies:
+            allOf:
+              - $ref: '#/definitions/supermodelIoAdidasApiHALDefinitionsHalCuriesLink'
+              - type: array
+                items:
+                  $ref: >-
+                    #/definitions/supermodelIoAdidasApiHALDefinitionsHalCuriesLink
+      _embedded:
+        type: object
+        additionalProperties:
+          allOf:
+            - $ref: '#/definitions/supermodelIoAdidasApiHAL'
+            - type: array
+              items:
+                $ref: '#/definitions/supermodelIoAdidasApiHAL'
+  supermodelIoAdidasApiHALDefinitionsHalLinkObject:
+    title: HAL Link Object
+    type: object
+    properties:
+      href:
+        type: string
+      templated:
+        type: boolean
+      type:
+        type: string
+      deprecation:
+        type: string
+      name:
+        type: string
+      profile:
+        type: string
+      title:
+        type: string
+      hreflang:
+        type: string
+    required:
+      - href
+  supermodelIoAdidasApiHALDefinitionsHalCuriesLink:
+    title: HAL Curies Link
+    allOf:
+      - type: object
+        properties:
+          templated:
+            enum:
+              - true
+        required:
+          - templated
+      - $ref: '#/definitions/supermodelIoAdidasApiHALDefinitionsHalLinkObject'
+  supermodelIoAdidasExamplesOrderOrder:
+    title: Order
+    type: object
+    description: Order model description
+    properties:
+      orderNumber:
+        type: number
+      itemCount:
+        type: number
+      status:
+        type: string
+    required:
+      - orderNumber
+      - itemCount
+    example:
+      orderNumber: 42
+      itemCount: 3
+      status: pending
+  supermodelIoAdidasApiProblemDetail:
+    title: Problem Details for HTTP APIs
+    description: >-
+      Definition of [RFC7807](https://tools.ietf.org/html/rfc7807) problem
+      detail
+    type: object
+    properties:
+      type:
+        type: string
+      title:
+        type: string
+      status:
+        type: number
+      detail:
+        type: string
+      instance:
+        type: string
+    required:
+      - title
+      - detail
--- a/package.json
+++ b/package.json
@@ -0,0 +1,17 @@
+{
+  "name": "api-guidelines",
+  "version": "1.0.0",
+  "description": "adidas API guidelines",
+  "repository": "git@github.com:adidas/api-guidelines.git",
+  "author": "software.engineering@adidas.com",
+  "license": "MIT",
+  "private": true,
+  "dependencies": {
+    "@stoplight/spectral": "^4.2.0",
+    "@supermodel/cli": "^0.46.29"
+  },
+  "scripts": {
+    "build-examples": "supermodel schema oas2 supermodel/adidas/examples/order/api/ -o examples/demo-orderapi-v3.oas2.yaml",
+    "test": "spectral lint examples/valid/*"
+  }
+}
--- a/ruleset.md
+++ b/ruleset.md
@@ -20,4 +20,4 @@
 - a successful and finished async api request returns `303` response code and sends the target resource location in the `Link` header
 - `URI` template ([RFC 6570](https://tools.ietf.org/html/rfc6570)) cannot contain a `-` character
 - `HTTP` headers MUST use `Hyphenated-Pascal-Case` notation
- `HTTP` headers SHOULD NOT include `X-` headers (https://tools.ietf.org/html/rfc6648). All non-standard headers are named without the `X-` prefix.
+- `HTTP` headers SHOULD NOT include [`X-` headers](2). All non-standard headers are named without the `X-` prefix.
--- a/supermodel/.super
+++ b/supermodel/.super
@@ -0,0 +1,3 @@
+{
+  "host": "https://supermodel.io"
+}
--- a/supermodel/adidas/api/HAL.yaml
+++ b/supermodel/adidas/api/HAL.yaml
@@ -0,0 +1,63 @@
+$id: http://supermodel.io/adidas/api/HAL
+$schema: http://json-schema.org/draft-07/schema#
+title: HAL
+description: JSON Hypertext Application Language. Definition of [HAL message format](https://tools.ietf.org/html/draft-kelly-json-hal-08)
+type: object
+properties:
+  _links:
+    type: object
+    additionalProperties:
+      anyOf:
+      - $ref: '#/definitions/halLinkObject'
+      - type: array
+        items:
+          - $ref: '#/definitions/halLinkObject'
+    properties:
+      curies:
+        anyOf:
+          - $ref: '#/definitions/halCuriesLink'
+          - type: array
+            items:
+              - $ref: '#/definitions/halCuriesLink'
+  _embedded:
+    type: object
+    additionalProperties:
+      anyOf:
+        - $ref: '#'
+        - type: array
+          items:
+            - $ref: '#'
+definitions:
+  halLinkObject:
+    title: HAL Link Object
+    type: object
+    properties:
+      href:
+        type: string
+      templated:
+        type: boolean
+      type:
+       type: string
+      deprecation:
+        type: string
+      name:
+        type: string
+      profile:
+        type: string
+      title:
+        type: string
+      hreflang:
+        type: string
+    required:
+      - href
+  halCuriesLink:
+    title: HAL Curies Link
+    allOf:
+      - type: object
+        properties:
+          templated:
+            enum:
+              - true
+        required:
+          - templated
+      - $ref: '#/definitions/halLinkObject'
--- a/supermodel/adidas/api/ProblemDetail.yaml
+++ b/supermodel/adidas/api/ProblemDetail.yaml
@@ -0,0 +1,19 @@
+$id: http://supermodel.io/adidas/api/ProblemDetail
+$schema: http://json-schema.org/draft-07/schema#
+title: Problem Details for HTTP APIs
+description: Definition of [RFC7807](https://tools.ietf.org/html/rfc7807) problem detail
+type: object
+properties:
+  type:
+    type: string
+  title:
+    type: string
+  status:
+    type: number
+  detail:
+    type: string
+  instance:
+    type: string
+required:
+  - title
+  - detail
--- a/supermodel/adidas/examples/order/Order.yaml
+++ b/supermodel/adidas/examples/order/Order.yaml
@@ -0,0 +1,22 @@
+$id: http://supermodel.io/adidas/examples/order/Order
+$schema: http://json-schema.org/draft-07/schema#
+
+title: Order
+type: object
+description: Order model description
+
+properties:
+  orderNumber:
+    type: number
+  itemCount:
+    type: number
+  status:
+    type: string
+required:
+  - orderNumber
+  - itemCount
+examples:
+- orderNumber: 42
+  itemCount: 3
+  status: pending
+ 
--- a/supermodel/adidas/examples/order/api/Order.yaml
+++ b/supermodel/adidas/examples/order/api/Order.yaml
@@ -0,0 +1,23 @@
+$id: http://supermodel.io/adidas/examples/order/api/Order
+$schema: http://json-schema.org/draft-07/schema#
+
+title: Order HAL Representation
+type: object
+
+allOf:
+  - $ref: http://supermodel.io/adidas/api/HAL
+  - $ref: http://supermodel.io/adidas/examples/order/Order
+  
+examples:
+- _links:
+    self:
+      href: /orders/1234
+    edit:
+      href: /orders/1234
+    delete:
+      href: /orders/1234
+    profile:
+      href: https://adidas-group.com/gdm/OMS
+  orderNumber: 1234
+  itemCount: 42
+  status: pending
--- a/supermodel/adidas/examples/order/api/OrderPatch.yaml
+++ b/supermodel/adidas/examples/order/api/OrderPatch.yaml
@@ -0,0 +1,14 @@
+$id: http://supermodel.io/adidas/examples/order/api/OrderPatch
+$schema: http://json-schema.org/draft-07/schema#
+
+title: OrderPatch
+description: OrderPatch model description
+type: object
+
+allOf:
+  - $ref: 'http://supermodel.io/adidas/examples/order/Order'
+
+examples:
+- status: cancelled
+  orderNumber: 1
+  itemCount: 2
--- a/supermodel/adidas/examples/order/api/Orders.yaml
+++ b/supermodel/adidas/examples/order/api/Orders.yaml
@@ -0,0 +1,36 @@
+$id: http://supermodel.io/adidas/examples/order/api/Orders
+$schema: http://json-schema.org/draft-07/schema#
+
+title: Collection of Orders HAL Representation
+type: object
+
+allOf:
+  - $ref: http://supermodel.io/adidas/api/HAL
+  
+examples:
+- _links:
+    self:
+      href: /orders
+    create:
+      href: /orders
+    next:
+      href: /orders?offset=5&limit=5
+    first:
+      href: /orders?offset=0&limit=5
+    last:
+      href: /orders?offset=40&limit=5
+
+  _embedded:
+    order: 
+    - _links:
+        self:
+          href: /orders/1234
+        edit:
+          href: /orders/1234
+        delete:
+          href: /orders/1234
+        profile:
+          href: https://adidas-group.com/gdm/OMS
+      orderNumber: 1234
+      itemCount: 42
+      status: pending    
--- a/supermodel/adidas/examples/order/api/ProblemDetail.yaml
+++ b/supermodel/adidas/examples/order/api/ProblemDetail.yaml
@@ -0,0 +1,9 @@
+$id: http://supermodel.io/adidas/examples/order/api/ProblemDetail
+$schema: http://json-schema.org/draft-07/schema#
+
+title: Problem Detail
+type: object
+
+allOf:
+  - $ref: http://supermodel.io/adidas/api/ProblemDetail
+
--- a/yarn.lock
+++ b/yarn.lock