openapi: 3.0.3
info:
  title: ApiBuilder Postman Collection v2.1
  version: 0.16.74
  description: Specification of Postman Collection Format v2.1 using the ApiBuilder
    schema. Further information about Postman Collection Format v2.1 can be found
    at https://schema.getpostman.com/json/collection/v2.1.0/docs/index.html
servers:
- url: https://www.getpostman.com
components:
  schemas:
    IoApibuilderPostmanCollectionV21V0ModelsHeader:
      type: object
      required:
      - key
      - value
      properties:
        key:
          type: string
        value:
          type: string
        disabled:
          type: boolean
        description:
          $ref: '#/components/schemas/IoApibuilderPostmanCollectionV21V0ModelsDescription'
    IoApibuilderPostmanCollectionV21V0ModelsUrlEncoded:
      type: object
      required:
      - key
      properties:
        key:
          type: string
        value:
          type: string
        disabled:
          type: boolean
        description:
          $ref: '#/components/schemas/IoApibuilderPostmanCollectionV21V0ModelsDescription'
    IoApibuilderPostmanCollectionV21V0ModelsDescription:
      type: object
      properties:
        content:
          description: The content of the description goes here, as a raw string.
          type: string
        type:
          description: 'Holds the mime type of the raw description content. E.g: ''text/markdown''
            or ''text/html''. The type is used to correctly render the description
            when generating documentation, or in the Postman app.'
          type: string
    IoApibuilderPostmanCollectionV21V0ModelsVariable:
      description: Using variables in your Postman requests eliminates the need to
        duplicate requests, which can save a lot of time. Variables can be defined,
        and referenced to from any part of a request.
      type: object
      properties:
        id:
          description: A variable ID is a unique user-defined value that identifies
            the variable within a collection. In traditional terms, this would be
            a variable name.
          type: string
        key:
          description: A variable key is a human friendly value that identifies the
            variable within a collection. In traditional terms, this would be a variable
            name.
          type: string
        value:
          description: The value that a variable holds in this collection. Ultimately,
            the variables will be replaced by this value, when say running a set of
            requests from a collection
          type: string
        type:
          description: A variable may have multiple types. This field specifies the
            type of the variable.
          type: string
        name:
          description: Variable name
          type: string
        description:
          $ref: '#/components/schemas/IoApibuilderPostmanCollectionV21V0ModelsDescription'
        system:
          description: When set to true, indicates that this variable has been set
            by Postman
          type: boolean
        disabled:
          type: boolean
    IoApibuilderPostmanCollectionV21V0ModelsScript:
      type: object
      required:
      - exec
      - type
      properties:
        exec:
          description: Body of the script in lines
          type: array
          items:
            type: string
        type:
          description: 'Type of the script. E.g: ''text/javascript'''
          default: text/javascript
          type: string
        id:
          description: A unique, user defined identifier that can be used to refer
            to this script from requests.
          type: string
        src:
          description: If object, contains the complete broken-down URL for this request.
            If string, contains the literal request URL.
          type: string
        name:
          description: Script name
          type: string
    IoApibuilderPostmanCollectionV21V0ModelsFormParameter:
      type: object
      required:
      - key
      properties:
        key:
          type: string
        value:
          type: string
        disabled:
          type: boolean
        description:
          $ref: '#/components/schemas/IoApibuilderPostmanCollectionV21V0ModelsDescription'
        contentType:
          type: string
        type:
          type: string
    IoApibuilderPostmanCollectionV21V0ModelsFile:
      type: object
      properties:
        src:
          type: string
        content:
          type: string
    IoApibuilderPostmanCollectionV21V0ModelsItem:
      type: object
      required:
      - request
      properties:
        id:
          description: A unique ID that is used to identify collections internally
          type: string
        name:
          description: A human readable identifier for the current item.
          type: string
        description:
          $ref: '#/components/schemas/IoApibuilderPostmanCollectionV21V0ModelsDescription'
          description: A Description can be a raw text, or be an object, which holds
            the description along with its format.
        variable:
          description: Collection variables allow you to define a set of variables,
            that are a part of the collection, as opposed to environments, which are
            separate entities.
          type: array
          items:
            $ref: '#/components/schemas/IoApibuilderPostmanCollectionV21V0ModelsVariable'
        event:
          description: Postman allows you to configure scripts to run when specific
            events occur. These scripts are stored here, and can be referenced in
            the collection by their ID.
          type: array
          items:
            $ref: '#/components/schemas/IoApibuilderPostmanCollectionV21V0ModelsEvent'
        request:
          $ref: '#/components/schemas/IoApibuilderPostmanCollectionV21V0ModelsRequest'
        response:
          type: array
          items:
            $ref: '#/components/schemas/IoApibuilderPostmanCollectionV21V0ModelsResponse'
    IoApibuilderPostmanCollectionV21V0ModelsEvent:
      type: object
      required:
      - listen
      properties:
        listen:
          $ref: '#/components/schemas/IoApibuilderPostmanCollectionV21V0EnumsEventType'
          description: Can be set to test or prerequest for test scripts or pre-request
            scripts respectively.
        script:
          $ref: '#/components/schemas/IoApibuilderPostmanCollectionV21V0ModelsScript'
        id:
          description: A unique identifier for the enclosing event.
          type: string
        disabled:
          description: Indicates whether the event is disabled. If absent, the event
            is assumed to be enabled
          type: boolean
    IoApibuilderPostmanCollectionV21V0ModelsAuth:
      type: object
      required:
      - type
      properties:
        type:
          $ref: '#/components/schemas/IoApibuilderPostmanCollectionV21V0EnumsAuthEnum'
        basic:
          type: array
          items:
            $ref: '#/components/schemas/IoApibuilderPostmanCollectionV21V0ModelsBasicAuth'
    IoApibuilderPostmanCollectionV21V0ModelsUrl:
      type: object
      properties:
        raw:
          description: The string representation of the request URL, including the
            protocol, host, path, hash, query parameter(s) and path variable(s).
          type: string
        protocol:
          description: 'The protocol_ associated with the request, E.g: ''http'''
          type: string
        host:
          description: 'The host for the URL, E.g: api.yourdomain.com. Can be stored
            as a string or as an array of strings.'
          type: array
          items:
            type: string
        path:
          type: array
          items:
            type: string
        port:
          description: The port number present in this URL. An empty value implies
            80/443 depending on whether the protocol_ field contains http/https.
          type: string
        query:
          type: array
          items:
            $ref: '#/components/schemas/IoApibuilderPostmanCollectionV21V0ModelsQueryParam'
        hash:
          description: Contains the URL fragment (if any). Usually this is not transmitted
            over the network, but it could be useful to store this in some cases.
          type: string
        variable:
          description: Postman supports path variables with the syntax /path/:variableName/to/somewhere.
            These variables are stored in this field.
          type: array
          items:
            $ref: '#/components/schemas/IoApibuilderPostmanCollectionV21V0ModelsVariable'
    IoApibuilderPostmanCollectionV21V0ModelsFolder:
      type: object
      required:
      - name
      - item
      properties:
        name:
          description: A folder's friendly name is defined by this field. You would
            want to set this field to a value that would allow you to easily identify
            this folder.
          type: string
        description:
          $ref: '#/components/schemas/IoApibuilderPostmanCollectionV21V0ModelsDescription'
        variable:
          type: array
          items:
            $ref: '#/components/schemas/IoApibuilderPostmanCollectionV21V0ModelsVariable'
        item:
          type: array
          items:
            $ref: '#/components/schemas/IoApibuilderPostmanCollectionV21V0ModelsItem'
        event:
          type: array
          items:
            $ref: '#/components/schemas/IoApibuilderPostmanCollectionV21V0ModelsEvent'
        auth:
          $ref: '#/components/schemas/IoApibuilderPostmanCollectionV21V0ModelsAuth'
    IoApibuilderPostmanCollectionV21V0ModelsBasicAuth:
      type: object
      required:
      - key
      - value
      properties:
        key:
          type: string
        value:
          type: string
        type:
          type: string
    IoApibuilderPostmanCollectionV21V0ModelsInfo:
      type: object
      required:
      - name
      - schema
      properties:
        name:
          description: A collection's friendly name is defined by this field. You
            would want to set this field to a value that would allow you to easily
            identify this collection among a bunch of other collections, as such outlining
            its usage or content.
          type: string
        postman_id:
          description: 'Every collection is identified by the unique value of this
            field. The value of this field is usually easiest to generate using a
            UID generator function. If you already have a collection, it is recommended
            that you maintain the same id since changing the id usually implies that
            is a different collection than it was originally.Note: This field exists
            for compatibility reasons with Collection Format V1.'
          type: string
        description:
          $ref: '#/components/schemas/IoApibuilderPostmanCollectionV21V0ModelsDescription'
          description: A Description can be a raw text, or be an object, which holds
            the description along with its format.
        version:
          description: Postman allows you to version your collections as they grow,
            and this field holds the version number. While optional, it is recommended
            that you use this field to its fullest extent!
          type: string
        schema:
          description: 'This should ideally hold a link to the Postman schema that
            is used to validate this collection. E.g: https://schema.getpostman.com/collection/v1'
          type: string
    IoApibuilderPostmanCollectionV21V0ModelsCollection:
      type: object
      required:
      - info
      - item
      - event
      - variable
      properties:
        info:
          $ref: '#/components/schemas/IoApibuilderPostmanCollectionV21V0ModelsInfo'
          description: Detailed description of the info block
        item:
          description: Items are the basic unit for a Postman collection. You can
            think of them as corresponding to a single API endpoint. Each Item has
            one request and may have multiple API responses associated with it.
          type: array
          items:
            $ref: '#/components/schemas/IoApibuilderPostmanCollectionV21V0UnionsItems'
        event:
          description: Postman allows you to configure scripts to run when specific
            events occur. These scripts are stored here, and can be referenced in
            the collection by their ID.
          type: array
          items:
            $ref: '#/components/schemas/IoApibuilderPostmanCollectionV21V0ModelsEvent'
        variable:
          description: 'Collection variables allow you to define a set of variables,
            that are a part of the collection, as opposed to environments, which are
            separate entities.Note: Collection variables must not contain any sensitive
            information.'
          type: array
          items:
            $ref: '#/components/schemas/IoApibuilderPostmanCollectionV21V0ModelsVariable'
        auth:
          $ref: '#/components/schemas/IoApibuilderPostmanCollectionV21V0ModelsAuth'
          description: Represents authentication helpers provided by Postman
    IoApibuilderPostmanCollectionV21V0ModelsQueryParam:
      type: object
      properties:
        key:
          type: string
        value:
          type: string
        disabled:
          type: boolean
        description:
          $ref: '#/components/schemas/IoApibuilderPostmanCollectionV21V0ModelsDescription'
    IoApibuilderPostmanCollectionV21V0ModelsResponse:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        originalRequest:
          $ref: '#/components/schemas/IoApibuilderPostmanCollectionV21V0ModelsRequest'
        responseTime:
          type: string
        header:
          type: array
          items:
            $ref: '#/components/schemas/IoApibuilderPostmanCollectionV21V0ModelsHeader'
        body:
          type: string
        status:
          type: string
        code:
          type: integer
          format: int32
    IoApibuilderPostmanCollectionV21V0ModelsBody:
      type: object
      properties:
        raw:
          type: string
        mode:
          $ref: '#/components/schemas/IoApibuilderPostmanCollectionV21V0EnumsBodyMode'
        urlencoded:
          type: array
          items:
            $ref: '#/components/schemas/IoApibuilderPostmanCollectionV21V0ModelsUrlEncoded'
        file:
          $ref: '#/components/schemas/IoApibuilderPostmanCollectionV21V0ModelsFile'
        formdata:
          type: array
          items:
            $ref: '#/components/schemas/IoApibuilderPostmanCollectionV21V0ModelsFormParameter'
    IoApibuilderPostmanCollectionV21V0ModelsRequest:
      type: object
      properties:
        url:
          $ref: '#/components/schemas/IoApibuilderPostmanCollectionV21V0ModelsUrl'
        auth:
          $ref: '#/components/schemas/IoApibuilderPostmanCollectionV21V0ModelsAuth'
        method:
          $ref: '#/components/schemas/IoApibuilderPostmanCollectionV21V0EnumsMethod'
        description:
          $ref: '#/components/schemas/IoApibuilderPostmanCollectionV21V0ModelsDescription'
        header:
          type: array
          items:
            $ref: '#/components/schemas/IoApibuilderPostmanCollectionV21V0ModelsHeader'
        body:
          $ref: '#/components/schemas/IoApibuilderPostmanCollectionV21V0ModelsBody'
    IoApibuilderPostmanCollectionV21V0EnumsAuthEnum:
      type: string
      enum:
      - awsv4
      - basic
      - bearer
      - digest
      - hawk
      - noauth
      - oauth1
      - oauth2
      - ntlm
    IoApibuilderPostmanCollectionV21V0EnumsBodyMode:
      type: string
      enum:
      - raw
      - urlencoded
      - formdata
      - file
    IoApibuilderPostmanCollectionV21V0EnumsMethod:
      type: string
      enum:
      - GET
      - PUT
      - POST
      - PATCH
      - DELETE
      - COPY
      - HEAD
      - OPTIONS
      - LINK
      - UNLINK
      - PURGE
      - LOCK
      - UNLOCK
      - PROPFIND
      - VIEW
    IoApibuilderPostmanCollectionV21V0EnumsEventType:
      type: string
      enum:
      - test
      - prerequest
    IoApibuilderPostmanCollectionV21V0UnionsItems:
      oneOf:
      - $ref: '#/components/schemas/IoApibuilderPostmanCollectionV21V0ModelsItem'
      - $ref: '#/components/schemas/IoApibuilderPostmanCollectionV21V0ModelsFolder'