Codacy People API

openapi: 3.2.0
info:
  title: Codacy People API
  description: 'Codacy API v3 reference.


    Import the OpenAPI 3.0.1 definition into your development tools to help bootstrap your integration with Codacy.

    For more information see Using the Codacy API.'
  contact:
    name: Codacy Team
    url: https://www.codacy.com
    email: code@codacy.com
  license:
    name: Codacy. All rights reserved
    url: https://www.codacy.com
  version: 3.1.0
servers:
- url: https://api.codacy.com/api/v3
security:
- ApiKeyAuth: []
tags:
- name: People
paths:
  /organizations/{provider}/{remoteOrganizationName}/people:
    get:
      tags:
      - People
      summary: List people of an organization
      operationId: listPeopleFromOrganization
      parameters:
      - $ref: '#/components/parameters/providerParam'
      - $ref: '#/components/parameters/remoteOrganizationNameParam'
      - $ref: '#/components/parameters/cursorParam'
      - $ref: '#/components/parameters/limitParam'
      - $ref: '#/components/parameters/searchParam'
      - $ref: '#/components/parameters/onlyMembersParam'
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListPeopleResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '422':
          $ref: '#/components/responses/UnprocessableEntity'
        '500':
          $ref: '#/components/responses/InternalServerError'
      x-jvm-package: organization
    post:
      tags:
      - People
      summary: Add people to organization
      description: Add people to organization as members or committers (depending if they have a pending request already)
      operationId: addPeopleToOrganization
      parameters:
      - $ref: '#/components/parameters/providerParam'
      - $ref: '#/components/parameters/remoteOrganizationNameParam'
      requestBody:
        $ref: '#/components/requestBodies/emailListParam'
      responses:
        '204':
          description: Successful operation
          content: {}
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '422':
          $ref: '#/components/responses/UnprocessableEntity'
        '500':
          $ref: '#/components/responses/InternalServerError'
      x-jvm-package: organization
  /organizations/{provider}/{remoteOrganizationName}/peopleCsv:
    get:
      tags:
      - People
      summary: Generate a CSV file listing the people of an organization
      description: Generate a CSV file containing the `name`, `email`, `lastLogin`, and `lastAnalysis` of each person of the organization
      operationId: listPeopleFromOrganizationCsv
      parameters:
      - $ref: '#/components/parameters/providerParam'
      - $ref: '#/components/parameters/remoteOrganizationNameParam'
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: string
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '422':
          $ref: '#/components/responses/UnprocessableEntity'
        '500':
          $ref: '#/components/responses/InternalServerError'
      x-jvm-package: peopleCsv
  /organizations/{provider}/{remoteOrganizationName}/people/remove:
    post:
      tags:
      - People
      summary: Remove people from an organization
      operationId: removePeopleFromOrganization
      parameters:
      - $ref: '#/components/parameters/providerParam'
      - $ref: '#/components/parameters/remoteOrganizationNameParam'
      requestBody:
        description: List of committers/members to remove
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RemovePeopleBody'
        required: true
      responses:
        '200':
          description: Remove people response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RemovePeopleResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          $ref: '#/components/responses/Conflict'
        '422':
          $ref: '#/components/responses/UnprocessableEntity'
        '500':
          $ref: '#/components/responses/InternalServerError'
      x-jvm-package: organization
      x-codegen-request-body-name: removePeopleParameter
  /organizations/{provider}/{remoteOrganizationName}/people/suggestions:
    get:
      tags:
      - People
      summary: List people suggestions for an organization
      operationId: peopleSuggestionsForOrganization
      parameters:
      - $ref: '#/components/parameters/providerParam'
      - $ref: '#/components/parameters/remoteOrganizationNameParam'
      - $ref: '#/components/parameters/cursorParam'
      - $ref: '#/components/parameters/limitParam'
      - $ref: '#/components/parameters/searchParam'
      responses:
        '200':
          description: List people suggestions response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuggestedAuthorsResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '422':
          $ref: '#/components/responses/UnprocessableEntity'
        '500':
          $ref: '#/components/responses/InternalServerError'
      x-jvm-package: organization
  /organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/people/suggestions:
    get:
      tags:
      - People
      summary: List people suggestions for a repository
      operationId: peopleSuggestionsForRepository
      parameters:
      - $ref: '#/components/parameters/providerParam'
      - $ref: '#/components/parameters/remoteOrganizationNameParam'
      - $ref: '#/components/parameters/repositoryNameParam'
      - $ref: '#/components/parameters/cursorParam'
      - $ref: '#/components/parameters/limitParam'
      - $ref: '#/components/parameters/searchParam'
      responses:
        '200':
          description: List people suggestions response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RepositorySuggestedAuthorsResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '422':
          $ref: '#/components/responses/UnprocessableEntity'
        '500':
          $ref: '#/components/responses/InternalServerError'
      x-jvm-package: repository
