API-CLI

 view release on metacpan or  search on metacpan

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

          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:
            - 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:
            - 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:
            - 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:
            - 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:
            - 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
        - 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-openapi.yaml  view on Meta::CPAN

        - description: Id of comment.
          in: path
          name: commentId
          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
        - in: body
          name: body
          required: true
          schema:
            $ref: '#/definitions/commentBody'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/commitComments'
        '403':
          description: |
            API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
            for details.
  '/repos/{owner}/{repo}/commits':
    get:
      description: List commits on 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
        - 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: Sha or branch to start listing commits from.
          in: query
          name: sha
          type: string
        - description: Only commits containing this file path will be returned.
          in: query
          name: path
          type: string
        - description: 'GitHub login, name, or email by which to filter by commit author.'
          in: query
          name: author
          type: string
        - description: ISO 8601 Date - Only commits before this date will be returned.
          in: query
          name: until
          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/commits'
        '403':
          description: |
            API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
            for details.
  '/repos/{owner}/{repo}/commits/{ref}/status':
    get:
      description: |
        Get the combined Status for a specific Ref
        The Combined status endpoint is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the blog post for full details.
        To access this endpoint during the preview period, you must provide a custom media type in the Accept header:
        application/vnd.github.she-hulk-preview+json
      parameters:
        - description: Name of repository owner.
          in: path
          name: owner
          required: true
          type: string
        - description: Name of repository.
          in: path

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

        '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}/stats/code_frequency':
    get:
      description: |
        Get the number of additions and deletions per week.
        Returns a weekly aggregate of the number of additions and deletions pushed
        to 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
        - 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/codeFrequencyStats'
        '403':
          description: |
            API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
            for details.
  '/repos/{owner}/{repo}/stats/commit_activity':
    get:
      description: |
        Get the last year of commit activity data.
        Returns the last year of commit activity grouped by week. The days array
        is a group of commits per day, starting on Sunday.
      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/commitActivityStats'
        '403':
          description: |
            API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
            for details.
  '/repos/{owner}/{repo}/stats/contributors':
    get:
      description: 'Get contributors list with additions, deletions, and commit counts.'
      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