API-CLI

 view release on metacpan or  search on metacpan

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

          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
          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.
    patch:
      description: Mark a thread as read
      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
          type: integer
        - in: header
          name: X-GitHub-Request-Id
          type: integer
      responses:
        '205':
          description: Thread marked as read.
        '403':
          description: |
            API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
            for details.
  '/notifications/threads/{id}/subscription':
    delete:
      description: Delete a Thread Subscription.
      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
          type: integer
        - in: header
          name: X-GitHub-Request-Id
          type: integer
      responses:
        '204':
          description: |
            No Content
        '403':
          description: |
            API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
            for details.
    get:
      description: Get a Thread Subscription.
      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
          type: integer
        - in: header
          name: X-GitHub-Request-Id
          type: integer
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/subscription'
        '403':
          description: |
            API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
            for details.
    put:
      description: |
        Set a Thread Subscription.
        This lets you subscribe to a thread, or ignore it. Subscribing to a thread
        is unnecessary if the user is already subscribed to the repository. Ignoring
        a thread will mute all future notifications (until you comment or get @mentioned).
      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
          type: integer
        - in: header
          name: X-GitHub-Request-Id
          type: integer
        - in: body
          name: body
          required: true
          schema:
            $ref: '#/definitions/putSubscription'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/subscription'
        '403':
          description: |
            API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
            for details.
  '/orgs/{org}':
    get:
      description: Get 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

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

              type: object
          type: object
        body:
          type: string
        commit_id:
          type: string
        created_at:
          description: 'ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ'
          type: string
        id:
          type: integer
        path:
          type: string
        position:
          type: integer
        updated_at:
          description: 'ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ'
          type: string
        url:
          type: string
        user:
          properties:
            avatar_url:
              type: string
            gravatar_id:
              type: string
            id:
              type: integer
            login:
              type: string
            url:
              type: string
          type: object
      type: object
    type: array
  pullsPost:
    properties:
      base:
        type: string
      body:
        type: string
      head:
        type: string
      title:
        type: string
    type: object
  punchCardStats:
    items:
      type: integer
    type: array
  putSubscription:
    properties:
      created_at:
        type: string
      ignored:
        type: boolean
      reason:
        type: object
      subscribed:
        type: boolean
      thread_url:
        type: string
      url:
        type: string
    type: object
  rate_limit:
    properties:
      rate:
        properties:
          limit:
            type: integer
          remaining:
            type: integer
          reset:
            type: integer
    type: object
  readme:
    properties:
      _links:
        properties:
          git:
            type: string
          html:
            type: string
          self:
            type: string
        type: object
      content:
        type: string
      encoding:
        type: string
      git_url:
        type: string
      html_url:
        type: string
      name:
        type: string
      path:
        type: string
      sha:
        type: string
      size:
        type: integer
      type:
        type: string
      url:
        type: string
    type: object
  ref:
    items:
      properties:
        created_at:
          description: 'ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ'
          type: string
        creator:
          properties:
            avatar_url:
              type: string
            gravatar_id:
              type: string
            id:

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

              type: integer
            repos:
              type: integer
            score:
              type: number
            type:
              type: string
            username:
              type: string
          type: object
        type: array
    type: object
  stargazers:
    items:
      properties:
        avatar_url:
          type: string
        gravatar_id:
          type: string
        id:
          type: integer
        login:
          type: string
        url:
          type: string
      type: object
    type: array
  subscribition:
    properties:
      created_at:
        description: 'ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ'
        type: string
      ignored:
        type: boolean
      reason:
        type: string
      repository_url:
        type: string
      subscribed:
        type: boolean
      url:
        type: string
    type: object
  subscribitionBody:
    properties:
      ignored:
        type: boolean
      subscribed:
        type: boolean
    type: object
  subscription:
    properties:
      created_at:
        type: string
      ignored:
        type: boolean
      reason:
        type: boolean
      subscribed:
        type: boolean
      thread_url:
        type: string
      url:
        type: string
    type: object
  tag:
    properties:
      message:
        type: string
      object:
        properties:
          sha:
            type: string
          type:
            type: string
          url:
            type: string
        type: object
      sha:
        type: string
      tag:
        type: string
      tagger:
        properties:
          date:
            description: 'ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ'
            type: string
          email:
            type: string
          name:
            type: string
        type: object
      url:
        type: string
    type: object
  tags:
    properties:
      message:
        description: String of the tag message.
        type: string
      object:
        description: String of the SHA of the git object this is tagging.
        type: string
      tag:
        type: string
      tagger:
        properties:
          date:
            description: Timestamp of when this object was tagged.
            type: string
          email:
            description: String of the email of the author of the tag.
            type: string
          name:
            description: String of the name of the author of the tag.
            type: string
        type: object
      type:
        description: String of the type of the object we’re tagging. Normally this is a commit but it can also be a tree or a blob.
        type: string
    required: