API-CLI

 view release on metacpan or  search on metacpan

examples/githubcl-appspec.yaml  view on Meta::CPAN

              url:
                type: string
            type: object
        type: object
      type: array
    gitCommit:
      properties:
        author:
          properties:
            date:
              type: string
            email:
              type: string
            name:
              type: string
          type: object
        message:
          type: string
        parents:
          type: string
        tree:
          type: string
      type: object
    gitRefPatch:
      properties:
        force:
          type: boolean
        sha:
          type: string
      type: object
    gitignore:
      items: {}
      type: array
    gitignore-lang:
      properties:
        name:
          type: string
        source:
          type: string
      type: object
    headBranch:
      properties:
        object:
          properties:
            sha:
              type: string
            type:
              type: string
            url:
              type: string
          type: object
        ref:
          type: string
        url:
          type: string
      type: object
    headBranchBody:
      properties:
        force:
          description: Boolean indicating whether to force the update or to make sure
            the update is a fast-forward update. The default is false, so leaving
            this out or setting it to false will make sure you’re not overwriting
            work.
          type: boolean
        sha:
          description: String of the SHA1 value to set this reference to.
          type: string
      required:
      - sha
      - force
      type: object
    heads:
      items:
        properties:
          commit:
            properties:
              sha:
                type: string
              url:
                type: string
            type: object
          name:
            type: string
          tarball_url:
            type: string
          zipball_url:
            type: string
        type: object
      type: array
    hook:
      items:
        properties:
          active:
            type: boolean
          config:
            properties:
              content_type:
                type: string
              url:
                type: string
            type: object
          created_at:
            description: 'ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ'
            type: string
          events:
            items:
              enum:
              - push
              - issues
              - issue_comment
              - commit_comment
              - pull_request
              - pull_request_review_comment
              - gollum
              - watch
              - download
              - fork
              - fork_apply
              - member
              - public
              - team_add

examples/githubcl-appspec.yaml  view on Meta::CPAN

                  repos_url:
                    type: string
                  starred_url:
                    type: string
                  subscriptions_url:
                    type: string
                  type:
                    type: string
                  url:
                    type: string
                type: object
            type: object
          type: array
        total_count:
          type: integer
      type: object
    search-issues-by-keyword:
      properties:
        issues:
          items:
            properties:
              body:
                type: string
              comments:
                type: integer
              created_at:
                type: string
              gravatar_id:
                type: string
              html_url:
                type: string
              labels:
                items:
                  type: string
                type: array
              number:
                type: integer
              position:
                type: integer
              state:
                type: string
              title:
                type: string
              updated_at:
                type: string
              user:
                type: string
              votes:
                type: integer
            type: object
          type: array
      type: object
    search-repositories:
      properties:
        items:
          items:
            properties:
              created_at:
                description: 'ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ'
                type: string
              default_branch:
                type: string
              description:
                type: string
              fork:
                type: boolean
              forks:
                type: integer
              forks_count:
                type: integer
              full_name:
                type: string
              homepage:
                type: string
              html_url:
                type: string
              id:
                type: integer
              language:
                type: string
              master_branch:
                type: string
              name:
                type: string
              open_issues:
                type: integer
              open_issues_count:
                type: integer
              owner:
                properties:
                  avatar_url:
                    type: string
                  gravatar_id:
                    type: string
                  id:
                    type: integer
                  login:
                    type: string
                  received_events_url:
                    type: string
                  type:
                    type: string
                  url:
                    type: string
                type: object
              private:
                type: boolean
              pushed_at:
                description: 'ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ'
                type: string
              score:
                type: number
              size:
                type: integer
              updated_at:
                description: 'ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ'
                type: string
              url:
                type: string
              watchers:
                type: integer

examples/githubcl-appspec.yaml  view on Meta::CPAN

          type: integer
        - in: header
          name: X-RateLimit-Reset
          type: integer
        - in: header
          name: X-GitHub-Request-Id
          type: integer
        responses:
          '200':
            description: OK
            schema:
              $ref: '#/definitions/gitignore'
          '403':
            description: |
              API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
              for details.
    /gitignore/templates/{language}:
      get:
        description: Get a single template.
        parameters:
        - in: path
          name: language
          required: true
          type: string
        - description: |
            You can check the current version of media type in responses.
          in: header
          name: X-GitHub-Media-Type
          type: string
        - description: Is used to set specified media type.
          in: header
          name: Accept
          type: string
        - in: header
          name: X-RateLimit-Limit
          type: integer
        - in: header
          name: X-RateLimit-Remaining
          type: integer
        - in: header
          name: X-RateLimit-Reset
          type: integer
        - in: header
          name: X-GitHub-Request-Id
          type: integer
        responses:
          '200':
            description: OK
            schema:
              $ref: '#/definitions/gitignore-lang'
          '403':
            description: |
              API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
              for details.
    /issues:
      get:
        description: |
          List issues.
          List all issues across all the authenticated user's visible repositories.
        parameters:
        - default: all
          description: |
            Issues assigned to you / created by you / mentioning you / you're
            subscribed to updates for / All issues the authenticated user can see
          enum: &1
          - assigned
          - created
          - mentioned
          - subscribed
          - all
          in: query
          name: filter
          required: true
          type: string
        - default: open
          enum: &2
          - open
          - closed
          in: query
          name: state
          required: true
          type: string
        - description: String list of comma separated Label names. Example - bug,ui,@high.
          in: query
          name: labels
          required: true
          type: string
        - default: created
          enum: &3
          - created
          - updated
          - comments
          in: query
          name: sort
          required: true
          type: string
        - default: desc
          enum: &4
          - asc
          - desc
          in: query
          name: direction
          required: true
          type: string
        - description: |
            Optional string of a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
            Only issues updated at or after this time are returned.
          in: query
          name: since
          type: string
        - description: |
            You can check the current version of media type in responses.
          in: header
          name: X-GitHub-Media-Type
          type: string
        - description: Is used to set specified media type.
          in: header
          name: Accept
          type: string
        - in: header
          name: X-RateLimit-Limit
          type: integer
        - in: header
          name: X-RateLimit-Remaining
          type: integer
        - in: header
          name: X-RateLimit-Reset
          type: integer
        - in: header
          name: X-GitHub-Request-Id
          type: integer
        responses:
          '200':
            description: OK
            schema:
              $ref: '#/definitions/issues'
          '403':
            description: |
              API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
              for details.
    /legacy/issues/search/{owner}/{repository}/{state}/{keyword}:
      get:
        description: Find issues by state and keyword.
        parameters:
        - description: The search term.
          in: path
          name: keyword
          required: true
          type: string
        - description: Indicates the state of the issues to return. Can be either
            open or closed.
          enum: &5
          - open
          - closed
          in: path
          name: state
          required: true
          type: string
        - in: path
          name: owner
          required: true
          type: string
        - in: path
          name: repository
          required: true
          type: string
        - description: |
            You can check the current version of media type in responses.
          in: header
          name: X-GitHub-Media-Type
          type: string
        - description: Is used to set specified media type.
          in: header
          name: Accept
          type: string
        - in: header
          name: X-RateLimit-Limit
          type: integer
        - in: header
          name: X-RateLimit-Remaining
          type: integer
        - in: header
          name: X-RateLimit-Reset
          type: integer
        - in: header
          name: X-GitHub-Request-Id
          type: integer
        responses:
          '200':
            description: OK
            schema:
              $ref: '#/definitions/search-issues-by-keyword'
          '403':
            description: |
              API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
              for details.
    /legacy/repos/search/{keyword}:
      get:
        description: Find repositories by keyword. Note, this legacy method does not
          follow the v3 pagination pattern. This method returns up to 100 results
          per page and pages can be fetched using the start_page parameter.
        parameters:
        - description: The search term
          in: path
          name: keyword
          required: true
          type: string
        - default: desc
          description: The sort field. if sort param is provided. Can be either asc
            or desc.
          enum: &6
          - desc
          - asc
          in: query
          name: order
          type: string
        - description: Filter results by language
          in: query
          name: language
          type: string
        - description: The page number to fetch
          in: query
          name: start_page
          type: string
        - description: 'The sort field. One of stars, forks, or updated. Default:
            results are sorted by best match.'
          enum: &7
          - updated
          - stars
          - forks
          in: query
          name: sort
          type: string
        - description: |
            You can check the current version of media type in responses.
          in: header
          name: X-GitHub-Media-Type
          type: string
        - description: Is used to set specified media type.
          in: header
          name: Accept
          type: string
        - in: header
          name: X-RateLimit-Limit
          type: integer
        - in: header
          name: X-RateLimit-Remaining
          type: integer
        - in: header
          name: X-RateLimit-Reset
          type: integer
        - in: header
          name: X-GitHub-Request-Id
          type: integer
        responses:
          '200':
            description: OK
            schema:
              $ref: '#/definitions/search-repositories-by-keyword'
          '403':
            description: |
              API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
              for details.
    /legacy/user/email/{email}:
      get:
        description: This API call is added for compatibility reasons only.
        parameters:
        - description: The email address
          in: path
          name: email
          required: true
          type: string
        - description: |
            You can check the current version of media type in responses.
          in: header
          name: X-GitHub-Media-Type
          type: string
        - description: Is used to set specified media type.
          in: header
          name: Accept
          type: string
        - in: header
          name: X-RateLimit-Limit
          type: integer
        - in: header
          name: X-RateLimit-Remaining
          type: integer
        - in: header
          name: X-RateLimit-Reset
          type: integer
        - in: header
          name: X-GitHub-Request-Id
          type: integer
        responses:
          '200':
            description: OK
            schema:
              $ref: '#/definitions/search-user-by-email'
          '403':
            description: |
              API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
              for details.
    /legacy/user/search/{keyword}:
      get:
        description: Find users by keyword.
        parameters:
        - description: The search term
          in: path
          name: keyword
          required: true
          type: string
        - default: desc
          description: The sort field. if sort param is provided. Can be either asc
            or desc.
          enum: &8
          - desc
          - asc
          in: query
          name: order
          type: string
        - description: The page number to fetch
          in: query
          name: start_page
          type: string
        - description: 'The sort field. One of stars, forks, or updated. Default:
            results are sorted by best match.'
          enum: &9
          - updated
          - stars
          - forks
          in: query
          name: sort
          type: string
        - description: |
            You can check the current version of media type in responses.
          in: header
          name: X-GitHub-Media-Type
          type: string
        - description: Is used to set specified media type.
          in: header
          name: Accept
          type: string
        - in: header
          name: X-RateLimit-Limit
          type: integer
        - in: header
          name: X-RateLimit-Remaining
          type: integer
        - in: header
          name: X-RateLimit-Reset
          type: integer
        - in: header
          name: X-GitHub-Request-Id
          type: integer
        responses:
          '200':
            description: OK
            schema:
              $ref: '#/definitions/search-users-by-keyword'
          '403':
            description: |
              API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
              for details.
    /markdown:
      post:
        description: Render an arbitrary Markdown document
        parameters:
        - description: |
            You can check the current version of media type in responses.
          in: header
          name: X-GitHub-Media-Type
          type: string

examples/githubcl-appspec.yaml  view on Meta::CPAN

              $ref: '#/definitions/events'
          '403':
            description: |
              API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
              for details.
    /notifications:
      get:
        description: |
          List your notifications.
          List all notifications for the current user, grouped by repository.
        parameters:
        - description: True to show notifications marked as read.
          in: query
          name: all
          type: boolean
        - description: |
            True to show only notifications in which the user is directly participating
            or mentioned.
          in: query
          name: participating
          type: boolean
        - description: |
            The time should be passed in as UTC in the ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
            Example: "2012-10-09T23:39:01Z".
          in: query
          name: since
          type: string
        - description: |
            You can check the current version of media type in responses.
          in: header
          name: X-GitHub-Media-Type
          type: string
        - description: Is used to set specified media type.
          in: header
          name: Accept
          type: string
        - in: header
          name: X-RateLimit-Limit
          type: integer
        - in: header
          name: X-RateLimit-Remaining
          type: integer
        - in: header
          name: X-RateLimit-Reset
          type: integer
        - in: header
          name: X-GitHub-Request-Id
          type: integer
        responses:
          '200':
            description: OK
            schema:
              $ref: '#/definitions/notifications'
          '403':
            description: |
              API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
              for details.
      put:
        description: |
          Mark as read.
          Marking a notification as "read" removes it from the default view on GitHub.com.
        parameters:
        - description: |
            You can check the current version of media type in responses.
          in: header
          name: X-GitHub-Media-Type
          type: string
        - description: Is used to set specified media type.
          in: header
          name: Accept
          type: string
        - in: header
          name: X-RateLimit-Limit
          type: integer
        - in: header
          name: X-RateLimit-Remaining
          type: integer
        - in: header
          name: X-RateLimit-Reset
          type: integer
        - in: header
          name: X-GitHub-Request-Id
          type: integer
        - in: body
          name: body
          required: true
          schema:
            $ref: '#/definitions/notificationMarkRead'
        responses:
          '205':
            description: Marked as read.
          '403':
            description: |
              API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
              for details.
    /notifications/threads/{id}:
      get:
        description: View a single thread.
        parameters:
        - description: Id of thread.
          in: path
          name: id
          required: true
          type: integer
        - description: |
            You can check the current version of media type in responses.
          in: header
          name: X-GitHub-Media-Type
          type: string
        - description: Is used to set specified media type.
          in: header
          name: Accept
          type: string
        - in: header
          name: X-RateLimit-Limit
          type: integer
        - in: header
          name: X-RateLimit-Remaining
          type: integer
        - in: header
          name: X-RateLimit-Reset

examples/githubcl-appspec.yaml  view on Meta::CPAN

            $ref: '#/definitions/patchOrg'
        responses:
          '200':
            description: OK
            schema:
              $ref: '#/definitions/organization'
          '403':
            description: |
              API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
              for details.
    /orgs/{org}/events:
      get:
        description: List public events for an organization.
        parameters:
        - description: Name of organisation.
          in: path
          name: org
          required: true
          type: string
        - description: |
            You can check the current version of media type in responses.
          in: header
          name: X-GitHub-Media-Type
          type: string
        - description: Is used to set specified media type.
          in: header
          name: Accept
          type: string
        - in: header
          name: X-RateLimit-Limit
          type: integer
        - in: header
          name: X-RateLimit-Remaining
          type: integer
        - in: header
          name: X-RateLimit-Reset
          type: integer
        - in: header
          name: X-GitHub-Request-Id
          type: integer
        responses:
          '200':
            description: OK
            schema:
              $ref: '#/definitions/events'
          '403':
            description: |
              API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
              for details.
    /orgs/{org}/issues:
      get:
        description: |
          List issues.
          List all issues for a given organization for the authenticated user.
        parameters:
        - description: Name of organisation.
          in: path
          name: org
          required: true
          type: string
        - default: all
          description: |
            Issues assigned to you / created by you / mentioning you / you're
            subscribed to updates for / All issues the authenticated user can see
          enum: &10
          - assigned
          - created
          - mentioned
          - subscribed
          - all
          in: query
          name: filter
          required: true
          type: string
        - default: open
          enum: &11
          - open
          - closed
          in: query
          name: state
          required: true
          type: string
        - description: String list of comma separated Label names. Example - bug,ui,@high.
          in: query
          name: labels
          required: true
          type: string
        - default: created
          enum: &12
          - created
          - updated
          - comments
          in: query
          name: sort
          required: true
          type: string
        - default: desc
          enum: &13
          - asc
          - desc
          in: query
          name: direction
          required: true
          type: string
        - description: |
            Optional string of a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
            Only issues updated at or after this time are returned.
          in: query
          name: since
          type: string
        - description: |
            You can check the current version of media type in responses.
          in: header
          name: X-GitHub-Media-Type
          type: string
        - description: Is used to set specified media type.
          in: header
          name: Accept
          type: string
        - in: header
          name: X-RateLimit-Limit
          type: integer
        - in: header
          name: X-RateLimit-Remaining
          type: integer
        - in: header
          name: X-RateLimit-Reset
          type: integer
        - in: header
          name: X-GitHub-Request-Id
          type: integer
        responses:
          '200':
            description: OK
            schema:
              $ref: '#/definitions/issues'
          '403':
            description: |
              API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
              for details.
    /orgs/{org}/members:
      get:
        description: |
          Members list.
          List all users who are members of an organization. A member is a user tha
          belongs to at least 1 team in the organization. If the authenticated user
          is also an owner of this organization then both concealed and public members
          will be returned. If the requester is not an owner of the organization the
          query will be redirected to the public members list.
        parameters:
        - description: Name of organisation.
          in: path
          name: org
          required: true
          type: string
        - description: |
            You can check the current version of media type in responses.

examples/githubcl-appspec.yaml  view on Meta::CPAN

          type: integer
        responses:
          '204':
            description: User is a public member.
          '403':
            description: |
              API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
              for details.
          '404':
            description: User is not a public member.
      put:
        description: Publicize a user's membership.
        parameters:
        - description: Name of organisation.
          in: path
          name: org
          required: true
          type: string
        - description: Name of the user.
          in: path
          name: username
          required: true
          type: string
        - description: |
            You can check the current version of media type in responses.
          in: header
          name: X-GitHub-Media-Type
          type: string
        - description: Is used to set specified media type.
          in: header
          name: Accept
          type: string
        - in: header
          name: X-RateLimit-Limit
          type: integer
        - in: header
          name: X-RateLimit-Remaining
          type: integer
        - in: header
          name: X-RateLimit-Reset
          type: integer
        - in: header
          name: X-GitHub-Request-Id
          type: integer
        responses:
          '204':
            description: Publicized.
          '403':
            description: |
              API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
              for details.
    /orgs/{org}/repos:
      get:
        description: List repositories for the specified org.
        parameters:
        - description: Name of organisation.
          in: path
          name: org
          required: true
          type: string
        - default: all
          enum: &14
          - all
          - public
          - private
          - forks
          - sources
          - member
          in: query
          name: type
          type: string
        - description: |
            You can check the current version of media type in responses.
          in: header
          name: X-GitHub-Media-Type
          type: string
        - description: Is used to set specified media type.
          in: header
          name: Accept
          type: string
        - in: header
          name: X-RateLimit-Limit
          type: integer
        - in: header
          name: X-RateLimit-Remaining
          type: integer
        - in: header
          name: X-RateLimit-Reset
          type: integer
        - in: header
          name: X-GitHub-Request-Id
          type: integer
        responses:
          '200':
            description: OK
            schema:
              $ref: '#/definitions/repos'
          '403':
            description: |
              API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
              for details.
      post:
        description: |
          Create a new repository for the authenticated user. OAuth users must supply
          repo scope.
        parameters:
        - description: Name of organisation.
          in: path
          name: org
          required: true
          type: string
        - description: |
            You can check the current version of media type in responses.
          in: header
          name: X-GitHub-Media-Type
          type: string
        - description: Is used to set specified media type.
          in: header
          name: Accept
          type: string
        - in: header

examples/githubcl-appspec.yaml  view on Meta::CPAN

              API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
              for details.
    /repos/{owner}/{repo}/events:
      get:
        description: Get list of repository events.
        parameters:
        - description: Name of repository owner.
          in: path
          name: owner
          required: true
          type: string
        - description: Name of repository.
          in: path
          name: repo
          required: true
          type: string
        - description: |
            You can check the current version of media type in responses.
          in: header
          name: X-GitHub-Media-Type
          type: string
        - description: Is used to set specified media type.
          in: header
          name: Accept
          type: string
        - in: header
          name: X-RateLimit-Limit
          type: integer
        - in: header
          name: X-RateLimit-Remaining
          type: integer
        - in: header
          name: X-RateLimit-Reset
          type: integer
        - in: header
          name: X-GitHub-Request-Id
          type: integer
        responses:
          '200':
            description: OK
            schema:
              $ref: '#/definitions/events'
          '403':
            description: |
              API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
              for details.
    /repos/{owner}/{repo}/forks:
      get:
        description: List forks.
        parameters:
        - description: Name of repository owner.
          in: path
          name: owner
          required: true
          type: string
        - description: Name of repository.
          in: path
          name: repo
          required: true
          type: string
        - default: newes
          enum: &15
          - newes
          - oldes
          - watchers
          in: query
          name: sort
          type: string
        - description: |
            You can check the current version of media type in responses.
          in: header
          name: X-GitHub-Media-Type
          type: string
        - description: Is used to set specified media type.
          in: header
          name: Accept
          type: string
        - in: header
          name: X-RateLimit-Limit
          type: integer
        - in: header
          name: X-RateLimit-Remaining
          type: integer
        - in: header
          name: X-RateLimit-Reset
          type: integer
        - in: header
          name: X-GitHub-Request-Id
          type: integer
        responses:
          '200':
            description: OK
            schema:
              $ref: '#/definitions/forks'
          '403':
            description: |
              API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
              for details.
      post:
        description: |
          Create a fork.
          Forking a Repository happens asynchronously. Therefore, you may have to wai
          a short period before accessing the git objects. If this takes longer than 5
          minutes, be sure to contact Support.
        parameters:
        - description: Name of repository owner.
          in: path
          name: owner
          required: true
          type: string
        - description: Name of repository.
          in: path
          name: repo
          required: true
          type: string
        - description: |
            You can check the current version of media type in responses.
          in: header
          name: X-GitHub-Media-Type
          type: string
        - description: Is used to set specified media type.

