view release on metacpan or  search on metacpan

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

          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
          type: integer
        - in: header

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

          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:
            - 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:
            - 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:
            - 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:
            - 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:
            - 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:
            - 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:
            - 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:
            - 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':
          description: |
            API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting
            for details.
  '/teams/{teamId}':
    delete:
      description: |
        Delete team.
        In order to delete a team, the authenticated user must be an owner of the
        org that the team is associated with.
      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.
          in: header
          name: Accept
          type: string
        - in: header
          name: X-RateLimit-Limit