components:
  schemas:
    NotFound:
      allOf:
      - $ref: '#/components/schemas/ApiError'
      - required:
        - error
        type: object
        properties:
          error:
            type: string
            default: NotFound
    Person:
      required:
      - canBeRemoved
      - email
      - emails
      type: object
      properties:
        name:
          type: string
          description: The name of the person
          example: John Smith
        email:
          type: string
          description: '[deprecated: use emails instead] The email of the person'
          example: johnsmith@emailprovider.com
        emails:
          type: array
          description: The emails of the person
          example:
          - johnsmith@emailprovider.com
          items:
            type: string
        userId:
          type: integer
          description: User ID internal to Codacy.
          format: int64
          example: 1234
        committerId:
          type: integer
          description: Commit author ID
          format: int64
          example: 1234
        lastLogin:
          type: string
          format: date-time
          example: '2020-11-05T15:39:13.43Z'
          x-scala-type: java.time.Instant
        lastAnalysis:
          type: string
          description: Date and time when Codacy last analyzed a commit from this person.
          format: date-time
          example: '2020-11-05T15:39:13.43Z'
          x-scala-type: java.time.Instant
        isActive:
          type: boolean
          description: 'Whether the person is an active committer on Codacy or not. If null, the person is not a committer, thus they do not occupy a seat. Applies only to specific Enterprise plans.

            '
        canBeRemoved:
          type: boolean
          description: Whether the person can be removed from the organization or not
        lastCommitId:
          type: integer
          format: int64
          example: 2335557754
        providerId:
          type: string
          description: ID of the person on the Git provider
        providerLogin:
          type: string
          description: Username of the person on the Git provider
        isProviderRegistered:
          type: boolean
          description: True if the person is registered on the Git provider
      description: Representation of a person that belongs to an organization
    ApiError:
      required:
      - actions
      - message
      type: object
      properties:
        message:
          type: string
        innerMessage:
          type: string
        actions:
          type: array
          items:
            $ref: '#/components/schemas/ProblemLink'
    RemovePeopleBody:
      required:
      - emails
      type: object
      properties:
        emails:
          type: array
          description: List of emails to add
          items:
            type: string
    Forbidden:
      allOf:
      - $ref: '#/components/schemas/ApiError'
      - required:
        - error
        type: object
        properties:
          error:
            type: string
            default: Forbidden
    RemovePeopleEmailStatus:
      required:
      - email
      type: object
      properties:
        email:
          type: string
        error:
          type: string
    BadRequest:
      allOf:
      - $ref: '#/components/schemas/ApiError'
      - required:
        - error
        type: object
        properties:
          error:
            type: string
            default: BadRequest
    SuggestedAuthorsResponse:
      required:
      - data
      type: object
      properties:
        pagination:
          $ref: '#/components/schemas/PaginationInfo'
        data:
          type: array
          items:
            $ref: '#/components/schemas/SuggestedAuthor'
    ProjectCommitStat:
      required:
      - numberOfCommits
      - projectId
      type: object
      properties:
        projectId:
          type: integer
          format: int64
        firstCommit:
          type: string
          format: date-time
          x-scala-type: java.time.Instant
        lastCommit:
          type: string
          format: date-time
          x-scala-type: java.time.Instant
        numberOfCommits:
          type: integer
          format: int64
    UnprocessableEntity:
      allOf:
      - $ref: '#/components/schemas/ApiError'
      - required:
        - error
        type: object
        properties:
          error:
            type: string
            default: UnprocessableEntity
    RepositorySuggestedAuthorsResponse:
      required:
      - data
      type: object
      properties:
        pagination:
          $ref: '#/components/schemas/PaginationInfo'
        data:
          type: array
          items:
            $ref: '#/components/schemas/RepositorySuggestedAuthor'
    RepositorySuggestedAuthor:
      required:
      - commitEmail
      - projectCommitStat
      type: object
      properties:
        commitEmail:
          type: string
        projectCommitStat:
          $ref: '#/components/schemas/ProjectCommitStat'
    RemovePeopleResponse:
      type: object
      properties:
        success:
          type: array
          items:
            $ref: '#/components/schemas/RemovePeopleEmailStatus'
        failed:
          type: array
          items:
            $ref: '#/components/schemas/RemovePeopleEmailStatus'
    ListPeopleResponse:
      required:
      - data
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Person'
        pagination:
          $ref: '#/components/schemas/PaginationInfo'
    InternalServerError:
      allOf:
      - $ref: '#/components/schemas/ApiError'
      - required:
        - error
        type: object
        properties:
          error:
            type: string
            default: InternalServerError
    PaginationInfo:
      type: object
      properties:
        cursor:
          type: string
          description: Cursor to [request the next batch of results](https://docs.codacy.com/codacy-api/using-the-codacy-api/#using-pagination)
        limit:
          type: integer
          description: Maximum number of items returned
          format: int32
        total:
          type: integer
          description: Total number of items returned
          format: int32
      description: Cursor-based pagination information to obtain more items
    ProblemLink:
      required:
      - name
      - url
      type: object
      properties:
        name:
          type: string
          example: Check our documentation
        url:
          type: string
          example: https://docs.codacy.com/faq/troubleshooting/why-isnt-my-public-repository-being-analyzed/
    SuggestedAuthor:
      required:
      - commitEmail
      - projectCommitStats
      - totalCommits
      - totalProjects
      type: object
      properties:
        commitEmail:
          type: string
        totalProjects:
          type: integer
          format: int64
        totalCommits:
          type: integer
          format: int64
        lastCommit:
          type: string
          format: date-time
          x-scala-type: java.time.Instant
        projectCommitStats:
          type: array
          items:
            $ref: '#/components/schemas/ProjectCommitStat'
    Unauthorized:
      allOf:
      - $ref: '#/components/schemas/ApiError'
      - required:
        - code
        - error
        type: object
        properties:
          error:
            type: string
            default: Unauthorized
          code:
            type: string
            default: Unauthorized
    Conflict:
      allOf:
      - $ref: '#/components/schemas/ApiError'
      - required:
        - error
        type: object
        properties:
          error:
            type: string
            default: Conflict
  responses:
    NotFound:
      description: Not Found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/NotFound'
      x-ms-error-response: true
    Conflict:
      description: Conflict
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Conflict'
      x-ms-error-response: true
    UnprocessableEntity:
      description: Unprocessable Entity
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/UnprocessableEntity'
      x-ms-error-response: true
    Forbidden:
      description: Forbidden
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Forbidden'
      x-ms-error-response: true
    BadRequest:
      description: Bad Request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/BadRequest'
      x-ms-error-response: true
    Unauthorized:
      description: Unauthorized
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Unauthorized'
      x-ms-error-response: true
    InternalServerError:
      description: Internal Server Error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/InternalServerError'
      x-ms-error-response: true
  parameters:
    repositoryNameParam:
      name: repositoryName
      in: path
      description: Repository name on the Git provider organization
      required: true
      schema:
        type: string
        x-ms-parameter-location: method
      example: awesome-repo
      x-ms-parameter-location: method
    remoteOrganizationNameParam:
      name: remoteOrganizationName
      in: path
      description: Organization name on the Git provider
      required: true
      schema:
        type: string
        x-ms-parameter-location: method
      example: codacy
      x-ms-parameter-location: method
    cursorParam:
      name: cursor
      in: query
      description: Cursor to [specify a batch of results to request](https://docs.codacy.com/codacy-api/using-the-codacy-api/#using-pagination)
      schema:
        type: string
        x-ms-parameter-location: method
      example: Yms345gh==
      x-ms-parameter-location: method
    searchParam:
      name: search
      in: query
      description: Filter results by searching for this string
      schema:
        type: string
        x-ms-parameter-location: method
      example: my-repository-name
      x-ms-parameter-location: method
    providerParam:
      name: provider
      in: path
      description: Git provider identifier (e.g., gh for GitHub, gl for GitLab, bb for Bitbucket)
      required: true
      schema:
        type: string
        x-ms-parameter-location: method
      example: gh
      x-ms-parameter-location: method
    limitParam:
      name: limit
      in: query
      description: Maximum number of items to return
      schema:
        maximum: 100
        minimum: 1
        type: integer
        format: int32
        default: 100
        x-ms-parameter-location: method
      example: 20
      x-ms-parameter-location: method
    onlyMembersParam:
      name: onlyMembers
      in: query
      description: If true, returns only Codacy users. If false, returns also commit authors that are not Codacy users.
      schema:
        type: boolean
        default: false
        x-ms-parameter-location: method
      example: true
      x-ms-parameter-location: method
  requestBodies:
    emailListParam:
      description: List of emails
      content:
        application/json:
          schema:
            type: array
            items:
              type: string
      required: true
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      description: Learn how to [generate an account API token](https://docs.codacy.com/codacy-api/api-tokens/#account-api-tokens)
      name: api-token
      in: header
    ProjectTokenAuth:
      type: apiKey
      name: project-token
      in: header
      description: 'Repository API token. Accepted only by repository-scoped operations that declare it.

        Create one with [createRepositoryApiToken](#createrepositoryapitoken)

        '
x-provenance:
  method: harvested
  publisher: Codacy
  source: https://api.codacy.com/api/api-docs/swagger.yaml
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)