examples/githubcl-appspec.yaml  view on Meta::CPAN

          be generated.
          Note: Previously /repos/:owner/:repo/hooks/:id/tes
        parameters:
        - description: Name of repository owner.
          in: path
          name: owner
          required: true
          type: string
        - description: Name of repository.
          in: path
          name: repo
          required: true
          type: string
        - description: Id of hook.
          in: path
          name: hookId
          required: true
          type: integer
        - description: |
            You can check the current version of media type in responses.
          in: header
          name: X-GitHub-Media-Type
          type: string
        - description: Is used to set specified media type.
          in: header
          name: Accept
          type: string
        - in: header
          name: X-RateLimit-Limit
          type: integer
        - in: header
          name: X-RateLimit-Remaining
          type: integer
        - in: header
          name: X-RateLimit-Reset
          type: integer
        - in: header
          name: X-GitHub-Request-Id
          type: integer
        responses:
          '204':
            description: Hook is triggered.
          '403':
            description: |
              API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
              for details.
    /repos/{owner}/{repo}/issues:
      get:
        description: List issues for a repository.
        parameters:
        - description: Name of repository owner.
          in: path
          name: owner
          required: true
          type: string
        - description: Name of repository.
          in: path
          name: repo
          required: true
          type: string
        - default: all
          description: |
            Issues assigned to you / created by you / mentioning you / you're
            subscribed to updates for / All issues the authenticated user can see
          enum: &16
          - assigned
          - created
          - mentioned
          - subscribed
          - all
          in: query
          name: filter
          required: true
          type: string
        - default: open
          enum: &17
          - open
          - closed
          in: query
          name: state
          required: true
          type: string
        - description: String list of comma separated Label names. Example - bug,ui,@high.
          in: query
          name: labels
          required: true
          type: string
        - default: created
          enum: &18
          - created
          - updated
          - comments
          in: query
          name: sort
          required: true
          type: string
        - default: desc
          enum: &19
          - asc
          - desc
          in: query
          name: direction
          required: true
          type: string
        - description: |
            Optional string of a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
            Only issues updated at or after this time are returned.
          in: query
          name: since
          type: string
        - description: |
            You can check the current version of media type in responses.
          in: header
          name: X-GitHub-Media-Type
          type: string
        - description: Is used to set specified media type.
          in: header
          name: Accept
          type: string
        - in: header
          name: X-RateLimit-Limit
          type: integer
        - in: header
          name: X-RateLimit-Remaining
          type: integer
        - in: header
          name: X-RateLimit-Reset
          type: integer
        - in: header
          name: X-GitHub-Request-Id
          type: integer
        responses:
          '200':
            description: OK
            schema:
              $ref: '#/definitions/issues'
          '403':
            description: |
              API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
              for details.
      post:
        description: |
          Create an issue.
          Any user with pull access to a repository can create an issue.
        parameters:
        - description: Name of repository owner.
          in: path
          name: owner
          required: true
          type: string
        - description: Name of repository.
          in: path
          name: repo
          required: true
          type: string
        - description: |
            You can check the current version of media type in responses.

examples/githubcl-appspec.yaml  view on Meta::CPAN

        - description: |
            You can check the current version of media type in responses.
          in: header
          name: X-GitHub-Media-Type
          type: string
        - description: Is used to set specified media type.
          in: header
          name: Accept
          type: string
        - in: header
          name: X-RateLimit-Limit
          type: integer
        - in: header
          name: X-RateLimit-Remaining
          type: integer
        - in: header
          name: X-RateLimit-Reset
          type: integer
        - in: header
          name: X-GitHub-Request-Id
          type: integer
        - in: body
          name: body
          required: true
          schema:
            $ref: '#/definitions/mergesBody'
        responses:
          '201':
            description: Successful Response (The resulting merge commit)
            schema:
              $ref: '#/definitions/mergesSuccessful'
          '204':
            description: No-op response (base already contains the head, nothing to
              merge)
          '403':
            description: |
              API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
              for details.
          '404':
            description: Missing base response or missing head response
            schema:
              $ref: '#/definitions/mergesConflict'
          '409':
            description: Merge conflict response.
            schema:
              $ref: '#/definitions/mergesConflict'
    /repos/{owner}/{repo}/milestones:
      get:
        description: List milestones for a repository.
        parameters:
        - description: Name of repository owner.
          in: path
          name: owner
          required: true
          type: string
        - description: Name of repository.
          in: path
          name: repo
          required: true
          type: string
        - default: open
          description: String to filter by state.
          enum: &21
          - open
          - closed
          in: query
          name: state
          type: string
        - description: Ignored without 'sort' parameter.
          in: query
          name: direction
          type: string
        - default: due_date
          description: ''
          enum: &22
          - due_date
          - completeness
          in: query
          name: sort
          type: string
        - description: |
            You can check the current version of media type in responses.
          in: header
          name: X-GitHub-Media-Type
          type: string
        - description: Is used to set specified media type.
          in: header
          name: Accept
          type: string
        - in: header
          name: X-RateLimit-Limit
          type: integer
        - in: header
          name: X-RateLimit-Remaining
          type: integer
        - in: header
          name: X-RateLimit-Reset
          type: integer
        - in: header
          name: X-GitHub-Request-Id
          type: integer
        responses:
          '200':
            description: OK
            schema:
              $ref: '#/definitions/milestone'
          '403':
            description: |
              API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
              for details.
      post:
        description: Create a milestone.
        parameters:
        - description: Name of repository owner.
          in: path
          name: owner
          required: true
          type: string
        - description: Name of repository.
          in: path
          name: repo
          required: true
          type: string
        - description: |
            You can check the current version of media type in responses.
          in: header
          name: X-GitHub-Media-Type
          type: string
        - description: Is used to set specified media type.
          in: header
          name: Accept
          type: string
        - in: header

