swagger_example.txt

swagger: '2.0'
info:
  title: Namely API
  description: Move your app forward with the Namely API
  version: "1.0"
host: <<company>>.namely.com
schemes:
  - https
basePath: /api/v1
paths:
  /profiles:
    get:
      summary: Profiles Index
      description: |
        This method returns an array of `profiles`, whose format and content will be the same as the show profile endpoint.
        This endpoint uses pagination through two optional parameters. The first, limit, defaults to 30 and accepts EITHER an integer value, OR the string 'all' to return all records. The second, after, should be the id of the first record BEFORE the records that you want to retrieve.
      parameters:
        - name: per_page
          in: query
          description: Integer limit of records retrieved.
          type: integer
      responses:
        200:
          description: "Successful Response"
          schema:
            type: object
            properties:
              profiles:
                type: array
                items:
                  $ref: "#/definitions/Profile"
              meta:
                $ref: "#/definitions/Profile Meta"
              links:
                $ref: "#/definitions/Profile Links"
              linked:
                type: object
                properties:
                  job_titles:
                    type: array
                    items:
                      $ref: "#/definitions/Job Title"
                  files:
                    type: array
                    items:
                      $ref: "#/definitions/File"
                  groups:
                    type: array
                    items:
                      $ref: "#/definitions/Group"
                  teams:
                    type: array
                    items:
                      $ref: "#/definitions/Team"
      tags:
        - Profiles