API-CLI

 view release on metacpan or  search on metacpan

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

          name:
            type: string
          url:
            type: string
        type: object
      type: array
    orgTeamsPost:
      properties:
        name:
          type: string
        permission:
          enum:
          - pull
          - push
          - admin
        repo_names:
          items:
            type: string
          type: array
      required:
      - name
      type: object
    organization:
      properties:
        avatar_url:
          type: string
        blog:
          type: string
        company:
          type: string
        created_at:
          description: 'ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ'
          type: string
        email:
          type: string
        followers:
          type: integer
        following:
          type: integer
        html_url:
          type: string
        id:
          type: integer
        location:
          type: string
        login:
          type: string
        name:
          type: string
        public_gists:
          type: integer
        public_repos:
          type: integer
        type:
          type: string
        url:
          type: string
      type: object
    organizationAsTeamMember:
      properties:
        errors:
          items:
            properties:
              code:
                type: string
              field:
                type: string
              resource:
                type: string
            type: object
          type: array
        message:
          type: string
      type: object
    participationStats:
      properties:
        all:
          items:
            type: integer
          type: array
        owner:
          items:
            type: integer
          type: array
      type: object
    patchGist:
      properties:
        description:
          type: string
        files:
          properties:
            delete_this_file.txt:
              type: string
            file1.txt:
              properties:
                content:
                  type: string
              type: object
            new_file.txt:
              properties:
                content:
                  type: string
              type: object
            old_name.txt:
              properties:
                content:
                  type: string
                filename:
                  type: string
              type: object
      type: object
    patchOrg:
      properties:
        billing_email:
          description: Billing email address. This address is not publicized.
          type: string
        company:
          type: string
        email:
          description: Publicly visible email address.
          type: string

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

        description: Merge a pull request (Merge Button's)
        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 pull.
          in: path
          name: number
          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/mergePullBody'
        responses:
          '200':
            description: Response if merge was successful.
            schema:
              $ref: '#/definitions/merge'
          '403':
            description: |
              API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
              for details.
          '405':
            description: Response if merge cannot be performed.
            schema:
              $ref: '#/definitions/merge'
    /repos/{owner}/{repo}/readme:
      get:
        description: |
          Get the README.
          This method returns the preferred README 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
        - description: The String name of the Commit/Branch/Tag. Defaults to master.
          in: query
          name: ref
          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/contents-path'
          '403':
            description: |
              API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
              for details.
    /repos/{owner}/{repo}/releases:
      get:
        description: Users with push access to the repository will receive all releases
          (i.e., published releases and draft releases). Users with pull access will
          receive published releases only
        parameters:
        - description: Name of repository owner.
          in: path
          name: owner
          required: true
          type: string
        - description: Name of repository.
          in: path
          name: repo
          required: true

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:
          '403':
            description: |
              API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
              for details.
    /users/{username}/subscriptions:
      get:
        description: List repositories being watched 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
          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.
  produces:
  - application/json
  schemes:
  - https
  securityDefinitions:
    oauth_2_0:
      authorizationUrl: https://github.com/login/oauth/authorize
      description: |
        OAuth2 is a protocol that lets external apps request authorization to private
        details in a user's GitHub account without getting their password. This is
        preferred over Basic Authentication because tokens can be limited to specific
        types of data, and can be revoked by users at any time.
      flow: accessCode
      scopes:
        admin:org: ''
        admin:org_hook: ''
        admin:public_key: ''
        admin:repo_hook: ''
        delete_repo: ''
        gist: ''
        notifications: ''
        public_repo: ''
        read:org: ''
        read:public_key: ''
        read:repo_hook: ''
        repo: ''
        repo:status: ''
        repo_deployment: ''
        user: ''
        user:email: ''
        user:follow: ''
        write:org: ''
        write:public_key: ''
        write:repo_hook: ''
      tokenUrl: https://github.com/login/oauth/access_token
      type: oauth2
  swagger: '2.0'
  x-hasEquivalentPaths: true
options:
- name: data-file
  summary: File with data for POST/PUT/PATCH/DELETE requests
  type: file
- aliases:
  - d
  name: debug
  summary: debug
  type: flag
- aliases:
  - v
  name: verbose
  summary: verbose
  type: flag
subcommands:
  DELETE:
    op: apicall
    subcommands:
      /gists/:id:
        options: []
        parameters:
        - name: id
          required: 1
          summary: Id of gist.
          type: integer
        summary: Delete a gist.
      /gists/:id/comments/:commentId:
        options: []
        parameters:
        - name: id
          required: 1
          summary: Id of gist.
          type: integer