examples/githubcl-appspec.yaml  view on Meta::CPAN

        - description: Name of repository owner.
          in: path
          name: owner
          required: true
          type: string
        - description: Name of repository.
          in: path
          name: repo
          required: true
          type: string
        - description: True to show notifications marked as read.
          in: query
          name: all
          type: boolean
        - description: |
            True to show only notifications in which the user is directly participating
            or mentioned.
          in: query
          name: participating
          type: boolean
        - description: |
            The time should be passed in as UTC in the ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
            Example: "2012-10-09T23:39:01Z".
          in: query
          name: since
          type: string
        - description: |
            You can check the current version of media type in responses.
          in: header
          name: X-GitHub-Media-Type
          type: string
        - description: Is used to set specified media type.
          in: header
          name: Accept
          type: string
        - in: header
          name: X-RateLimit-Limit
          type: integer
        - in: header
          name: X-RateLimit-Remaining
          type: integer
        - in: header
          name: X-RateLimit-Reset
          type: integer
        - in: header
          name: X-GitHub-Request-Id
          type: integer
        responses:
          '200':
            description: OK
            schema:
              $ref: '#/definitions/notifications'
          '403':
            description: |
              API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
              for details.
      put:
        description: |
          Mark notifications as read in a repository.
          Marking all notifications in a repository as "read" removes them from the
          default view on GitHub.com.
        parameters:
        - description: Name of repository owner.
          in: path
          name: owner
          required: true
          type: string
        - description: Name of repository.
          in: path
          name: repo
          required: true
          type: string
        - description: |
            You can check the current version of media type in responses.
          in: header
          name: X-GitHub-Media-Type
          type: string
        - description: Is used to set specified media type.
          in: header
          name: Accept
          type: string
        - in: header
          name: X-RateLimit-Limit
          type: integer
        - in: header
          name: X-RateLimit-Remaining
          type: integer
        - in: header
          name: X-RateLimit-Reset
          type: integer
        - in: header
          name: X-GitHub-Request-Id
          type: integer
        - in: body
          name: body
          required: true
          schema:
            $ref: '#/definitions/notificationMarkRead'
        responses:
          '205':
            description: Marked as read.
          '403':
            description: |
              API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
              for details.
    /repos/{owner}/{repo}/pulls:
      get:
        description: List pull requests.
        parameters:
        - description: Name of repository owner.
          in: path
          name: owner
          required: true
          type: string
        - description: Name of repository.
          in: path
          name: repo
          required: true
          type: string
        - default: open
          description: String to filter by state.
          enum: &23
          - open
          - closed
          in: query
          name: state
          type: string
        - description: |
            Filter pulls by head user and branch name in the format of 'user:ref-name'.
            Example: github:new-script-format.
          in: query
          name: head
          type: string
        - description: Filter pulls by base branch name. Example - gh-pages.
          in: query
          name: base
          type: string
        - description: |
            You can check the current version of media type in responses.
          in: header
          name: X-GitHub-Media-Type
          type: string
        - description: Is used to set specified media type.
          in: header
          name: Accept
          type: string
        - in: header
          name: X-RateLimit-Limit
          type: integer
        - in: header
          name: X-RateLimit-Remaining
          type: integer
        - in: header
          name: X-RateLimit-Reset
          type: integer
        - in: header
          name: X-GitHub-Request-Id
          type: integer
        responses:
          '200':
            description: OK
            schema:
              $ref: '#/definitions/pulls'
          '403':
            description: |
              API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
              for details.
      post:
        description: Create a pull request.
        parameters:
        - description: Name of repository owner.
          in: path
          name: owner
          required: true
          type: string
        - description: Name of repository.
          in: path
          name: repo
          required: true
          type: string
        - description: |
            You can check the current version of media type in responses.
          in: header
          name: X-GitHub-Media-Type
          type: string
        - description: Is used to set specified media type.
          in: header
          name: Accept
          type: string
        - in: header
          name: X-RateLimit-Limit
          type: integer
        - in: header
          name: X-RateLimit-Remaining
          type: integer
        - in: header
          name: X-RateLimit-Reset
          type: integer
        - in: header
          name: X-GitHub-Request-Id
          type: integer
        - in: body
          name: body
          required: true
          schema:
            $ref: '#/definitions/pullsPost'
        responses:
          '201':
            description: Created
            schema:
              $ref: '#/definitions/pulls'
          '403':
            description: |
              API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
              for details.
    /repos/{owner}/{repo}/pulls/comments:
      get:
        description: |
          List comments in a repository.
          By default, Review Comments are ordered by ascending ID.
        parameters:
        - description: Name of repository owner.
          in: path
          name: owner
          required: true
          type: string
        - description: Name of repository.
          in: path
          name: repo
          required: true
          type: string
        - description: Ignored without 'sort' parameter.
          in: query
          name: direction
          type: string
        - description: ''
          enum: &24
          - created
          - updated
          in: query
          name: sort
          type: string
        - description: |
            The time should be passed in as UTC in the ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
            Example: "2012-10-09T23:39:01Z".
          in: query
          name: since
          type: string
        - description: |
            You can check the current version of media type in responses.
          in: header
          name: X-GitHub-Media-Type
          type: string
        - description: Is used to set specified media type.
          in: header
          name: Accept
          type: string
        - in: header
          name: X-RateLimit-Limit
          type: integer
        - in: header
          name: X-RateLimit-Remaining
          type: integer
        - in: header
          name: X-RateLimit-Reset
          type: integer
        - in: header
          name: X-GitHub-Request-Id
          type: integer
        responses:
          '200':
            description: OK
            schema:
              $ref: '#/definitions/issuesComments'
          '403':
            description: |
              API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
              for details.
    /repos/{owner}/{repo}/pulls/comments/{commentId}:
      delete:

examples/githubcl-appspec.yaml  view on Meta::CPAN

          name: repo
          required: true
          type: string
        - description: |
            You can check the current version of media type in responses.
          in: header
          name: X-GitHub-Media-Type
          type: string
        - description: Is used to set specified media type.
          in: header
          name: Accept
          type: string
        - in: header
          name: X-RateLimit-Limit
          type: integer
        - in: header
          name: X-RateLimit-Remaining
          type: integer
        - in: header
          name: X-RateLimit-Reset
          type: integer
        - in: header
          name: X-GitHub-Request-Id
          type: integer
        responses:
          '200':
            description: OK
            schema:
              $ref: '#/definitions/users'
          '403':
            description: |
              API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
              for details.
    /repos/{owner}/{repo}/{archive_format}/{path}:
      get:
        description: |
          Get archive link.
          This method will return a 302 to a URL to download a tarball or zipball
          archive for a repository. Please make sure your HTTP framework is
          configured to follow redirects or you will need to use the Location header
          to make a second GET request.
          Note: For private repositories, these links are temporary and expire quickly.
        parameters:
        - description: Name of repository owner.
          in: path
          name: owner
          required: true
          type: string
        - description: Name of repository.
          in: path
          name: repo
          required: true
          type: string
        - enum: &25
          - tarball
          - zipball
          in: path
          name: archive_format
          required: true
          type: string
        - description: Valid Git reference, defaults to 'master'.
          in: path
          name: path
          required: true
          type: string
        - description: |
            You can check the current version of media type in responses.
          in: header
          name: X-GitHub-Media-Type
          type: string
        - description: Is used to set specified media type.
          in: header
          name: Accept
          type: string
        - in: header
          name: X-RateLimit-Limit
          type: integer
        - in: header
          name: X-RateLimit-Remaining
          type: integer
        - in: header
          name: X-RateLimit-Reset
          type: integer
        - in: header
          name: X-GitHub-Request-Id
          type: integer
        responses:
          '302':
            description: Found.
          '403':
            description: |
              API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
              for details.
    /repositories:
      get:
        description: |
          List all public repositories.
          This provides a dump of every public repository, in the order that they
          were created.
          Note: Pagination is powered exclusively by the since parameter. is the
          Link header to get the URL for the next page of repositories.
        parameters:
        - description: |
            The time should be passed in as UTC in the ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
            Example: "2012-10-09T23:39:01Z".
          in: query
          name: since
          type: string
        - description: |
            You can check the current version of media type in responses.
          in: header
          name: X-GitHub-Media-Type
          type: string
        - description: Is used to set specified media type.
          in: header
          name: Accept
          type: string
        - in: header
          name: X-RateLimit-Limit
          type: integer
        - in: header
          name: X-RateLimit-Remaining
          type: integer
        - in: header
          name: X-RateLimit-Reset
          type: integer
        - in: header
          name: X-GitHub-Request-Id
          type: integer
        responses:
          '200':
            description: OK
            schema:
              $ref: '#/definitions/repositories'
          '403':
            description: |
              API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
              for details.
    /search/code:
      get:
        description: Search code.
        parameters:
        - default: desc
          description: The sort field. if sort param is provided. Can be either asc
            or desc.
          enum: &26
          - desc
          - asc
          in: query
          name: order
          type: string
        - description: |
            The search terms. This can be any combination of the supported code
            search parameters:
            'Search In' Qualifies which fields are searched. With this qualifier
            you can restrict the search to just the file contents, the file path,
            or both.
            'Languages' Searches code based on the language it's written in.
            'Forks' Filters repositories based on the number of forks, and/or
            whether code from forked repositories should be included in the results
            at all.
            'Size' Finds files that match a certain size (in bytes).
            'Path' Specifies the path that the resulting file must be at.
            'Extension' Matches files with a certain extension.
            'Users' or 'Repositories' Limits searches to a specific user or repository.
          in: query
          name: q
          required: true
          type: string
        - description: |
            Can only be 'indexed', which indicates how recently a file has been indexed
            by the GitHub search infrastructure. If not provided, results are sorted
            by best match.
          enum: &27
          - indexed
          in: query
          name: sort
          type: string
        - description: |
            You can check the current version of media type in responses.
          in: header
          name: X-GitHub-Media-Type
          type: string
        - description: Is used to set specified media type.
          in: header
          name: Accept
          type: string
        - in: header
          name: X-RateLimit-Limit
          type: integer
        - in: header
          name: X-RateLimit-Remaining
          type: integer
        - in: header
          name: X-RateLimit-Reset
          type: integer
        - in: header
          name: X-GitHub-Request-Id
          type: integer
        responses:
          '200':
            description: OK
            schema:
              $ref: '#/definitions/search-code'
          '403':
            description: |
              API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
              for details.
    /search/issues:
      get:
        description: Find issues by state and keyword. (This method returns up to
          100 results per page.)
        parameters:
        - default: desc
          description: The sort field. if sort param is provided. Can be either asc
            or desc.
          enum: &28
          - desc
          - asc
          in: query
          name: order
          type: string
        - description: 'The q search term can also contain any combination of the
            supported issue search qualifiers:'
          in: query
          name: q
          required: true
          type: string
        - description: 'The sort field. Can be comments, created, or updated. Default:
            results are sorted by best match.'
          enum: &29
          - updated
          - created
          - comments
          in: query
          name: sort
          type: string
        - description: |
            You can check the current version of media type in responses.
          in: header
          name: X-GitHub-Media-Type
          type: string
        - description: Is used to set specified media type.
          in: header
          name: Accept
          type: string
        - in: header
          name: X-RateLimit-Limit
          type: integer
        - in: header
          name: X-RateLimit-Remaining
          type: integer
        - in: header
          name: X-RateLimit-Reset
          type: integer
        - in: header
          name: X-GitHub-Request-Id
          type: integer
        responses:
          '200':
            description: OK
            schema:
              $ref: '#/definitions/search-issues'
          '403':
            description: |
              API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
              for details.
    /search/repositories:
      get:
        description: Search repositories.
        parameters:
        - default: desc
          description: The sort field. if sort param is provided. Can be either asc
            or desc.
          enum: &30
          - desc
          - asc
          in: query
          name: order
          type: string
        - description: |
            The search terms. This can be any combination of the supported repository
            search parameters:
            'Search In' Qualifies which fields are searched. With this qualifier you
            can restrict the search to just the repository name, description, readme,
            or any combination of these.
            'Size' Finds repositories that match a certain size (in kilobytes).
            'Forks' Filters repositories based on the number of forks, and/or whether
            forked repositories should be included in the results at all.
            'Created' and 'Last Updated' Filters repositories based on times of
            creation, or when they were last updated.
            'Users or Repositories' Limits searches to a specific user or repository.
            'Languages' Searches repositories based on the language they are written in.
            'Stars' Searches repositories based on the number of stars.
          in: query
          name: q
          required: true
          type: string
        - description: If not provided, results are sorted by best match.
          enum: &31
          - stars
          - forks
          - updated
          in: query
          name: sort
          type: string
        - description: |
            You can check the current version of media type in responses.
          in: header
          name: X-GitHub-Media-Type
          type: string
        - description: Is used to set specified media type.
          in: header
          name: Accept
          type: string
        - in: header
          name: X-RateLimit-Limit
          type: integer
        - in: header
          name: X-RateLimit-Remaining
          type: integer
        - in: header
          name: X-RateLimit-Reset
          type: integer
        - in: header
          name: X-GitHub-Request-Id
          type: integer
        responses:
          '200':
            description: OK
            schema:
              $ref: '#/definitions/search-repositories'
          '403':
            description: |
              API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
              for details.
    /search/users:
      get:
        description: Search users.
        parameters:
        - default: desc
          description: The sort field. if sort param is provided. Can be either asc
            or desc.
          enum: &32
          - desc
          - asc
          in: query
          name: order
          type: string
        - description: |
            The search terms. This can be any combination of the supported user
            search parameters:
            'Search In' Qualifies which fields are searched. With this qualifier you
            can restrict the search to just the username, public email, full name,
            location, or any combination of these.
            'Repository count' Filters users based on the number of repositories they
            have.
            'Location' Filter users by the location indicated in their profile.
            'Language' Search for users that have repositories that match a certain
            language.
            'Created' Filter users based on when they joined.
            'Followers' Filter users based on the number of followers they have.
          in: query
          name: q
          required: true
          type: string
        - description: If not provided, results are sorted by best match.
          enum: &33
          - followers
          - repositories
          - joined
          in: query
          name: sort
          type: string
        - description: |
            You can check the current version of media type in responses.
          in: header
          name: X-GitHub-Media-Type
          type: string
        - description: Is used to set specified media type.
          in: header
          name: Accept
          type: string
        - in: header
          name: X-RateLimit-Limit
          type: integer
        - in: header
          name: X-RateLimit-Remaining
          type: integer
        - in: header
          name: X-RateLimit-Reset
          type: integer
        - in: header
          name: X-GitHub-Request-Id
          type: integer
        responses:
          '200':
            description: OK
            schema:
              $ref: '#/definitions/search-users'
          '403':

