API-CLI

 view release on metacpan or  search on metacpan

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

          name: X-GitHub-Request-Id
          type: integer
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/teams'
        '403':
          description: |
            API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
            for details.
    post:
      description: |
        Create team.
        In order to create a team, the authenticated user must be an owner of 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
        - in: body
          name: body
          required: true
          schema:
            $ref: '#/definitions/orgTeamsPost'
      responses:
        '201':
          description: Created
          schema:
            $ref: '#/definitions/team'
        '403':
          description: |
            API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
            for details.
  /rate_limit:
    get:
      description: |
        Get your current rate limit status
        Note: Accessing this endpoint does not count against your rate limit.
      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/rate_limit'
        '403':
          description: |
            API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
            for details.
  '/repos/{owner}/{repo}':
    delete:
      description: |
        Delete a Repository.
        Deleting a repository requires admin access. If OAuth is used, the delete_repo
        scope is required.
      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

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

          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
          name: repo
          required: true
          type: string
        - in: path
          name: ref
          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/refStatus'
        '403':
          description: |
            API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
            for details.
  '/repos/{owner}/{repo}/commits/{shaCode}':
    get:
      description: Get a single commit.
      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

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

          type: integer
      responses:
        '204':
          description: Team member removed.
        '403':
          description: |
            API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
            for details.
    get:
      description: |
        Get team membership.
        In order to get a user's membership with a team, the authenticated user must be a member of the team or an owner of the team's organization.
      parameters:
        - description: Id of team.
          in: path
          name: teamId
          required: true
          type: integer
        - description: Name of a member.
          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:
        '200':
          description: User is a member.
          schema:
            $ref: '#/definitions/teamMembership'
        '403':
          description: |
            API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
            for details.
        '404':
          description: User has no membership with team
    put:
      description: |
        Add team membership.
        In order to add a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with.

        If the user is already a part of the team's organization (meaning they're on at least one other team in the organization), this endpoint will add the user to the team.

        If the user is completely unaffiliated with the team's organization (meaning they're on none of the organization's teams), this endpoint will send an invitation to the user via email. This newly-created membership will be in the 'pending' sta...
      parameters:
        - description: Id of team.
          in: path
          name: teamId
          required: true
          type: integer
        - description: Name of a member.
          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:
        '200':
          description: Team member added.
          schema:
            $ref: '#/definitions/teamMembership'
        '403':
          description: |
            API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
            for details.
        '422':
          description: 'If you attempt to add an organization to a team, you will get this.'
          schema:
            $ref: '#/definitions/organizationAsTeamMember'
  '/teams/{teamId}/repos':
    get:
      description: List team repos
      parameters:
        - description: Id of team.
          in: path
          name: teamId
          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.