Add ticket security scheme definition

Add ticket security scheme definition

#%RAML 0.8
---
title: Example REST API
documentation:
  - title: Home
    content: |
      Welcome to the example API.
baseUri: http://{host}:{port}/{version}
version: v1
mediaType: application/json
protocols: [HTTP, HTTPS]
securedBy: [my_ticket_auth]

securitySchemes:
  my_ticket_auth:
    description: Standard Pyramid Auth Ticket policy
    type: x-Ticket
    settings:
      secret: auth_tkt_secret
      hashalg: sha512
      cookie_name: ramses_auth_tkt
      http_only: 'true'

/stories:
  displayName: Old stories
  get:
    description: Get all stories
  post:
    description: Add new story
    body:
      application/json:
        schema: !include schemas/story.json
  patch:
    description: Update multiple story
  delete:
    description: delete multiple story

  /{id}:
    displayName: One good story
    get:
      description: Get a particular story
    delete:
      description: Delete a particular story
    patch:
      description: Update a particular story

/users:
  securedBy: [auth_read]
  displayName: Good users
  get:
    description: Get all users
  post:
    description: Add new user
    body:
      application/json:
        schema: !include schemas/user.json

  /{username}:
    displayName: One good user
    get:
      description: Get a particular user
    patch:
      description: Update a particular story
    delete:
      description: Delete a particular story

    /settings:
      displayName: Old settings
      get:
        description: Get all settings
      post:
        description: Change settings

    /groups:
      displayName: Old groups
      get:
        description: Get all groups
      post:
        description: Change groups

    /profile:
      displayName: User profile
      get:
        description: Get user profile
      post:
        description: Create profile
        body:
          application/json:
            schema: !include schemas/profile.json
      put:
        description: Update profile

#%RAML 0.8
---
title: Example REST API
documentation:
  - title: Home
    content: |
      Welcome to the example API.
baseUri: http://{host}:{port}/{version}
version: v1
mediaType: application/json
protocols: [HTTP, HTTPS]

/stories:
  displayName: Old stories
  get:
    description: Get all stories
  post:
    description: Add new story
    body:
      application/json:
        schema: !include schemas/story.json
  patch:
    description: Update multiple story
  delete:
    description: delete multiple story

  /{id}:
    displayName: One good story
    get:
      description: Get a particular story
    delete:
      description: Delete a particular story
    patch:
      description: Update a particular story

/users:
  securedBy: [auth_read]
  displayName: Good users
  get:
    description: Get all users
  post:
    description: Add new user
    body:
      application/json:
        schema: !include schemas/user.json

  /{username}:
    displayName: One good user
    get:
      description: Get a particular user
    patch:
      description: Update a particular story
    delete:
      description: Delete a particular story

    /settings:
      displayName: Old settings
      get:
        description: Get all settings
      post:
        description: Change settings

    /groups:
      displayName: Old groups
      get:
        description: Get all groups
      post:
        description: Change groups

    /profile:
      displayName: User profile
      get:
        description: Get user profile
      post:
        description: Create profile
        body:
          application/json:
            schema: !include schemas/profile.json
      put:
        description: Update profile


Add missing pro word in api name

Add missing pro word in api name

#%RAML 0.8
---
title: Knapsack Pro
baseUri: http://api.knapsackpro.com/{version}
version: v1

/build_subsets:
  post:
    description: |
      Endpoint expects partial test suite execution data for particular test build.

      For instance send here data collected after execution half of test suite on the first CI node. Send here also data collected for the second half of the test suite executed on the second CI node.

      We will merge the data automatically to have complete information about particular build.

    queryParameters:
      test_suite_token:
        type: string
        required: true
        example: 4ae170d5806c331bfab123ca1adaadb3
        description: |
          Token for the particular test suite. __Token must be kept private.__

          For instance token for your RSpec test suite. If you have also test written in Cucumber then you will have separate token for Cucumber test suite.
      commit_hash:
        type: string
        required: true
        example: 6e3396177d9f8ca87e2b93b4b0a25babd09d574d
        description: |
          The most recent hash commit in your project.

          You are running tests on the codebase with latest commit pointed to the __commit_hash__.
      branch:
        type: string
        required: true
        example: master
        description: |
          You are running tests on this branch.
      node_total:
        type: integer
        required: true
        example: 4
        description: |
          Total number of CI nodes you have.

          For instance if you want to parallelize your test suite across 4 servers then __node_total__ is 4.
      node_index:
        type: integer
        required: true
        example: 0
        description: |
           Index of current CI node where part of the test suite where executed.

           __node_index__ starts from 0 so in case when __node_total__ is 4 then max __node_index__ is 3.
      test_files:
        type: string
        required: true
        example: |
          [
            {
              "path": "test/fast/a_test.rb",
              "time_execution": 0.2015
            },
            {
              "path": "test/fast/b_test.rb",
              "time_execution": 0.04
            },
            {
              "path": "test/slow/c_test.rb",
              "time_execution": 6.2120
            },
            {
              "path": "test/slow/d_test.rb",
              "time_execution": 4.3703
            }
          ]
        description: |
          JSON array with objects. Each object contains test file path and execution time for the test file.

          Example contains only part of the test suite. The part of tests was executed on the CI node for specified __node_index__.

    responses:
      201:
        body:
          application/json:
            example: Response does not contain any data.
      422:
        body:
          application/json:
            example: |
              // example 1
              {
                "errors": [
                  {
                    "branch": ["parameter is required"]
                  }
                ]
              }

              // example 2
              {
                "errors": [
                  {
                    "node_index": ["must be less than or equal to 1"],
                    "test_files": [
                      {
                        "0": {
                          "time_execution": ["is not a number"]
                        },
                        "1": {
                          "path": ["is too short (minimum is 3 characters)"]
                        }
                      }
                    ]
                  }
                ]
              }

#%RAML 0.8
---
title: Knapsack
baseUri: http://api.knapsackpro.com/{version}
version: v1

/build_subsets:
  post:
    description: |
      Endpoint expects partial test suite execution data for particular test build.

      For instance send here data collected after execution half of test suite on the first CI node. Send here also data collected for the second half of the test suite executed on the second CI node.

      We will merge the data automatically to have complete information about particular build.

    queryParameters:
      test_suite_token:
        type: string
        required: true
        example: 4ae170d5806c331bfab123ca1adaadb3
        description: |
          Token for the particular test suite. __Token must be kept private.__

          For instance token for your RSpec test suite. If you have also test written in Cucumber then you will have separate token for Cucumber test suite.
      commit_hash:
        type: string
        required: true
        example: 6e3396177d9f8ca87e2b93b4b0a25babd09d574d
        description: |
          The most recent hash commit in your project.

          You are running tests on the codebase with latest commit pointed to the __commit_hash__.
      branch:
        type: string
        required: true
        example: master
        description: |
          You are running tests on this branch.
      node_total:
        type: integer
        required: true
        example: 4
        description: |
          Total number of CI nodes you have.

          For instance if you want to parallelize your test suite across 4 servers then __node_total__ is 4.
      node_index:
        type: integer
        required: true
        example: 0
        description: |
           Index of current CI node where part of the test suite where executed.

           __node_index__ starts from 0 so in case when __node_total__ is 4 then max __node_index__ is 3.
      test_files:
        type: string
        required: true
        example: |
          [
            {
              "path": "test/fast/a_test.rb",
              "time_execution": 0.2015
            },
            {
              "path": "test/fast/b_test.rb",
              "time_execution": 0.04
            },
            {
              "path": "test/slow/c_test.rb",
              "time_execution": 6.2120
            },
            {
              "path": "test/slow/d_test.rb",
              "time_execution": 4.3703
            }
          ]
        description: |
          JSON array with objects. Each object contains test file path and execution time for the test file.

          Example contains only part of the test suite. The part of tests was executed on the CI node for specified __node_index__.

    responses:
      201:
        body:
          application/json:
            example: Response does not contain any data.
      422:
        body:
          application/json:
            example: |
              // example 1
              {
                "errors": [
                  {
                    "branch": ["parameter is required"]
                  }
                ]
              }

              // example 2
              {
                "errors": [
                  {
                    "node_index": ["must be less than or equal to 1"],
                    "test_files": [
                      {
                        "0": {
                          "time_execution": ["is not a number"]
                        },
                        "1": {
                          "path": ["is too short (minimum is 3 characters)"]
                        }
                      }
                    ]
                  }
                ]
              }