examples/githubcl-appspec.yaml  view on Meta::CPAN

          name: X-RateLimit-Reset
          type: integer
        - in: header
          name: X-GitHub-Request-Id
          type: integer
        responses:
          '204':
            description: Response if you are following this user.
          '403':
            description: |
              API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
              for details.
          '404':
            description: Response if you are not following this user.
      put:
        description: |
          Follow a user.
          Following a user requires the user to be logged in and authenticated with
          basic auth or OAuth with the user:follow scope.
        parameters:
        - description: Name of user.
          in: path
          name: username
          required: true
          type: string
        - description: |
            You can check the current version of media type in responses.
          in: header
          name: X-GitHub-Media-Type
          type: string
        - description: Is used to set specified media type.
          in: header
          name: Accept
          type: string
        - in: header
          name: X-RateLimit-Limit
          type: integer
        - in: header
          name: X-RateLimit-Remaining
          type: integer
        - in: header
          name: X-RateLimit-Reset
          type: integer
        - in: header
          name: X-GitHub-Request-Id
          type: integer
        responses:
          '204':
            description: You are now following the user.
          '403':
            description: |
              API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
              for details.
    /user/issues:
      get:
        description: |
          List issues.
          List all issues across owned and member repositories for the authenticated
          user.
        parameters:
        - default: all
          description: |
            Issues assigned to you / created by you / mentioning you / you're
            subscribed to updates for / All issues the authenticated user can see
          enum: &34
          - assigned
          - created
          - mentioned
          - subscribed
          - all
          in: query
          name: filter
          required: true
          type: string
        - default: open
          enum: &35
          - open
          - closed
          in: query
          name: state
          required: true
          type: string
        - description: String list of comma separated Label names. Example - bug,ui,@high.
          in: query
          name: labels
          required: true
          type: string
        - default: created
          enum: &36
          - created
          - updated
          - comments
          in: query
          name: sort
          required: true
          type: string
        - default: desc
          enum: &37
          - asc
          - desc
          in: query
          name: direction
          required: true
          type: string
        - description: |
            Optional string of a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
            Only issues updated at or after this time are returned.
          in: query
          name: since
          type: string
        - description: |
            You can check the current version of media type in responses.
          in: header
          name: X-GitHub-Media-Type
          type: string
        - description: Is used to set specified media type.
          in: header
          name: Accept
          type: string
        - in: header
          name: X-RateLimit-Limit
          type: integer
        - in: header
          name: X-RateLimit-Remaining
          type: integer
        - in: header
          name: X-RateLimit-Reset
          type: integer
        - in: header
          name: X-GitHub-Request-Id
          type: integer
        responses:
          '200':
            description: OK
            schema:
              $ref: '#/definitions/issues'
          '403':
            description: |
              API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
              for details.
    /user/keys:
      get:
        description: |
          List your public keys.
          Lists the current user's keys. Management of public keys via the API requires
          that you are authenticated through basic auth, or OAuth with the 'user', 'write:public_key' scopes.
        parameters:
        - description: |
            You can check the current version of media type in responses.
          in: header
          name: X-GitHub-Media-Type
          type: string
        - description: Is used to set specified media type.
          in: header
          name: Accept
          type: string
        - in: header

examples/githubcl-appspec.yaml  view on Meta::CPAN

          type: integer
        - in: header
          name: X-RateLimit-Remaining
          type: integer
        - in: header
          name: X-RateLimit-Reset
          type: integer
        - in: header
          name: X-GitHub-Request-Id
          type: integer
        responses:
          '200':
            description: OK
            schema:
              $ref: '#/definitions/user-keys-keyId'
          '403':
            description: |
              API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
              for details.
    /user/orgs:
      get:
        description: List public and private organizations for the authenticated user.
        parameters:
        - description: |
            You can check the current version of media type in responses.
          in: header
          name: X-GitHub-Media-Type
          type: string
        - description: Is used to set specified media type.
          in: header
          name: Accept
          type: string
        - in: header
          name: X-RateLimit-Limit
          type: integer
        - in: header
          name: X-RateLimit-Remaining
          type: integer
        - in: header
          name: X-RateLimit-Reset
          type: integer
        - in: header
          name: X-GitHub-Request-Id
          type: integer
        responses:
          '200':
            description: OK
            schema:
              $ref: '#/definitions/gitignore'
          '403':
            description: |
              API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
              for details.
    /user/repos:
      get:
        description: |
          List repositories for the authenticated user. Note that this does not include
          repositories owned by organizations which the user can access. You can lis
          user organizations and list organization repositories separately.
        parameters:
        - default: all
          enum: &38
          - all
          - public
          - private
          - forks
          - sources
          - member
          in: query
          name: type
          type: string
        - description: |
            You can check the current version of media type in responses.
          in: header
          name: X-GitHub-Media-Type
          type: string
        - description: Is used to set specified media type.
          in: header
          name: Accept
          type: string
        - in: header
          name: X-RateLimit-Limit
          type: integer
        - in: header
          name: X-RateLimit-Remaining
          type: integer
        - in: header
          name: X-RateLimit-Reset
          type: integer
        - in: header
          name: X-GitHub-Request-Id
          type: integer
        responses:
          '200':
            description: OK
            schema:
              $ref: '#/definitions/repos'
          '403':
            description: |
              API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
              for details.
      post:
        description: |
          Create a new repository for the authenticated user. OAuth users must supply
          repo scope.
        parameters:
        - description: |
            You can check the current version of media type in responses.
          in: header
          name: X-GitHub-Media-Type
          type: string
        - description: Is used to set specified media type.
          in: header
          name: Accept
          type: string
        - in: header
          name: X-RateLimit-Limit
          type: integer
        - in: header
          name: X-RateLimit-Remaining
          type: integer
        - in: header
          name: X-RateLimit-Reset
          type: integer
        - in: header
          name: X-GitHub-Request-Id
          type: integer
        - in: body
          name: body
          required: true
          schema:
            $ref: '#/definitions/postRepo'
        responses:
          '201':
            description: Created
            schema:
              $ref: '#/definitions/repos'
          '403':
            description: |
              API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
              for details.
    /user/starred:
      get:
        description: List repositories being starred by the authenticated user.
        parameters:
        - description: Ignored without 'sort' parameter.
          in: query
          name: direction
          type: string
        - default: created
          description: ''
          enum: &39
          - created
          - updated
          in: query
          name: sort
          type: string
        - description: |
            You can check the current version of media type in responses.
          in: header
          name: X-GitHub-Media-Type
          type: string
        - description: Is used to set specified media type.
          in: header
          name: Accept
          type: string
        - in: header
          name: X-RateLimit-Limit
          type: integer
        - in: header
          name: X-RateLimit-Remaining
          type: integer
        - in: header
          name: X-RateLimit-Reset
          type: integer
        - in: header
          name: X-GitHub-Request-Id
          type: integer
        responses:
          '200':
            description: OK
            schema:
              $ref: '#/definitions/gitignore'
          '403':
            description: |
              API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
              for details.
    /user/starred/{owner}/{repo}:
      delete:
        description: Unstar a repository
        parameters:
        - description: Name of a repository owner.
          in: path
          name: owner
          required: true
          type: string
        - description: Name of a repository.
          in: path
          name: repo
          required: true
          type: string
        - description: |
            You can check the current version of media type in responses.
          in: header
          name: X-GitHub-Media-Type
          type: string
        - description: Is used to set specified media type.
          in: header
          name: Accept
          type: string

examples/githubcl-appspec.yaml  view on Meta::CPAN

          name: X-RateLimit-Limit
          type: integer
        - in: header
          name: X-RateLimit-Remaining
          type: integer
        - in: header
          name: X-RateLimit-Reset
          type: integer
        - in: header
          name: X-GitHub-Request-Id
          type: integer
        responses:
          '403':
            description: |
              API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
              for details.
    /users/{username}/received_events/public:
      get:
        description: List public events that a user has received
        parameters:
        - description: Name of user.
          in: path
          name: username
          required: true
          type: string
        - description: |
            You can check the current version of media type in responses.
          in: header
          name: X-GitHub-Media-Type
          type: string
        - description: Is used to set specified media type.
          in: header
          name: Accept
          type: string
        - in: header
          name: X-RateLimit-Limit
          type: integer
        - in: header
          name: X-RateLimit-Remaining
          type: integer
        - in: header
          name: X-RateLimit-Reset
          type: integer
        - in: header
          name: X-GitHub-Request-Id
          type: integer
        responses:
          '403':
            description: |
              API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
              for details.
    /users/{username}/repos:
      get:
        description: List public repositories for the specified user.
        parameters:
        - description: Name of user.
          in: path
          name: username
          required: true
          type: string
        - default: all
          enum: &40
          - all
          - public
          - private
          - forks
          - sources
          - member
          in: query
          name: type
          type: string
        - description: |
            You can check the current version of media type in responses.
          in: header
          name: X-GitHub-Media-Type
          type: string
        - description: Is used to set specified media type.
          in: header
          name: Accept
          type: string
        - in: header
          name: X-RateLimit-Limit
          type: integer
        - in: header
          name: X-RateLimit-Remaining
          type: integer
        - in: header
          name: X-RateLimit-Reset
          type: integer
        - in: header
          name: X-GitHub-Request-Id
          type: integer
        responses:
          '200':
            description: OK
            schema:
              $ref: '#/definitions/repos'
          '403':
            description: |
              API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
              for details.
    /users/{username}/starred:
      get:
        description: List repositories being starred by a user.
        parameters:
        - description: Name of user.
          in: path
          name: username
          required: true
          type: string
        - description: |
            You can check the current version of media type in responses.
          in: header
          name: X-GitHub-Media-Type
          type: string
        - description: Is used to set specified media type.
          in: header
          name: Accept
          type: string
        - in: header
          name: X-RateLimit-Limit

examples/githubcl-appspec.yaml  view on Meta::CPAN

        - name: username
          required: 1
          summary: Name of the user.
          type: string
        summary: Check public membership.
      /orgs/:org/repos:
        options:
        - enum: *14
          name: q-type
          required: ~
          summary: ~
          type: string
        parameters:
        - name: org
          required: 1
          summary: Name of organisation.
          type: string
        summary: List repositories for the specified org....
      /orgs/:org/teams:
        options: []
        parameters:
        - name: org
          required: 1
          summary: Name of organisation.
          type: string
        summary: List teams.
      /rate_limit:
        options: []
        parameters: []
        summary: Get your current rate limit status...
      /repos/:owner/:repo:
        options: []
        parameters:
        - name: owner
          required: 1
          summary: Name of repository owner.
          type: string
        - name: repo
          required: 1
          summary: Name of repository.
          type: string
        summary: Get repository.
      /repos/:owner/:repo/:archive_format/:path:
        options: []
        parameters:
        - name: owner
          required: 1
          summary: Name of repository owner.
          type: string
        - name: repo
          required: 1
          summary: Name of repository.
          type: string
        - enum: *25
          name: archive_format
          required: 1
          summary: ~
          type: string
        - name: path
          required: 1
          summary: Valid Git reference, defaults to 'master'.
          type: string
        summary: Get archive link.
      /repos/:owner/:repo/assignees:
        options: []
        parameters:
        - name: owner
          required: 1
          summary: Name of repository owner.
          type: string
        - name: repo
          required: 1
          summary: Name of repository.
          type: string
        summary: List assignees.
      /repos/:owner/:repo/assignees/:assignee:
        options: []
        parameters:
        - name: owner
          required: 1
          summary: Name of repository owner.
          type: string
        - name: repo
          required: 1
          summary: Name of repository.
          type: string
        - name: assignee
          required: 1
          summary: Login of the assignee.
          type: string
        summary: Check assignee.
      /repos/:owner/:repo/branches:
        options: []
        parameters:
        - name: owner
          required: 1
          summary: Name of repository owner.
          type: string
        - name: repo
          required: 1
          summary: Name of repository.
          type: string
        summary: Get list of branches
      /repos/:owner/:repo/branches/:branch:
        options: []
        parameters:
        - name: owner
          required: 1
          summary: Name of repository owner.
          type: string
        - name: repo
          required: 1
          summary: Name of repository.
          type: string
        - name: branch
          required: 1
          summary: Name of the branch.
          type: string
        summary: Get Branch
      /repos/:owner/:repo/collaborators:
        options: []



( run in 0.564 second using v1.01-cache-2.11-cpan-cdf2f3d4e48 )