openapi.yaml

openapi: 3.0.3
info:
  contact:
    email: admin@athenian.co
    name: the admins by email
  description: |-
    Server version: {{ server_version }} built on {{ build_date }} @ [{{ commit }}](https://github.com/athenianco/athenian-api/commit/{{ commit }})
  license:
    name: CC-BY-4.0
  title: '{{ title }}'
  version: 1.0.99
servers:
- description: '{{ server_description }} - {{ server_url }}'
  url: '{{ server_url }}/v1'
paths:
  /account/user:
    put:
      operationId: change_user
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AccountUserChangeRequest'
        x-body-name: body
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Account'
          description: Effective account members.
        403:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenericError'
          description: Requesting user is not an admin of the account.
        404:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenericError'
          description: The account was not found.
      security:
      - bearerAuth: []
      summary: 'Change the status of an account member: regular, admin, or banished
        (deleted). This endpoint is allowed only for account admins.'
      tags:
      - user
# {% if False %}
      - default
# {% endif %}
      x-openapi-router-controller: athenian.api.controllers.user_controller
      x-codegen-request-body-name: body
  /account/{id}/features:
    get:
      operationId: get_account_features
      parameters:
      - description: Numeric identifier of the account. The user must belong to that
          account. To find out which accounts the user belongs to, see `/user`.
        explode: false
        in: path
        name: id
        required: true
        schema:
          type: integer
        style: simple
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProductFeatures'
          description: List of the enabled product features for the account.
        403:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenericError'
          description: The user does not have access to this account.
        404:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenericError'
          description: The account was not found.
      security:
      - bearerAuth: []
      summary: List the product features enabled for the account.
      tags:
      - user
# {% if False %}
      - default
# {% endif %}
      x-openapi-router-controller: athenian.api.controllers.user_controller
      x-codegen-request-body-name: body
  /account/{id}/members:
    get:
      operationId: get_account_members
      parameters:
      - description: Numeric identifier of the account. The user must belong to that
          account. To find out which accounts the user belongs to, see `/user`.
        explode: false
        in: path
        name: id
        required: true
        schema:
          type: integer
        style: simple
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Account'
          description: List of the account members.
        403:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenericError'
          description: The user does not have access to this account.
        404:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenericError'
          description: The account was not found.
      security:
      - bearerAuth: []
      - apiKeyAuth: []
      summary: List the current user's account members.
      tags:
      - user
# {% if False %}
      - default
# {% endif %}
      x-openapi-router-controller: athenian.api.controllers.user_controller
      x-codegen-request-body-name: body
  /become:
    get:
      operationId: become_user
      parameters:
      - description: Numeric identifier of the user to turn into.
        explode: false
        in: query
        name: id
        required: false
        schema:
          type: string
        style: simple
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/User'
          description: Details of the new active user, the same as `/user`.
        403:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenericError'
          description: Current user is not allowed to mutate.
        404:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenericError'
          description: Requested user does not exist.
      security:
      - bearerAuth: []
      summary: '"God mode" ability to turn into any user. The current user must be
        marked internally as a super admin.'
      tags:
      - user
# {% if False %}
      - default
# {% endif %}
      x-openapi-router-controller: athenian.api.controllers.user_controller
      x-codegen-request-body-name: body
  /contributors/{id}:
    get:
      operationId: get_contributors
      parameters:
      - description: Numeric identifier of the account.
        explode: false
        in: path
        name: id
        required: true
        schema:
          type: integer
        style: simple
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Contributors'
          description: List of all contributors belonging to the specified account.
        404:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenericError'
          description: The user does not belong to the specified account.
        422:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenericError'
          description: The installation has not started yet.
      security:
      - bearerAuth: []
      - apiKeyAuth: []
      summary: List all the contributors belonging to the specified account.
      tags:
      - contributors
# {% if False %}
      - default
# {% endif %}
      x-openapi-router-controller: athenian.api.controllers.contributors_controller
      x-codegen-request-body-name: body
  /filter/commits:
    post:
      operationId: filter_commits
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FilterCommitsRequest'
        x-body-name: body
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommitsList'
          description: Commits that satisfy the specified filters grouped by date.
        400:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidRequestError'
          description: The request is invalid.
        403:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenericError'
          description: Current user is not allowed to access the specified account.
      security:
      - bearerAuth: []
      - apiKeyAuth: []
      summary: Find commits that match the specified query.
      tags:
      - filter
# {% if False %}
      - default
# {% endif %}
      x-openapi-router-controller: athenian.api.controllers.filter_controller
      x-codegen-request-body-name: body
  /filter/contributors:
    post:
      operationId: filter_contributors
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FilterContributorsRequest'
        x-body-name: body
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeveloperSummaries'
          description: Repositories that were updated within the given timeframe.
        400:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidRequestError'
          description: The request is invalid.
        403:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenericError'
          description: Current user is not allowed to access the specified account.
      security:
      - bearerAuth: []
      - apiKeyAuth: []
      summary: Find developers that made an action within the given timeframe.
      tags:
      - filter
# {% if False %}
      - default
# {% endif %}
      x-openapi-router-controller: athenian.api.controllers.filter_controller
      x-codegen-request-body-name: body
  /filter/jira:
    post:
      operationId: filter_jira_stuff
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FilterJIRAStuff'
        x-body-name: body
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FoundJIRAStuff'
          description: List of found JIRA entities, ordered by the last usage time.
        403:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenericError'
          description: The user is not an account member.
        404:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenericError'
          description: The account was not found.
      security:
      - bearerAuth: []
      summary: Find JIRA epics and labels used in the specified date interval.
      tags:
      - filter
# {% if False %}
      - default
# {% endif %}
      x-openapi-router-controller: athenian.api.controllers.jira_controller
      x-codegen-request-body-name: body
  /filter/labels:
    post:
      operationId: filter_labels
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FilterLabelsRequest'
        x-body-name: body
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilteredLabels'
          description: List of labels.
        400:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidRequestError'
          description: The request is invalid.
        403:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenericError'
          description: Current user is not allowed to access the specified account.
      security:
      - bearerAuth: []
      - apiKeyAuth: []
      summary: Find labels used in the given repositories.
      tags:
      - filter
# {% if False %}
      - default
# {% endif %}
      x-openapi-router-controller: athenian.api.controllers.filter_controller
      x-codegen-request-body-name: body
  /filter/pull_requests:
    post:
      operationId: filter_prs
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FilterPullRequestsRequest'
        x-body-name: body
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PullRequestSet'
          description: List of pull requests satisfying the specified filters.
        400:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidRequestError'
          description: The request is invalid.
        403:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenericError'
          description: Current user is not allowed to access the specified account
            or reposets.
        422:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenericError'
          description: The account's installation has not finished yet.
      security:
      - bearerAuth: []
      - apiKeyAuth: []
      summary: List pull requests that satisfy the query.
      tags:
      - filter
# {% if False %}
      - default
# {% endif %}
      x-openapi-router-controller: athenian.api.controllers.filter_controller
  /filter/releases:
    post:
      operationId: filter_releases
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FilterReleasesRequest'
        x-body-name: body
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilteredReleases'
          description: Repositories that were updated within the given timeframe.
        400:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidRequestError'
          description: The request is invalid.
        403:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenericError'
          description: Current user is not allowed to access the specified account.
      security:
      - bearerAuth: []
      - apiKeyAuth: []
      summary: Find releases that were published in the given time fram in the given
        repositories.
      tags:
      - filter
# {% if False %}
      - default
# {% endif %}
      x-openapi-router-controller: athenian.api.controllers.filter_controller
      x-codegen-request-body-name: body
  /filter/repositories:
    post:
      operationId: filter_repositories
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FilterRepositoriesRequest'
        x-body-name: body
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RepositorySet'
          description: Repositories that were updated within the given timeframe.
        400:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidRequestError'
          description: The request is invalid.
        403:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenericError'
          description: Current user is not allowed to access the specified account
            or reposets.
      security:
      - bearerAuth: []
      - apiKeyAuth: []
      summary: Find repositories that were updated within the given timeframe.
      tags:
      - filter
# {% if False %}
      - default
# {% endif %}
      x-openapi-router-controller: athenian.api.controllers.filter_controller
      x-codegen-request-body-name: body
  /get/pull_requests:
    post:
      operationId: get_prs
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetPullRequestsRequest'
        x-body-name: body
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PullRequestSet'
          description: List of pull requests satisfying the specified filters.
        400:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidRequestError'
          description: The request is invalid.
        403:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenericError'
          description: Current user is not allowed to access the specified account
            or reposets.
      security:
      - bearerAuth: []
      - apiKeyAuth: []
      summary: List pull requests by repository and number.
      tags:
      - filter
# {% if False %}
      - default
# {% endif %}
      x-openapi-router-controller: athenian.api.controllers.filter_controller
  /histograms/prs:
    post:
      operationId: calc_histogram_prs
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PullRequestHistogramsRequest'
        description: Desired histogram definitions.
        required: true
        x-body-name: body
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CalculatedPullRequestHistograms'
          description: Calculated histograms.
        400:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidRequestError'
          description: The request is invalid.
        403:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenericError'
          description: The user is forbidden to calculate metrics on behalf of the
            specified account.
        422:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NoSourceDataError'
          description: No data is available to calculate histograms for the given
            repositories.
      security:
      - bearerAuth: []
      - apiKeyAuth: []
      summary: Calculate histograms over PR distributions.
      tags:
      - metrics
# {% if False %}
      - default
# {% endif %}
      x-openapi-router-controller: athenian.api.controllers.histograms_controller
      x-codegen-request-body-name: body
  /invite/accept:
    put:
      operationId: accept_invitation
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InvitationLink'
        description: Accepted invitation details.
        required: true
        x-body-name: body
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvitedUser'
          description: Details about the new user.
        400:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenericError'
          description: Something is wrong with the invitation URL.
        403:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenericError'
          description: Invitation was disabled.
        404:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenericError'
          description: Invitation was not found.
        409:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenericError'
          description: Concurrent requests.
      security:
      - bearerAuth: []
      summary: Accept the account membership invitation and finish registration. The
        user must be already authorized in Auth0.
      tags:
      - registration
# {% if False %}
      - default
# {% endif %}
      x-openapi-router-controller: athenian.api.controllers.invitation_controller
      x-codegen-request-body-name: body
  /invite/check:
    post:
      operationId: check_invitation
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InvitationLink'
        description: Checked invitation details.
        required: true
        x-body-name: body
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvitationCheckResult'
          description: 'Result of checking an invitation URL: invitation type, whether
            it is correctly formed and is enabled.'
      summary: Given an invitation URL, get its type (admin or regular account member)
        and find whether it is correctly formed and is enabled or disabled.
      tags:
      - registration
# {% if False %}
      - default
# {% endif %}
      x-openapi-router-controller: athenian.api.controllers.invitation_controller
      x-codegen-request-body-name: body
  /invite/generate/{id}:
    get:
      operationId: gen_invitation
      parameters:
      - description: Numeric identifier of the account where to invite new users.
        explode: false
        in: path
        name: id
        required: true
        schema:
          type: integer
        style: simple
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvitationLink'
          description: The invitation link has been generated successfully.
        403:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenericError'
          description: The user is forbidden to invite for this account.
        404:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenericError'
          description: The account was not found.
      security:
      - bearerAuth: []
      summary: Generate an account invitation link for regular users. The caller must
        be an admin of the specified account.
      tags:
      - registration
# {% if False %}
      - default
# {% endif %}
      x-openapi-router-controller: athenian.api.controllers.invitation_controller
      x-codegen-request-body-name: body
  /invite/jira/{id}:
    get:
      operationId: gen_jira_link
      parameters:
      - description: Numeric identifier of the account who is installing JIRA integration.
        explode: false
        in: path
        name: id
        required: true
        schema:
          type: integer
        style: simple
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvitationLink'
          description: The invitation link has been generated successfully.
        403:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenericError'
          description: The user is forbidden to invite for this account.
        404:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenericError'
          description: The account was not found.
      security:
      - bearerAuth: []
      summary: Generate a JIRA integration installation link. The caller must be an
        admin of the specified account.
      tags:
      - registration
# {% if False %}
      - default
# {% endif %}
      x-openapi-router-controller: athenian.api.controllers.invitation_controller
      x-codegen-request-body-name: body
  /invite/progress/{id}:
    get:
      operationId: eval_invitation_progress
      parameters:
      - description: Numeric identifier of the account which the user has joined.
        explode: false
        in: path
        name: id
        required: true
        schema:
          type: integer
        style: simple
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InstallationProgress'
          description: Status of installing Athenian for the current user and the
            given account.
        404:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenericError'
          description: The account does not exist or the user is not its member.
        422:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenericError'
          description: The installation has not started yet.
      security:
      - bearerAuth: []
      - apiKeyAuth: []
      summary: Return the current Athenian GitHub app installation progress.
      tags:
      - registration
# {% if False %}
      - default
# {% endif %}
      x-openapi-router-controller: athenian.api.controllers.invitation_controller
  /metrics/code_bypassing_prs:
    post:
      operationId: calc_code_bypassing_prs
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CodeFilter'
        description: Query for measuring the amount of code that was pushed outside
          of pull requests.
        required: true
        x-body-name: body
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MeasuredCodeBypassingPRs'
          description: Calculated metrics.
        400:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidRequestError'
          description: The request is invalid.
        403:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenericError'
          description: The user is forbidden to access the specified repositories
            on behalf of the specified account.
      security:
      - bearerAuth: []
      - apiKeyAuth: []
      summary: Measure the amount of code that was pushed outside of pull requests.
      tags:
      - metrics
# {% if False %}
      - default
# {% endif %}
      x-openapi-router-controller: athenian.api.controllers.metrics_controller
      x-codegen-request-body-name: body
  /metrics/developers:
    post:
      operationId: calc_metrics_developer
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeveloperMetricsRequest'
        description: Query for selecting developers and measured activities.
        required: true
        x-body-name: body
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CalculatedDeveloperMetrics'
          description: Calculated metrics.
        400:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidRequestError'
          description: The request is invalid.
        403:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenericError'
          description: The user is forbidden to access the specified repositories
            on behalf of the specified account.
      security:
      - bearerAuth: []
      - apiKeyAuth: []
      summary: Calculate metrics over developer activities.
      tags:
      - metrics
# {% if False %}
      - default
# {% endif %}
      x-openapi-router-controller: athenian.api.controllers.metrics_controller
      x-codegen-request-body-name: body
  /metrics/jira:
    post:
      operationId: calc_metrics_jira_linear
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/JIRAMetricsRequest'
        description: Query for selecting JIRA issues and measured activities.
        required: true
        x-body-name: body
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CalculatedJIRAMetrics'
          description: Calculated metrics.
        400:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidRequestError'
          description: The request is invalid.
        403:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenericError'
          description: The user is forbidden to access the specified repositories
            on behalf of the specified account.
      security:
      - bearerAuth: []
      - apiKeyAuth: []
      summary: Calculate metrics over JIRA issue activities.
      tags:
      - metrics
# {% if False %}
      - default
# {% endif %}
      x-openapi-router-controller: athenian.api.controllers.jira_controller
      x-codegen-request-body-name: body
  /metrics/prs:
    post:
      operationId: calc_metrics_pr_linear
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PullRequestMetricsRequest'
        description: Desired metric definitions.
        required: true
        x-body-name: body
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CalculatedPullRequestMetrics'
          description: Calculated metrics.
        400:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidRequestError'
          description: The request is invalid.
        403:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenericError'
          description: The user is forbidden to calculate metrics on behalf of the
            specified account.
        422:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NoSourceDataError'
          description: No data is available to calculate metrics for the given repositories.
      security:
      - bearerAuth: []
      - apiKeyAuth: []
      summary: Calculate linear metrics over PRs.
      tags:
      - metrics
# {% if False %}
      - default
# {% endif %}
      x-openapi-router-controller: athenian.api.controllers.metrics_controller
      x-codegen-request-body-name: body
  /metrics/releases:
    post:
      operationId: calc_metrics_releases_linear
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ReleaseMetricsRequest'
        description: Desired metric definitions.
        required: true
        x-body-name: body
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CalculatedReleaseMetrics'
          description: Calculated metrics.
        400:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidRequestError'
          description: The request is invalid.
        403:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenericError'
          description: The user is forbidden to calculate metrics on behalf of the
            specified account.
        422:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NoSourceDataError'
          description: No data is available to calculate metrics for the given repositories.
      security:
      - bearerAuth: []
      - apiKeyAuth: []
      summary: Calculate linear metrics over releases.
      tags:
      - metrics
# {% if False %}
      - default
# {% endif %}
      x-openapi-router-controller: athenian.api.controllers.metrics_controller
      x-codegen-request-body-name: body
  /paginate/pull_requests:
    post:
      operationId: paginate_prs
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PaginatePullRequestsRequest'
        x-body-name: body
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PullRequestPaginationPlan'
          description: Identifier of the created repository set.
        400:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidRequestError'
          description: The request is invalid.
        403:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenericError'
          description: Current user is not allowed to access the specified account
            or reposets.
        422:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenericError'
          description: The account's installation has not finished yet.
      security:
      - bearerAuth: []
      summary: Compute the balanced pagination plan for `/filter/pull_requests`.
      tags:
      - pagination
# {% if False %}
      - default
# {% endif %}
      x-openapi-router-controller: athenian.api.controllers.pagination_controller
      x-codegen-request-body-name: body
  /reposet/create:
    post:
      operationId: create_reposet
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RepositorySetCreateRequest'
        x-body-name: body
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreatedIdentifier'
          description: Identifier of the created repository set.
        403:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenericError'
          description: The user is forbidden to create a repository set from the specified
            items.
        409:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenericError'
          description: There is an existing reposet with the same contents.
      security:
      - bearerAuth: []
      summary: Create a repository set.
      tags:
      - reposet
# {% if False %}
      - default
# {% endif %}
      x-openapi-router-controller: athenian.api.controllers.reposet_controller
      x-codegen-request-body-name: body
  /reposet/{id}:
    delete:
      operationId: delete_reposet
      parameters:
      - description: Numeric identifier of the repository set to delete.
        explode: false
        in: path
        name: id
        required: true
        schema:
          type: integer
        style: simple
      responses:
        200:
          content:
            application/json:
              schema:
                type: object
          description: Empty object indicates a successful removal.
        403:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenericError'
          description: The user is forbidden to delete the specified repository set.
        404:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenericError'
          description: The specified repository set was not found.
      security:
      - bearerAuth: []
      summary: Delete a repository set. The user must be an admin of the account that
        owns the reposet.
      tags:
      - reposet
# {% if False %}
      - default
# {% endif %}
      x-openapi-router-controller: athenian.api.controllers.reposet_controller
      x-codegen-request-body-name: body
    get:
      operationId: get_reposet
      parameters:
      - description: Numeric identifier of the repository set to list.
        explode: false
        in: path
        name: id
        required: true
        schema:
          type: integer
        style: simple
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RepositorySetWithName'
          description: List of repositories in the specified set.
        403:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenericError'
          description: The user is forbidden to list the specified repository set.
        404:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenericError'
          description: The specified repository set was not found.
      security:
      - bearerAuth: []
      - apiKeyAuth: []
      summary: List a repository set. The user must be in the account that owns the
        reposet.
      tags:
      - reposet
# {% if False %}
      - default
# {% endif %}
      x-openapi-router-controller: athenian.api.controllers.reposet_controller
      x-codegen-request-body-name: body
    put:
      operationId: update_reposet
      parameters:
      - description: Numeric identifier of the repository set to update.
        explode: false
        in: path
        name: id
        required: true
        schema:
          type: integer
        style: simple
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RepositorySetWithName'
        x-body-name: body
      responses:
        200:
          content:
            application/json:
              schema:
                type: object
          description: Empty object indicates a successful update.
        403:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenericError'
          description: The user is forbidden to update the specified repository set.
        404:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenericError'
          description: The specified repository set was not found.
        409:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenericError'
          description: There is an existing reposet with the same contents.
      security:
      - bearerAuth: []
      summary: Update a repository set. The user must be an admin of the account that
        owns the reposet.
      tags:
      - reposet
# {% if False %}
      - default
# {% endif %}
      x-openapi-router-controller: athenian.api.controllers.reposet_controller
      x-codegen-request-body-name: body
  /reposets/{id}:
    get:
      operationId: list_reposets
      parameters:
      - description: Numeric identifier of the account.
        explode: false
        in: path
        name: id
        required: true
        schema:
          type: integer
        style: simple
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RepositorySetList'
          description: List the repository sets belonging to the specified account.
        404:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenericError'
          description: The user does not belong to the specified account.
        409:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenericError'
          description: Concurrent requests that are finishing the account registration.
      security:
      - bearerAuth: []
      - apiKeyAuth: []
      summary: List the repository sets belonging to the current user.
      tags:
      - reposet
# {% if False %}
      - default
# {% endif %}
      x-openapi-router-controller: athenian.api.controllers.reposet_controller
      x-codegen-request-body-name: body
  /settings/release_match:
    put:
      operationId: set_release_match
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ReleaseMatchRequest'
        x-body-name: body
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RepositorySet'
          description: List the repositories affected.
        400:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenericError'
          description: Request is invalid.
        403:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenericError'
          description: The user is not an admin of this account.
        404:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenericError'
          description: The user or the account was not found.
        422:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenericError'
          description: The installation has not started yet.
      security:
      - bearerAuth: []
      summary: Set the release matching rule for a list of repositories. Only for
        account admins.
      tags:
      - settings
# {% if False %}
      - default
# {% endif %}
      x-openapi-router-controller: athenian.api.controllers.settings_controller
      x-codegen-request-body-name: body
  /settings/release_match/{id}:
    get:
      operationId: list_release_match_settings
      parameters:
      - description: Numeric identifier of the account.
        explode: false
        in: path
        name: id
        required: true
        schema:
          type: integer
        style: simple
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReleaseMatchSettings'
          description: Current release matching settings per repo.
        404:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenericError'
          description: The user does not belong to the specified account.
        422:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenericError'
          description: The installation has not started yet.
      security:
      - bearerAuth: []
      - apiKeyAuth: []
      summary: List the current release matching settings.
      tags:
      - settings
# {% if False %}
      - default
# {% endif %}
      x-openapi-router-controller: athenian.api.controllers.settings_controller
      x-codegen-request-body-name: body
  /team/create:
    post:
      operationId: create_team
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TeamCreateRequest'
        x-body-name: body
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreatedIdentifier'
          description: Identifier of the created team.
        400:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidRequestError'
          description: The request is invalid.
        409:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenericError'
          description: There is an existing team with the same contents.
      security:
      - bearerAuth: []
      summary: Create a team. Admin is not required.
      tags:
      - team
# {% if False %}
      - default
# {% endif %}
      x-openapi-router-controller: athenian.api.controllers.team_controller
      x-codegen-request-body-name: body
  /team/{id}:
    delete:
      operationId: delete_team
      parameters:
      - description: Numeric identifier of the team to delete.
        explode: false
        in: path
        name: id
        required: true
        schema:
          type: integer
        style: simple
      responses:
        200:
          content:
            application/json:
              schema:
                type: object
          description: Empty object indicates a successful removal.
        403:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenericError'
          description: The user is forbidden to delete the specified team.
        404:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenericError'
          description: The specified team was not found.
      security:
      - bearerAuth: []
      summary: Delete a team.
      tags:
      - team
# {% if False %}
      - default
# {% endif %}
      x-openapi-router-controller: athenian.api.controllers.team_controller
      x-codegen-request-body-name: body
    get:
      operationId: get_team
      parameters:
      - description: Numeric identifier of the team to list.
        explode: false
        in: path
        name: id
        required: true
        schema:
          type: integer
        style: simple
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Team'
          description: List of the members in the specified team.
        403:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenericError'
          description: The user is forbidden to list the specified team.
        404:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenericError'
          description: The specified team was not found.
      security:
      - bearerAuth: []
      - apiKeyAuth: []
      summary: List the team's members. The user must belong to the account that owns
        the team.
      tags:
      - team
# {% if False %}
      - default
# {% endif %}
      x-openapi-router-controller: athenian.api.controllers.team_controller
      x-codegen-request-body-name: body
    put:
      operationId: update_team
      parameters:
      - description: Numeric identifier of the team to update.
        explode: false
        in: path
        name: id
        required: true
        schema:
          type: integer
        style: simple
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TeamUpdateRequest'
        x-body-name: body
      responses:
        200:
          content:
            application/json:
              schema:
                type: object
          description: Empty object indicates a successful operation.
        400:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidRequestError'
          description: The request is invalid.
        403:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenericError'
          description: The user is forbidden to update the specified team.
        404:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenericError'
          description: The specified team was not found.
        409:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenericError'
          description: There is an existing team with the same contents.
      security:
      - bearerAuth: []
      summary: Update a team.
      tags:
      - team
# {% if False %}
      - default
# {% endif %}
      x-openapi-router-controller: athenian.api.controllers.team_controller
      x-codegen-request-body-name: body
  /teams/{id}:
    get:
      operationId: list_teams
      parameters:
      - description: Numeric identifier of the account.
        explode: false
        in: path
        name: id
        required: true
        schema:
          type: integer
        style: simple
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TeamList'
          description: List the teams belonging to the specified account.
        404:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenericError'
          description: The user does not belong to the specified account.
      security:
      - bearerAuth: []
      - apiKeyAuth: []
      summary: List the teams belonging to the current user.
      tags:
      - team
# {% if False %}
      - default
# {% endif %}
      x-openapi-router-controller: athenian.api.controllers.team_controller
      x-codegen-request-body-name: body
  /token/create:
    post:
      operationId: create_token
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateTokenRequest'
        x-body-name: body
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreatedToken'
          description: Value and ID of the generated Personal Access Token.
        404:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenericError'
          description: The user does not belong to the specified account or no such
            account exists.
        409:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenericError'
          description: There is another token with the same name belonging to the
            user in the account.
      security:
      - bearerAuth: []
      summary: Create a new Personal Access Token for the current user and the specified
        account.
      tags:
      - security
# {% if False %}
      - default
# {% endif %}
      x-openapi-router-controller: athenian.api.controllers.security_controller
      x-codegen-request-body-name: body
  /token/{id}:
    delete:
      operationId: delete_token
      parameters:
      - description: Numeric identifier of the token.
        explode: false
        in: path
        name: id
        required: true
        schema:
          type: integer
        style: simple
      responses:
        200:
          content:
            application/json:
              schema:
                type: object
          description: Empty object indicates a successful removal.
        403:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenericError'
          description: The user does not own the token.
        404:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenericError'
          description: The token does not exist.
      security:
      - bearerAuth: []
      summary: Delete a Personal Access Token belonging to the user.
      tags:
      - security
# {% if False %}
      - default
# {% endif %}
      x-openapi-router-controller: athenian.api.controllers.security_controller
      x-codegen-request-body-name: body
    patch:
      operationId: patch_token
      parameters:
      - description: Numeric identifier of the token.
        explode: false
        in: path
        name: id
        required: true
        schema:
          type: integer
        style: simple
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchTokenRequest'
        x-body-name: body
      responses:
        200:
          content:
            application/json:
              schema:
                type: object
          description: Empty object indicates a successful patch operation.
        403:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenericError'
          description: The user does not own the token.
        404:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenericError'
          description: The token does not exist.
        409:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenericError'
          description: There is another token with the same name belonging to the
            user in the account.
      security:
      - bearerAuth: []
      summary: Change Personal Access Token's details.
      tags:
      - security
# {% if False %}
      - default
# {% endif %}
      x-openapi-router-controller: athenian.api.controllers.security_controller
      x-codegen-request-body-name: body
  /tokens/{id}:
    get:
      operationId: list_tokens
      parameters:
      - description: Numeric identifier of the account.
        explode: false
        in: path
        name: id
        required: true
        schema:
          type: integer
        style: simple
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListedTokens'
          description: List of Personal Access Tokens belonging to the user in the
            specified account.
        404:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenericError'
          description: The user does not belong to the specified account or no such
            account exists.
      security:
      - bearerAuth: []
      - apiKeyAuth: []
      summary: List Personal Access Tokens of the user in the account.
      tags:
      - security
# {% if False %}
      - default
# {% endif %}
      x-openapi-router-controller: athenian.api.controllers.security_controller
      x-codegen-request-body-name: body
  /user:
    get:
      operationId: get_user
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/User'
          description: 'Information about the current user: name, email, login, etc.'
      security:
      - bearerAuth: []
      - apiKeyAuth: []
      summary: Show details about the current user.
      tags:
      - user
# {% if False %}
      - default
# {% endif %}
      x-openapi-router-controller: athenian.api.controllers.user_controller
      x-codegen-request-body-name: body
  /versions:
    get:
      operationId: get_versions
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Versions'
          description: Versions of the backend components.
      security: []
      summary: Query the versions of the backend components.
      tags:
      - version
# {% if False %}
      - default
# {% endif %}
      x-openapi-router-controller: athenian.api.controllers.status_controller
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      x-bearerInfoFunc: athenian.api.controllers.security_controller.info_from_bearerAuth
    apiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      x-apikeyInfoFunc: athenian.api.controllers.security_controller.info_from_apiKeyAuth
  schemas:
    CreatedIdentifier:
      additionalProperties: false
      example:
        id: 777
      properties:
        id:
          description: Identifier of the created entity.
          example: 777
          type: integer
      required:
      - id
      type: object
    GenericError:
      properties:
        type:
          description: URI reference that identifies the problem type (RFC 7807).
          example: /errors/metrics/pr_linear/InvalidRequestError
          type: string
        title:
          description: Short, human-readable summary of the problem type.
          example: Validation failed
          type: string
        status:
          description: Duplicated HTTP status code.
          example: 400
          type: integer
        detail:
          description: Human-readable explanation specific to this occurrence of the
            problem.
          example: '"pr-slave-time" is not one of [...].'
          type: string
        instance:
          description: URI reference that identifies the specific occurrence of the
            problem.
          example: https://sentry.io/athenian/api/?query=2763c4eabd7240f59829ee1a02546293
          type: string
      required:
      - title
      - type
      type: object
    InvalidRequestError:
      allOf:
      - $ref: '#/components/schemas/GenericError'
      - properties:
          pointer:
            description: Path to the offending request item.
            example: .granularity
            type: string
        type: object
    NoSourceDataError:
      $ref: '#/components/schemas/GenericError'
    PullRequestMetricID:
      description: |-
        Currently supported PR metric types.
        * `pr-wip-time`: average time spent in Work In Progress stage.
        * `pr-wip-count`: number of PRs used to calculate `pr-wip-time` disregarding the quantiles.
        * `pr-wip-count-q`: number of PRs used to calculate `pr-wip-time` after applying the quantiles.
        * `pr-review-time`: average time spent in Review stage.
        * `pr-review-count`: number of PRs used to calculate `pr-review-time` disregarding the quantiles.
        * `pr-review-count-q`: number of PRs used to calculate `pr-review-time` after applying the quantiles.
        * `pr-merging-time`: average time spent in Merge stage.
        * `pr-merging-count`: number of PRs used to calculate `pr-merging-time` disregarding the quantiles.
        * `pr-merging-count-q`: number of PRs used to calculate `pr-merging-time` after applying the quantiles.
        * `pr-release-time`: average time spent in Release stage.
        * `pr-release-count`: number of PRs used to calculate `pr-release-time` disregarding the quantiles.
        * `pr-release-count-q`: number of PRs used to calculate `pr-release-time` after applying the quantiles.
        * `pr-lead-time`: average Lead Time - time between the work started and the release.
        * `pr-lead-count`: number of PRs used to calculate `pr-lead-time` disregarding the quantiles. It should be the same as `pr-release-count`.
        * `pr-lead-count-q`: number of PRs used to calculate `pr-lead-time` after applying the quantiles.
        * `pr-cycle-time`: Cycle Time - sum of correspodning `pr-wip-time`, `pr-review-time`, `pr-merging-time`, and `pr-release-time`.
        * `pr-cycle-count`: number of PRs used to calculate `pr-cycle-time` disregarding the quantiles. It equals to the overall number of PRs observed in the given time window.
        * `pr-cycle-count-q`: number of PRs used to calculate `pr-cycle-time` after applying the quantiles.
        * `pr-all-count`: equals to the sum of `pr-cycle-count` with the number of PRs which are still not done on the specified time interval but don't have any stage-changing events. This metric should be exactly the same as the number of PRs returned by `/filter/prs`. The quantiles are ignored.
        * `pr-wait-first-review-time`: average time of waiting for the first review.
        * `pr-wait-first-review-count`: number of PRs used to calculate `pr-wait-first-review`. Note: this is *not* the same as the number of PRs waiting for the first review.
        * `pr-wait-first-review-count-q`: number of PRs used to calculate `pr-wait-first-review after applying the quantiles.
        * `pr-flow-ratio`: ratio of opened to closed PRs.
        * `pr-opened`: number of opened PRs.
        * `pr-reviewed`: number of PRs which received a review.
        * `pr-not-reviewed`: number of PRs merged or closed but without any review.
        * `pr-merged`: number of merged PRs.
        * `pr-rejected`: number of rejected PRs.
        * `pr-closed`: number of closed PRs.
        * `pr-done`: number of released, closed unmerged, and force push dropped PRs.
        * `pr-size`: average size of PRs (added + deleted lines) which are active on the time interval after applying the quantiles.
        * `pr-wip-pending-count`: number of PRs currently in Work In Progress stage.
        * `pr-review-pending-count`: number of PRs currently in Review stage.
        * `pr-merging-pending-count`: number of PRs currently in Merge stage.
        * `pr-release-pending-count`: number of PRs currently in Release stage.
      enum:
      - pr-wip-time
      - pr-wip-count
      - pr-wip-count-q
      - pr-review-time
      - pr-review-count
      - pr-review-count-q
      - pr-merging-time
      - pr-merging-count
      - pr-merging-count-q
      - pr-release-time
      - pr-release-count
      - pr-release-count-q
      - pr-lead-time
      - pr-lead-count
      - pr-lead-count-q
      - pr-cycle-time
      - pr-cycle-count
      - pr-cycle-count-q
      - pr-all-count
      - pr-wait-first-review-time
      - pr-wait-first-review-count
      - pr-wait-first-review-count-q
      - pr-flow-ratio
      - pr-opened
      - pr-reviewed
      - pr-not-reviewed
      - pr-merged
      - pr-rejected
      - pr-closed
      - pr-done
      - pr-size
      - pr-wip-pending-count
      - pr-review-pending-count
      - pr-merging-pending-count
      - pr-release-pending-count
      example: pr-lead-time
      type: string
    DeveloperID:
      description: |
        User name which uniquely identifies any developer on any service provider.
        The format matches the profile URL without the protocol part.
      example: github.com/vmarkovtsev
      type: string
    RepositoryID:
      description: |
        Repository name which uniquely identifies any repository in any service provider.
        The format matches the repository URL without the protocol part. No ".git" should be appended.
        We support a special syntax for repository sets: "{reposet id}" adds all the repositories
        from the given set.
      example: github.com/src-d/go-git
      type: string
    DeveloperSet:
      description: A set of developers. An empty list disables the filter and includes
        everybody. Duplicates are automatically ignored.
      example:
      - github.com/vmarkovtsev
      - github.com/dpordomingo
      items:
        $ref: '#/components/schemas/DeveloperID'
      type: array
    Contributors:
      description: List of contributors.
      example:
      - login: github.com/gkwillie
        name: Groundskeeper Willie
        email: bot@athenian.co
        picture: https://avatars0.githubusercontent.com/u/60340680?v=4
      - login: github.com/se7entyse7en
        name: Lou Marvin Caraig
        email: loumarvincaraig@gmail.com
        picture: https://avatars1.githubusercontent.com/u/5599208?v=4
      items:
        $ref: '#/components/schemas/Contributor'
      type: array
    Contributor:
      additionalProperties: false
      description: Details about a developer who contributed to some repositories
        owned by the account.
      example:
        login: github.com/gkwillie
        name: Groundskeeper Willie
        email: bot@athenian.co
        picture: https://avatars0.githubusercontent.com/u/60340680?v=4
      properties:
        login:
          $ref: '#/components/schemas/DeveloperID'
        name:
          description: Full name of the contributor.
          type: string
        email:
          description: Email of the conributor.
          type: string
        picture:
          description: Avatar URL of the contributor.
          type: string
      required:
      - login
      type: object
    TeamCreateRequest:
      additionalProperties: false
      description: Team creation request.
      example:
        account: 1
        name: Engineering
        members:
        - github.com/gkwillie
        - github.com/se7entyse7en
      properties:
        account:
          description: Account identifier. That account will own the created team.
          type: integer
        name:
          description: Name of the team.
          type: string
        members:
          $ref: '#/components/schemas/DeveloperSet'
      required:
      - account
      - members
      - name
      type: object
    TeamUpdateRequest:
      additionalProperties: false
      description: Team update request.
      example:
        name: Engineering
        members:
        - github.com/gkwillie
        - github.com/se7entyse7en
      properties:
        name:
          description: Name of the team.
          type: string
        members:
          $ref: '#/components/schemas/DeveloperSet'
      required:
      - members
      - name
      type: object
    Team:
      description: List of team members.
      example:
        id: 1
        name: Engineering
        members:
        - login: github.com/gkwillie
          name: Groundskeeper Willie
          email: bot@athenian.co
          picture: https://avatars0.githubusercontent.com/u/60340680?v=4
        - login: github.com/se7entyse7en
          name: Lou Marvin Caraig
          email: loumarvincaraig@gmail.com
          picture: https://avatars1.githubusercontent.com/u/5599208?v=4
      properties:
        id:
          description: Team identifier.
          type: integer
        name:
          description: Name of the team.
          type: string
        members:
          $ref: '#/components/schemas/Contributors'
      required:
      - id
      - members
      - name
      type: object
    TeamList:
      description: List of teams of an account.
      example:
      - id: 1
        name: Engineering
        members:
        - login: github.com/vmarkovtsev
          name: Vadim Markovtsev
          email: vadim@athenian.co
          picture: https://avatars3.githubusercontent.com/u/2793551?v=4
        - login: github.com/se7entyse7en
          name: Lou Marvin Caraig
          email: waren@athenian.co
          picture: https://avatars1.githubusercontent.com/u/5599208?v=4
      - id: 2
        name: Product
        members:
        - login: github.com/warenlg
          name: Waren Long
          email: waren@athenian.co
          picture: https://avatars2.githubusercontent.com/u/24694845?v=4
      items:
        $ref: '#/components/schemas/Team'
      type: array
    RepositorySet:
      description: A set of repositories. An empty list results an empty response
        in contrary to DeveloperSet. Duplicates are automatically ignored.
      example:
      - github.com/athenianco/athenian-webapp
      - github.com/athenianco/athenian-api
      items:
        $ref: '#/components/schemas/RepositoryID'
      type: array
    RepositorySetWithName:
      additionalProperties: false
      description: A set of repositories. An empty list results an empty response
        in contrary to DeveloperSet. Duplicates are automatically ignored.
      example:
        name: all
        items:
        - github.com/athenianco/athenian-webapp
        - github.com/athenianco/athenian-api
        precomputed: true
      properties:
        name:
          type: string
        items:
          items:
            $ref: '#/components/schemas/RepositoryID'
          type: array
        precomputed:
          type: boolean
      type: object
    RepositorySetList:
      description: List of repository sets owned by a user.
      items:
        $ref: '#/components/schemas/RepositorySetListItem'
      type: array
    RepositorySetCreateRequest:
      additionalProperties: false
      description: Repository set creation request.
      example:
        account: 1
        items:
        - github.com/athenianco/athenian-webapp
        - github.com/athenianco/athenian-api
        name: users
      properties:
        account:
          description: Account identifier. That account will own the created repository
            set. The user must be an admin of the account.
          type: integer
        items:
          items:
            $ref: '#/components/schemas/RepositoryID'
          type: array
        name:
          description: Unique editable identifier of the repository set.
          type: string
      required:
      - account
      - items
      - name
      type: object
    RepositorySetListItem:
      additionalProperties: false
      description: Element of RepositorySetList.
      example:
        items_count: 6
        created: 2020-01-23T04:56:07.000+00:00
        id: 1
        name: all
        updated: 2020-01-23T04:56:07.000+00:00
      properties:
        id:
          description: Repository set identifier.
          type: integer
        name:
          description: Repository set name.
          type: string
        created:
          description: Date and time of creation of the repository set.
          format: date-time
          type: string
        updated:
          description: Date and time of the last change of the repository set.
          format: date-time
          type: string
        items_count:
          description: Number of repositories in the set.
          minimum: 1
          type: integer
      type: object
    User:
      additionalProperties: false
      description: User details. "updated" and "accounts" are populated only for the
        current user.
      example:
        id: github|60340680
        native_id: 60340680
        login: gkwillie
        name: Groundskeeper Willie
        email: bot@athenian.co
        picture: https://avatars0.githubusercontent.com/u/60340680?v=4
        updated: 2020-01-23T12:00:00Z
      properties:
        id:
          description: Auth0 user identifier.
          type: string
        native_id:
          description: Auth backend user identifier.
          type: string
        login:
          description: Auth backend user login name.
          type: string
        name:
          description: Full name of the user.
          type: string
        email:
          description: Email of the user.
          type: string
        picture:
          description: Avatar URL of the user.
          type: string
        updated:
          description: Date and time of the last profile update.
          format: date-time
          type: string
        accounts:
          additionalProperties:
            type: boolean
          description: Mapping between account IDs the user is a member of and is_admin
            flags.
          example:
            1: true
            2: false
          type: object
      required:
      - id
      - login
      - native_id
      type: object
    InvitedUser:
      additionalProperties: false
      description: Details about the user who has accepted an invitation.
      example:
        user:
          id: github|60340680
          native_id: 60340680
          login: gkwillie
          name: Groundskeeper Willie
          email: bot@athenian.co
          picture: https://avatars0.githubusercontent.com/u/60340680?v=4
          updated: 2020-01-23T12:00:00Z
        account: 0
      properties:
        account:
          description: Joined account ID.
          type: integer
        user:
          $ref: '#/components/schemas/User'
      required:
      - account
      - user
      type: object
    Account:
      additionalProperties: false
      description: Account members. "updated" and "accounts" are not populated.
      example:
        regulars:
        - id: github|24828976
          native_id: 24828976
          login: jjdoe
          name: Jane Josephine Doe
          email: janedoe@exampleco.com
          picture: http://exampleco.com/janedoe/me.jpg
          updated: 2020-01-23T12:00:00Z
        - id: github|24828976
          native_id: 24828976
          login: jjdoe
          name: Jane Josephine Doe
          email: janedoe@exampleco.com
          picture: http://exampleco.com/janedoe/me.jpg
          updated: 2020-01-23T12:00:00Z
        admins:
        - id: github|24828976
          native_id: 24828976
          login: jjdoe
          name: Jane Josephine Doe
          email: janedoe@exampleco.com
          picture: http://exampleco.com/janedoe/me.jpg
          updated: 2020-01-23T12:00:00Z
        - id: github|24828976
          native_id: 24828976
          login: jjdoe
          name: Jane Josephine Doe
          email: janedoe@exampleco.com
          picture: http://exampleco.com/janedoe/me.jpg
          updated: 2020-01-23T12:00:00Z
      properties:
        admins:
          items:
            $ref: '#/components/schemas/User'
          type: array
        regulars:
          items:
            $ref: '#/components/schemas/User'
          type: array
      required:
      - admins
      - regulars
      type: object
    InvitationLink:
      additionalProperties: false
      example:
        url: https://app.athenian.co/i/deadf88d
      properties:
        url:
          description: Invitation URL. Users are supposed to click it and become admins
            or regular account members.
          format: url
          type: string
      required:
      - url
      type: object
    InvitationCheckResult:
      additionalProperties: false
      example:
        active: true
        type: regular
        valid: true
      properties:
        active:
          description: Value indicating whether the invitation is still enabled.
          type: boolean
        type:
          description: Invited user's account membership status.
          enum:
          - admin
          - regular
          type: string
        valid:
          description: Value indicating whether the invitation URL is correctly formed.
          type: boolean
      required:
      - valid
      type: object
    InstallationProgress:
      additionalProperties: false
      description: Data fetching progress of the Athenian metadata retrieval app.
      example:
        tables:
        - fetched: 50
          name: Commit
          total: 100
        - fetched: 0
          name: PullRequest
          total: 20
        finished_date: 2020-01-23T04:56:07Z
        started_date: 2020-01-23T06:56:07Z
        owner: vmarkovtsev
        repositories: 30
      properties:
        started_date:
          description: Date and time when the historical data collection began.
          format: date-time
          type: string
        finished_date:
          description: Date and time when the historical data collection ended.
          format: date-time
          nullable: true
          type: string
        owner:
          description: Native user ID of the person who installed the metadata retrieval
            app.
          type: string
        repositories:
          description: Number of discovered repositories.
          minimum: 0
          type: integer
        tables:
          example:
          - fetched: 50
            name: Commit
            total: 100
          - fetched: 0
            total: 200
            name: PullRequest
          items:
            $ref: '#/components/schemas/TableFetchingProgress'
          type: array
      required:
      - finished_date
      - owner
      - repositories
      - started_date
      - tables
      type: object
    TableFetchingProgress:
      additionalProperties: false
      description: Used in InstallationProgress.tables to indicate how much data has
        been loaded in each DB table.
      example:
        fetched: 50
        name: Commit
        total: 100
      properties:
        fetched:
          description: How many records have been stored in the DB table so far.
          minimum: 0
          type: integer
        name:
          description: DB table identifier.
          type: string
        total:
          description: How many records the DB table is expected to have.
          minimum: 1
          type: integer
      required:
      - fetched
      - name
      - total
      type: object
    ForSet:
      additionalProperties: false
      description: Filter for `/metrics/prs`.
      example:
        repositories:
        - github.com/athenianco/athenian-webapp
        - github.com/athenianco/athenian-api
        with:
          author:
          - github.com/vmarkovtsev
          - github.com/dpordomingo
        labels_include:
        - bug
      properties:
        repositories:
          $ref: '#/components/schemas/RepositorySet'
        repogroups:
          $ref: '#/components/schemas/RepositoryGroups'
        with:
          $ref: '#/components/schemas/PullRequestWith'
        labels_include:
          description: At least one of these labels must be present in each analyzed
            PR.
          items:
            type: string
          type: array
        labels_exclude:
          description: None of these labels must be present in each analyzed PR.
          items:
            type: string
          type: array
        jira:
          $ref: '#/components/schemas/JIRAFilter'
        lines:
          description: Split by changed number of lines (inserted + removed).
          items:
            minimum: 0
            type: integer
          minLength: 2
          type: array
      required:
      - repositories
      type: object
    ForSetDevelopers:
      additionalProperties: false
      description: Filter for `/metrics/developers`.
      example:
        repositories:
        - github.com/athenianco/athenian-webapp
        - github.com/athenianco/athenian-api
        developers:
        - github.com/vmarkovtsev
        - github.com/dpordomingo
      properties:
        repositories:
          $ref: '#/components/schemas/RepositorySet'
        developers:
          $ref: '#/components/schemas/DeveloperSet'
        repogroups:
          $ref: '#/components/schemas/RepositoryGroups'
        labels_include:
          description: PRs must be labeled with at least one name from this list so
            that the related metrics include them.
          items:
            type: string
          type: array
        labels_exclude:
          description: PRs must not be labeled with any name from this list so that
            the related metrics exclude them.
          items:
            type: string
          type: array
        jira:
          $ref: '#/components/schemas/JIRAFilter'
      required:
      - developers
      - repositories
      type: object
    Granularity:
      description: 'How often the metrics are reported. The value must satisfy the
        following regular expression: /^(([1-9]\d* )?(day|week|month|year)|all)$/.
        "all" produces a single interval [`date_from`, `date_to`].'
      example: 2 week
      type: string
    PullRequestMetricsRequest:
      additionalProperties: false
      description: Request for calculating metrics on top of pull requests data.
      example:
        for:
        - repositories:
          - github.com/athenianco/athenian-webapp
          - github.com/athenianco/athenian-api
          developers:
          - github.com/vmarkovtsev
          - github.com/dpordomingo
        - repositories:
          - github.com/athenianco/athenian-webapp
          - github.com/athenianco/athenian-api
          developers:
          - github.com/vmarkovtsev
          - github.com/dpordomingo
        metrics:
        - pr-lead-time
        - pr-wip-time
        date_from: 2020-01-23
        date_to: 2020-01-24
        granularities:
        - day
        account: 1
      properties:
        for:
          description: |-
            Sets of developers and repositories for which to calculate the metrics.
            The aggregation is `AND` between repositories and developers.
            The aggregation is `OR` inside both repositories and developers.
          items:
            $ref: '#/components/schemas/ForSet'
          type: array
        metrics:
          description: Requested metric identifiers.
          items:
            $ref: '#/components/schemas/PullRequestMetricID'
          type: array
        date_from:
          description: Date from when to start measuring the metrics.
          format: date
          type: string
        date_to:
          description: Date up to which to measure the metrics.
          format: date
          type: string
        timezone:
          $ref: '#/components/schemas/TimeZone'
        granularities:
          items:
            $ref: '#/components/schemas/Granularity'
          type: array
        quantiles:
          $ref: '#/components/schemas/Quantiles'
        exclude_inactive:
          description: Value indicating whether PRs without events in the given time
            frame shall be ignored.
          type: boolean
        account:
          description: Session account ID.
          type: integer
        fresh:
          description: Force metrics calculation on the most up to date data.
          type: boolean
      required:
      - account
      - date_from
      - date_to
      - exclude_inactive
      - for
      - granularities
      - metrics
      type: object
    CalculatedPullRequestMetricsItem:
      additionalProperties: false
      description: Series of calculated metrics for a specific set of repositories
        and developers.
      example:
        values:
        - date: 2020-01-23
          values:
          - 0.8008282
          - 0.8008282
          confidence_mins:
          - 0.5
          - 0.5
          confidence_maxs:
          - 1.0
          - 1.0
          confidence_scores:
          - 75
          - 75
        - date: 2020-01-24
          values:
          - 0.8008282
          - 0.8008282
          confidence_mins:
          - 0.5
          - 0.5
          confidence_maxs:
          - 1.0
          - 1.0
          confidence_scores:
          - 75
          - 75
        for:
          repositories:
          - github.com/athenianco/athenian-webapp
          - github.com/athenianco/athenian-api
          developers:
          - github.com/vmarkovtsev
          - github.com/dpordomingo
        granularity: day
      properties:
        for:
          $ref: '#/components/schemas/ForSet'
        granularity:
          $ref: '#/components/schemas/Granularity'
        values:
          items:
            $ref: '#/components/schemas/CalculatedLinearMetricValues'
          type: array
      required:
      - for
      - values
      type: object
    Quantiles:
      description: |-
        Cut the distributions at certain quantiles. The default is [0, 1].
      example:
      - 0
      - 0.95
      items:
        maximum: 1
        minimum: 0
        type: number
      maxItems: 2
      minItems: 2
      type: array
    CalculatedPullRequestMetrics:
      additionalProperties: false
      description: The dates start from `date_from` and end earlier or equal to `date_to`.
      example:
        metrics:
        - pr-lead-time
        - pr-wip-time
        date_from: 2020-01-23
        date_to: 2020-01-24
        granularities:
        - day
        calculated:
        - values:
          - date: 2020-01-23
            values:
            - 0.8008282
            - 0.8008282
            confidence_mins:
            - 0.5
            - 0.5
            confidence_maxs:
            - 1.0
            - 1.0
            confidence_scores:
            - 75
            - 75
          - date: 2020-01-24
            values:
            - 0.8008282
            - 0.8008282
            confidence_mins:
            - 0.5
            - 0.5
            confidence_maxs:
            - 1.0
            - 1.0
            confidence_scores:
            - 75
            - 75
          for:
            developers:
            - github.com/vmarkovtsev
            - github.com/dpordomingo
            repositories:
            - github.com/athenianco/athenian-webapp
            - github.com/athenianco/athenian-api
        - values:
          - date: 2020-01-23
            values:
            - 0.8008282
            - 0.8008282
            confidence_mins:
            - 0.5
            - 0.5
            confidence_maxs:
            - 1.0
            - 1.0
            confidence_scores:
            - 75
            - 75
          - date: 2020-01-24
            values:
            - 0.8008282
            - 0.8008282
            confidence_mins:
            - 0.5
            - 0.5
            confidence_maxs:
            - 1.0
            - 1.0
            confidence_scores:
            - 75
            - 75
          for:
            developers:
            - github.com/vmarkovtsev
            - github.com/dpordomingo
            repositories:
            - github.com/athenianco/athenian-webapp
            - github.com/athenianco/athenian-api
      properties:
        calculated:
          description: Values of the requested metrics through time.
          items:
            $ref: '#/components/schemas/CalculatedPullRequestMetricsItem'
          type: array
        metrics:
          description: Repeats `PullRequestMetricsRequest.metrics`.
          items:
            $ref: '#/components/schemas/PullRequestMetricID'
          type: array
        date_from:
          description: Repeats `PullRequestMetricsRequest.date_from`.
          format: date
          type: string
        date_to:
          description: Repeats `PullRequestMetricsRequest.date_to`.
          format: date
          type: string
        timezone:
          $ref: '#/components/schemas/TimeZone'
        granularities:
          items:
            $ref: '#/components/schemas/Granularity'
          type: array
        quantiles:
          $ref: '#/components/schemas/Quantiles'
        exclude_inactive:
          description: Repeats `PullRequestMetricsRequest.exclude_inactive`.
          type: boolean
      required:
      - calculated
      - date_from
      - date_to
      - exclude_inactive
      - granularities
      - metrics
      - quantiles
      type: object
    CalculatedLinearMetricValues:
      additionalProperties: false
      example:
        date: 2020-01-23
        values:
        - 0.8008282
        - 0.8008282
        confidence_mins:
        - 0.5
        - 0.5
        confidence_maxs:
        - 1.0
        - 1.0
        confidence_scores:
        - 75
        - 75
      properties:
        date:
          description: Where you should relate the metric value to on the time axis.
          format: date
          type: string
        values:
          description: Calculated metric values in the same order as `metrics`.
          items:
# {% if False %}
            allOf:
# {% else %}{{ "\n" }}            oneOf:{% endif %}
            - type: integer
            - format: float
              type: number
            - $ref: '#/components/schemas/TimeDuration'
          type: array
        confidence_mins:
          description: Confidence interval @ p=0.8, minimum. The same order as `metrics`.
            It is optional because there can be exact metrics like "count open PRs
            per month".
          items:
# {% if False %}
            allOf:
# {% else %}{{ "\n" }}            oneOf:{% endif %}
            - type: integer
            - format: float
              type: number
            - $ref: '#/components/schemas/TimeDuration'
          type: array
        confidence_maxs:
          description: Confidence interval @ p=0.8, maximum. The same order as `metrics`.
            It is optional because there can be exact metrics like "count open PRs
            per month".
          items:
# {% if False %}
            allOf:
# {% else %}{{ "\n" }}            oneOf:{% endif %}
            - type: integer
            - format: float
              type: number
            - $ref: '#/components/schemas/TimeDuration'
          type: array
        confidence_scores:
          description: Confidence score from 0 (no idea) to 100 (very confident).
            The same order as `metrics`.
          items:
            type: integer
          type: array
      required:
      - date
      - values
      type: object
    FilterRepositoriesRequest:
      additionalProperties: false
      description: Filters for `/filter/repositories`.
      example:
        account: 1
        date_from: 2020-01-23
        date_to: 2020-05-23
        in:
        - '{1}'
      properties:
        account:
          description: Session account ID.
          type: integer
        date_from:
          description: Updates must be later than or equal to this date. An update
            is any action that influences the stage assignment.
          format: date
          type: string
        date_to:
          description: Updates must be earlier than or equal to this date. An update
            is any action that influences the stage assignment.
          format: date
          type: string
        timezone:
          $ref: '#/components/schemas/TimeZone'
        in:
          $ref: '#/components/schemas/RepositorySet'
        exclude_inactive:
          description: Value indicating whether PRs without events in the given time
            frame shall be ignored as repository triggers.
          type: boolean
      required:
      - account
      - date_from
      - date_to
      type: object
    FilterReleasesRequest:
      additionalProperties: false
      description: Filters for `/filter/releases`.
      example:
        account: 1
        date_from: 2020-01-23
        date_to: 2020-05-23
        in:
        - '{1}'
        with:
          pr_author:
          - github.com/vmarkovtsev
      properties:
        account:
          description: Session account ID.
          type: integer
        date_from:
          description: Updates must be later than or equal to this date. An update
            is any action that influences the stage assignment.
          format: date
          type: string
        date_to:
          description: Updates must be earlier than or equal to this date. An update
            is any action that influences the stage assignment.
          format: date
          type: string
        timezone:
          $ref: '#/components/schemas/TimeZone'
        in:
          $ref: '#/components/schemas/RepositorySet'
        with:
          $ref: '#/components/schemas/ReleaseWith'
      required:
      - account
      - date_from
      - date_to
      type: object
    FilterContributorsRequest:
      additionalProperties: false
      description: Filters for `/filter/contributors`.
      example:
        account: 1
        date_from: 2020-01-23
        date_to: 2020-05-23
        in:
        - '{1}'
        as:
        - author
        - committer
      properties:
        account:
          description: Session account ID.
          type: integer
        date_from:
          description: Updates must be later than or equal to this date. An update
            is any action that influences the stage assignment.
          format: date
          type: string
        date_to:
          description: Updates must be earlier than or equal to this date. An update
            is any action that influences the stage assignment.
          format: date
          type: string
        timezone:
          $ref: '#/components/schemas/TimeZone'
        in:
          $ref: '#/components/schemas/RepositorySet'
        as:
          items:
            enum:
            - author
            - reviewer
            - commit_author
            - commit_committer
            - commenter
            - merger
            - releaser
            type: string
          type: array
      required:
      - account
      - date_from
      - date_to
      type: object
    FilterPullRequestsRequest:
      additionalProperties: false
      description: Filters for `/filter/pull_requests`. Empty `properties` passes
        through all PRs matched by the other filters.
      example:
        account: 1
        date_from: 2020-01-23
        date_to: 2020-05-23
        in:
        - '{1}'
        properties:
        - wip
        with:
          author:
          - github.com/vmarkovtsev
      properties:
        account:
          description: Session account ID.
          type: integer
        date_from:
          description: PRs must be updated later than or equal to this date.
          format: date
          type: string
        date_to:
          description: PRs must be updated earlier than or equal to this date.
          format: date
          type: string
        timezone:
          $ref: '#/components/schemas/TimeZone'
        in:
          $ref: '#/components/schemas/RepositorySet'
        properties:
          items:
            $ref: '#/components/schemas/PullRequestProperty'
          type: array
        events:
          description: Allowed PR events that happened between `date_from` and `date_to`.
          items:
            $ref: '#/components/schemas/PullRequestEvent'
          type: array
        stages:
          description: Allowed PR stages that are defined at `date_to`.
          items:
            $ref: '#/components/schemas/PullRequestStage'
          type: array
        with:
          $ref: '#/components/schemas/PullRequestWith'
        labels_include:
          description: At least one of these labels must be present in each returned
            PR.
          items:
            type: string
          type: array
        labels_exclude:
          description: None of these labels must be present in each returned PR.
          items:
            type: string
          type: array
        exclude_inactive:
          description: Value indicating whether PRs without events in the given time
            frame shall be ignored.
          type: boolean
        jira:
          $ref: '#/components/schemas/JIRAFilter'
        updated_from:
          description: 'Paginate the response: the returned PRs are updated no older
            than this timestamp, including the beginning.'
          format: date
          type: string
        updated_to:
          description: 'Paginate the response: the returned PRs are updated no later
            than this timestamp, not including the ending.'
          format: date
          type: string
        limit:
          description: Maximum number of pull requests to return. The list is sorted
            by the last update timestamp. `null` means no limit.
          minimum: 1
          nullable: true
          type: integer
      required:
      - account
      - date_from
      - date_to
      - exclude_inactive
      - in
      type: object
    PullRequestProperty:
      description: |-
        PR's modelled lifecycle stage or various events that happened between `time_from` and `time_to`.
        * `wip`: PRs in Work In Progress stage - that is, not yet reviewed or merged.
        * `created`: opened PRs. Note: they were opened in the given time window.
        * `commit_happened`: PRs with a new commit pushed. Note: the commits were pushed in the given time window.
        * `review_request_happened`: PRs where the author requested a review. Note: the review was requested in the given time window.
        * `reviewing`: PRs in Review stage - that is, a review was requested or at least one review happened, but not approved yet.
        * `review_happened`: PRs with new review. Note: they were reviewed in the given time window.
        * `approve_happened`: PRs with new review approvals. Note: they were approved in the given time window.
        * `changes_request_happened`: PRs with new review rejections. Note: they were rejected in the given time window.
        * `merging`: PRs in Merge stage - that is, already reviewed but not yet merged.
        * `merge_happened`: merged PRs. Note: they were merged in the given time window.
        * `releasing`: PRs in Release stage - that is, already merged but not yet released.
        * `release_happened`: released PRs. Note: they were released in the given time window.
        * `rejection_happened`: rejected PRs - closed without merge. Note: they were rejected in the given time window.
        * `done`: either released or otherwise closed PRs - "afterlife".
        * `force_push_dropped`: merged PR that was later discarded from the entire Git history, a subset of `done`.
      enum:
      - wip
      - created
      - commit_happened
      - review_request_happened
      - reviewing
      - review_happened
      - approve_happened
      - changes_request_happened
      - merging
      - merge_happened
      - releasing
      - release_happened
      - rejection_happened
      - done
      - force_push_dropped
      example: wip
      type: string
    PullRequestEvent:
      description: |-
        PR's modelled lifecycle events.
        * `created`: The PR was opened.
        * `committed`: Somebody pushed a commit to the PR.
        * `review_requested`: Somebody requested a PR review.
        * `reviewed`: Somebody reviewed the PR (either approved, requested changes, or commented).
        * `approved`: Somebody approved the PR. Note that if there were negative reviews from other participants, an approval does *not* trigger this event.
        * `changes_requested`: Somebody submitted a negative PR review.
        * `merged`: Somebody merged the PR.
        * `released`: The PR was released.
        * `rejected`: Somebody closed the PR without merging.
      enum:
      - created
      - committed
      - review_requested
      - reviewed
      - approved
      - changes_requested
      - merged
      - released
      - rejected
      example: created
      type: string
    PullRequestStage:
      description: |-
        PR's modelled lifecycle stages.
        * `wip`: The PR is a work-in-progress: no reviews, no review requests, not closed.
        * `reviewing`: The PR is going through a review process.
        * `merging`: The PR was approved and is waiting for merge.
        * `releasing`: The PR was merged but is not released yet.
        * `force_push_dropped`: The PR was closed but the Git commit history was rewritten and the PR's commits no longer exist.
        * `done`: The PR was either closed without merging or released or force push dropped.
      enum:
      - wip
      - reviewing
      - merging
      - releasing
      - force_push_dropped
      - done
      example: created
      type: string
    PullRequestSet:
      additionalProperties: false
      description: List of pull requests together with the participant profile pictures.
      example:
        include:
          users:
            key:
              avatar: https://avatars0.githubusercontent.com/u/60340680?v=4
        data:
        - repository: github.com/src-d/go-git
          number: 1152
          title: 'Fix an edge case when fetching remotes with unrelated incomplete
            history. Fixes #1151'
          size_added: 37
          size_removed: 1
          files_changed: 2
          created: 2019-05-17T01:14:00Z
          updated: 2019-09-18T10:49:00Z
          properties:
          - wip
          stage_timings:
            wip: 2000s
          participants:
          - id: github.com/NonLogicalDev
            status: author
          - id: github.com/mcuadros
            status: commenter
      properties:
        include:
          $ref: '#/components/schemas/IncludedNativeUsers'
        data:
          description: List of matched pull requests.
          items:
            $ref: '#/components/schemas/PullRequest'
          type: array
      required:
      - data
      - include
      type: object
    IncludedNativeUser:
      additionalProperties: false
      description: User traits such as the avatar URL.
      example:
        avatar: https://avatars0.githubusercontent.com/u/60340680?v=4
      properties:
        avatar:
          format: url
          type: string
      required:
      - avatar
      type: object
    IncludedNativeUsers:
      additionalProperties: false
      example:
        users:
          github.com/gkwillie:
            avatar: https://avatars0.githubusercontent.com/u/60340680?v=4
      properties:
        users:
          additionalProperties:
            $ref: '#/components/schemas/IncludedNativeUser'
          description: Mapping user native (e.g., GitHub) login ID -> user details.
            The users are mentioned in the PRs from "PullRequestSet.data" or in the
            commits from "FilterCommitsRequest.data".
          type: object
      required:
      - users
      type: object
    PullRequest:
      additionalProperties: false
      description: Details of a pull request. All the attributes, stats and events
        correspond to "today", not `date_to`, *except for the PR stages `wip`, `reviewing`,
        `merging`, `releasing`*, which correspond to `date_to`.
      example:
        # https://github.com/src-d/go-git/pull/1152
        repository: github.com/src-d/go-git
        number: 1152
        title: 'Fix an edge case when fetching remotes with unrelated incomplete history.
          Fixes #1151'
        size_added: 37
        size_removed: 1
        files_changed: 2
        created: 2019-05-17T01:14:00Z
        updated: 2019-09-18T10:49:00Z
        comments: 1
        commits: 2
        properties:
        - wip
        stage_timings:
          wip: 2000s
        participants:
        - id: github.com/NonLogicalDev
          status: author
        - id: github.com/mcuadros
          status: commenter
      properties:
        repository:
          description: PR is/was open in this repository.
          type: string
        number:
          description: PR number.
          minimum: 1
          type: integer
        title:
          description: Title of the PR.
          type: string
        size_added:
          description: Overall number of lines added.
          minimum: 0
          type: integer
        size_removed:
          description: Overall number of lines removed.
          minimum: 0
          type: integer
        files_changed:
          description: Number of files changed in this PR.
          minimum: 0
          type: integer
        created:
          description: When this PR was created.
          format: date-time
          type: string
        updated:
          description: When this PR was last updated.
          format: date-time
          type: string
        closed:
          description: When this PR was last closed.
          format: date-time
          type: string
        comments:
          description: Number of *regular* (not review) comments in this PR.
          minimum: 0
          type: integer
        commits:
          description: Number of commits in this PR.
          minimum: 0
          type: integer
        review_requested:
          description: When was the first time the author of this PR requested a review.
          format: date-time
          type: string
        first_review:
          description: When the first review of this PR happened.
          format: date-time
          type: string
        approved:
          description: When this PR was approved.
          format: date-time
          type: string
        review_comments:
          description: |-
            Number of review comments this PR received. A review comment is left at
            a specific line in a specific file. In other words: review summaries are
            *not* considered review comments; refer to `reviews`. Comments by the PR
            author are considered as `comments`, not as `review_comments`.
          minimum: 0
          type: integer
        reviews:
          description: Number of times this PR was reviewed. Reviews by the PR author
            are not taken into account.
          minimum: 0
          type: integer
        merged:
          description: When this PR was merged.
          format: date-time
          type: string
        released:
          description: When this PR was released.
          format: date-time
          type: string
        release_url:
          description: URL of the earliest release that includes this merged PR.
          format: url
          type: string
        stage_timings:
          $ref: '#/components/schemas/StageTimings'
        properties:
          description: DEPRECATED. List of the PR properties triggered in the given
            time window. There may be extra properties that were not originally requested.
          items:
            $ref: '#/components/schemas/PullRequestProperty'
          type: array
        events_time_machine:
          description: List of PR events which happened until `date_to`. `date_from`
            does not matter.
          items:
            $ref: '#/components/schemas/PullRequestEvent'
          type: array
        stage_time_machine:
          $ref: '#/components/schemas/PullRequestStage'
        events_now:
          description: List of PR events that ever happened.
          items:
            $ref: '#/components/schemas/PullRequestEvent'
          type: array
        stage_now:
          $ref: '#/components/schemas/PullRequestStage'
        participants:
          description: List of developers related to this PR.
          items:
            $ref: '#/components/schemas/PullRequestParticipant'
          type: array
        labels:
          description: List of PR labels.
          items:
            $ref: '#/components/schemas/PullRequestLabel'
          type: array
        jira:
          description: List of linked JIRA issues.
          items:
            $ref: '#/components/schemas/JIRAIssue'
          type: array
      required:
      - comments
      - commits
      - created
      - events_now
      - files_changed
      - number
      - participants
      - properties
      - repository
      - size_added
      - size_removed
      - stage_now
      - stage_timings
      - title
      - updated
      type: object
    StageTimings:
      additionalProperties: false
      description: Time spent by the PR in each pipeline stage.
      example:
        wip: 120s
        review: 600s
      properties:
        wip:
          type: string
        review:
          type: string
        merge:
          type: string
        release:
          type: string
      required:
      - wip
      type: object
    PullRequestParticipant:
      additionalProperties: false
      description: Developer and their role in the PR.
      properties:
        id:
          description: Person identifier.
          example: github.com/vmarkovtsev
          type: string
        status:
          items:
            enum:
            - author
            - reviewer
            - commit_author
            - commit_committer
            - commenter
            - merger
            - releaser
            type: string
          type: array
      required:
      - id
      - status
      type: object
    PullRequestWith:
      additionalProperties: false
      description: |-
        Triage PRs by various developer participation. The aggregation is `OR` between
        the participation groups and `OR` within each group. For example, if our request is
        ```
        {"author": ["github.com/vmarkovtsev"], "reviewer": ["github.com/gkwillie", "github.com/mcuadros"]}
        ```
        then the matched PRs will have **@vmarkovtsev** as the author or either
        **@gkwillie** or **@mcuadros** as the reviewers.
      example:
        author:
        - github.com/vmarkovtsev
      properties:
        author:
          $ref: '#/components/schemas/DeveloperSet'
        reviewer:
          $ref: '#/components/schemas/DeveloperSet'
        commit_author:
          $ref: '#/components/schemas/DeveloperSet'
        commit_committer:
          $ref: '#/components/schemas/DeveloperSet'
        commenter:
          $ref: '#/components/schemas/DeveloperSet'
        merger:
          $ref: '#/components/schemas/DeveloperSet'
        releaser:
          $ref: '#/components/schemas/DeveloperSet'
      type: object
    PullRequestLabel:
      additionalProperties: false
      description: Pull request label.
      example:
        name: bug
        color: fc2929
      properties:
        name:
          type: string
        description:
          type: string
        color:
          type: string
      required:
      - color
      - name
      type: object
    FilterCommitsRequest:
      additionalProperties: false
      description: Filter for listing commits.
      example:
        account: 1
        date_from: 2020-01-23
        date_to: 2020-05-23
        in:
        - '{1}'
        property: bypassing_prs
      properties:
        account:
          description: Session account ID.
          type: integer
        date_from:
          description: Commits must be made later than or equal to this date.
          format: date
          type: string
        date_to:
          description: Commits must be made earlier than or equal to this date.
          format: date
          type: string
        timezone:
          $ref: '#/components/schemas/TimeZone'
        in:
          $ref: '#/components/schemas/RepositorySet'
        with_author:
          $ref: '#/components/schemas/DeveloperSet'
        with_committer:
          $ref: '#/components/schemas/DeveloperSet'
        property:
          description: |-
            Main trait of the commits - the core of the filter.
            * no_pr_merges: select all the commits but PR merges by noreply@github.com
            * bypassing_prs: select commits that were pushed without creating a PR
          enum:
          - no_pr_merges
          - bypassing_prs
          type: string
      required:
      - account
      - date_from
      - date_to
      - in
      - property
      type: object
    CommitsList:
      additionalProperties: false
      description: List of commits metadata and related user details.
      example:
        include:
          users:
            github.com/gkwillie:
              avatar: https://avatars0.githubusercontent.com/u/60340680?v=4
        data:
        - repository: github.com/athenianco/athenian-api
          hash: 79f0bccb856b35ef08ec93da2ff5585da4d2e50e
          author:
            login: github.com/gkwillie
            name: Groundskeeper Willie
            email: bot@athenian.co
            timestamp: 2020-02-25T14:27:21Z
            timezone: 1.0
          committer:
            login: github.com/gkwillie
            name: Groundskeeper Willie
            email: bot@athenian.co
            timestamp: 2020-02-25T14:27:21Z
            timezone: 1.0
          message: 'Bump version: 0.0.42 → 0.0.43'
          size_added: 1
          size_removed: 1
          files_changed: 1
        - repository: github.com/athenianco/athenian-api
          hash: 0d13a3e021fe4219915ba97ea07e465e429a621f
          author:
            login: github.com/gkwillie
            name: Groundskeeper Willie
            email: bot@athenian.co
            timestamp: 2020-03-20T10:06:49Z
            timezone: 1.0
          committer:
            login: github.com/gkwillie
            name: Groundskeeper Willie
            email: bot@athenian.co
            timestamp: 2020-03-20T10:06:49Z
            timezone: 1.0
          message: 'Bump version: 0.0.78 → 0.0.79'
          size_added: 1
          size_removed: 1
          files_changed: 1
      properties:
        data:
          items:
            $ref: '#/components/schemas/Commit'
          type: array
        include:
          $ref: '#/components/schemas/IncludedNativeUsers'
      required:
      - data
      - include
      type: object
    Commit:
      additionalProperties: false
      description: Information about a commit.
      example:
        repository: github.com/athenianco/athenian-api
        hash: 79f0bccb856b35ef08ec93da2ff5585da4d2e50e
        author:
          login: github.com/gkwillie
          name: Groundskeeper Willie
          email: bot@athenian.co
          timestamp: 2020-02-25T14:27:21Z
          timezone: 1.0
        committer:
          login: github.com/gkwillie
          name: Groundskeeper Willie
          email: bot@athenian.co
          timestamp: 2020-02-25T14:27:21Z
          timezone: 1.0
        message: 'Bump version: 0.0.42 → 0.0.43'
        size_added: 1
        size_removed: 1
        files_changed: 1
      properties:
        repository:
          $ref: '#/components/schemas/RepositoryID'
        hash:
          description: Git commit hash.
          type: string
        author:
          $ref: '#/components/schemas/CommitSignature'
        committer:
          $ref: '#/components/schemas/CommitSignature'
        message:
          description: Commit message.
          type: string
        size_added:
          description: Overall number of lines added.
          minimum: 0
          type: integer
        size_removed:
          description: Overall number of lines removed.
          minimum: 0
          type: integer
        files_changed:
          description: Number of files changed in this PR.
          minimum: 0
          type: integer
      required:
      - author
      - committer
      - files_changed
      - hash
      - message
      - repository
      - size_added
      - size_removed
      type: object
    CommitSignature:
      additionalProperties: false
      description: Git commit signature. It is guaranteed that `login` and/or `name`&`email`
        are present.
      example:
        login: github.com/vmarkovtsev
        name: Vadim Markovtsev
        email: vadim@athenian.co
        timestamp: 2020-02-25T14:27:21Z
        timezone: 1.0
      properties:
        login:
          $ref: '#/components/schemas/DeveloperID'
        name:
          description: Git signature name.
          type: string
        email:
          description: Git signature email.
          type: string
        timestamp:
          description: When the corresponding action happened in UTC.
          format: date-time
          type: string
        timezone:
          description: Timezone offset of the action timestamp (in hours).
          format: float
          type: number
      required:
      - timestamp
      - timezone
      type: object
    CodeFilter:
      additionalProperties: false
      description: Filter for revealing code bypassing PRs.
      example:
        account: 1
        date_from: 2020-01-01
        date_to: 2020-03-01
        granularity: day
        in:
        - '{1}'
        with_author:
        - github.com/vmarkovtsev
      properties:
        account:
          description: Session account ID.
          type: integer
        date_from:
          description: Commits must be made later than or equal to this date.
          format: date
          type: string
        date_to:
          description: Commits must be made earlier than or equal to this date.
          format: date
          type: string
        timezone:
          $ref: '#/components/schemas/TimeZone'
        in:
          $ref: '#/components/schemas/RepositorySet'
        with_author:
          $ref: '#/components/schemas/DeveloperSet'
        with_committer:
          $ref: '#/components/schemas/DeveloperSet'
        granularity:
          $ref: '#/components/schemas/Granularity'
      required:
      - account
      - date_from
      - date_to
      - granularity
      - in
      type: object
    MeasuredCodeBypassingPRs:
      description: Statistics about code pushed outside of pull requests.
      example:
      - date: 2020-01-23
        bypassed_commits: 1
        bypassed_lines: 20
        total_commits: 2
        total_lines: 50
      - date: 2020-01-24
        bypassed_commits: 2
        bypassed_lines: 30
        total_commits: 3
        total_lines: 60
      items:
        $ref: '#/components/schemas/CodeBypassingPRsMeasurement'
      type: array
    CodeBypassingPRsMeasurement:
      additionalProperties: false
      description: Statistics about code pushed outside of pull requests in a certain
        time interval.
      example:
        date: 2020-01-23
        bypassed_commits: 1
        bypassed_lines: 20
        total_commits: 2
        total_lines: 50
      properties:
        date:
          description: Commits were pushed beginning with this date. They were not
            pushed later than +granularity.
          format: date
          type: string
        bypassed_commits:
          description: Number of commits that bypassed PRs in the time interval.
          minimum: 0
          type: integer
        bypassed_lines:
          description: Number of changed (added + removed) lines that bypassed PRs
            in the time interval.
          minimum: 0
          type: integer
        total_commits:
          description: Overall number of commits in the time interval.
          minimum: 0
          type: integer
        total_lines:
          description: Overall number of changed (added + removed) lines in the time
            interval.
          minimum: 0
          type: integer
      required:
      - bypassed_commits
      - bypassed_lines
      - date
      - total_commits
      - total_lines
      type: object
    DeveloperMetricsRequest:
      additionalProperties: false
      description: Request for calculating metrics on top of developer activities.
      example:
        for:
        - repositories:
          - github.com/athenianco/athenian-webapp
          - github.com/athenianco/athenian-api
          developers:
          - github.com/vmarkovtsev
          - github.com/dpordomingo
        - repositories:
          - github.com/athenianco/athenian-webapp
          - github.com/athenianco/athenian-api
          developers:
          - github.com/vmarkovtsev
          - github.com/dpordomingo
        metrics:
        - dev-reviews
        - dev-prs-created
        - dev-pr-comments
        date_from: 2019-10-23
        date_to: 2020-05-23
        account: 1
      properties:
        for:
          description: Sets of developers and repositories to calculate the metrics
            for.
          items:
            $ref: '#/components/schemas/ForSetDevelopers'
          type: array
        metrics:
          description: Requested metric identifiers.
          items:
            $ref: '#/components/schemas/DeveloperMetricID'
          type: array
        date_from:
          description: Date from when to start measuring the metrics.
          format: date
          type: string
        date_to:
          description: Date up to which to measure the metrics.
          format: date
          type: string
        timezone:
          $ref: '#/components/schemas/TimeZone'
        account:
          description: Session account ID.
          type: integer
      required:
      - account
      - date_from
      - date_to
      - for
      - metrics
      type: object
    DeveloperMetricID:
      description: |-
        Currently supported developer metric types.
        * `dev-commits-pushed`: how many commits were pushed.
        * `dev-lines-changed`: how many lines were either inserted or removed in the pushed commits.
        * `dev-prs-created`: how many PRs were created.
        * `dev-prs-reviewed`: how many *distinct* PRs were reviewed (approved, rejected or neutral).
        * `dev-prs-merged`: how many PRs were merged by this developer. This is *not* how many authored PRs were merged!
        * `dev-releases`: how many releases were authored by this developer.
        * `dev-reviews`: how many reviews were submitted. One PR may have several reviews by the same developer! This value equals to the sum of `dev-review-approvals`, `dev-review-rejections` and `dev-review-neutrals`.
        * `dev-review-approvals`: how many approvals this developer submitted. One PR may have several approvals by the same developer!
        * `dev-review-rejections`: how many rejections this developer submitted. One PR may have several rejections by the same developer!
        * `dev-review-neutrals`: how many neutral ("comment") reviews this developer submitted. One PR may have several neutral reviews by the same developer!
        * `dev-pr-comments`: how many comments (both regular and review) this developer posted.
        * `dev-regular-pr-comments`: how many regular comments (not review suggestions!) this developer posted.
        * `dev-review-pr-comments`: how many review suggestions (summaries are not considered!) this developer posted.
      enum:
      - dev-commits-pushed
      - dev-lines-changed
      - dev-prs-created
      - dev-prs-reviewed
      - dev-prs-merged
      - dev-releases
      - dev-reviews
      - dev-review-approvals
      - dev-review-rejections
      - dev-review-neutrals
      - dev-pr-comments
      - dev-regular-pr-comments
      - dev-review-pr-comments
      example: dev-prs-created
      type: string
    CalculatedDeveloperMetrics:
      additionalProperties: false
      description: Response from /metrics/developers - calculated metrics over developer
        activities.
      example:
        date_from: 2020-01-23
        date_to: 2020-01-24
        metrics:
        - dev-prs-created
        - dev-reviews
        calculated:
        - values:
          - - 20
            - 5
          - - 10
            - 100
          for:
            repositories:
            - github.com/athenianco/athenian-webapp
            - github.com/athenianco/athenian-api
            developers:
            - github.com/vmarkovtsev
            - github.com/dpordomingo
        - values:
          - - 20
            - 5
          - - 10
            - 100
          for:
            repositories:
            - github.com/athenianco/athenian-webapp
            - github.com/athenianco/athenian-api
            developers:
            - github.com/vmarkovtsev
            - github.com/dpordomingo
      properties:
        calculated:
          description: Values of the requested metrics on the given time interval.
          items:
            $ref: '#/components/schemas/CalculatedDeveloperMetricsItem'
          type: array
        date_from:
          description: Repeats `DeveloperMetricsRequest.date_from`.
          format: date
          type: string
        date_to:
          description: Repeats `DeveloperMetricsRequest.date_to`.
          format: date
          type: string
        timezone:
          $ref: '#/components/schemas/TimeZone'
        metrics:
          description: Repeats `DeveloperMetricsRequest.metrics`.
          items:
            $ref: '#/components/schemas/DeveloperMetricID'
          type: array
      required:
      - calculated
      - date_from
      - date_to
      - metrics
      type: object
    CalculatedDeveloperMetricsItem:
      additionalProperties: false
      description: Measured developer metrics for each `DeveloperMetricsRequest.for`.
        Each repository group maps to a distinct `CalculatedDeveloperMetricsItem`.
      example:
        values:
        - - 20
          - 5
        - - 10
          - 100
        for:
          repositories:
          - github.com/athenianco/athenian-webapp
          - github.com/athenianco/athenian-api
          developers:
          - github.com/vmarkovtsev
          - github.com/dpordomingo
      properties:
        for:
          $ref: '#/components/schemas/ForSetDevelopers'
        values:
          description: The sequence matches `CalculatedDeveloperMetricsItem.for.developers`.
          items:
            $ref: '#/components/schemas/CalculatedDeveloperMetricValues'
          type: array
      required:
      - for
      - values
      type: object
    CalculatedDeveloperMetricValues:
      description: Calculated metrics for the developer at the corresponding place
        in `CalculatedDeveloperMetricsItem.for.developers`. The sequence of values
        matches `CalculatedDeveloperMetrics.metrics`.
      items:
# {% if False %}
        allOf:
# {% else %}{{ "\n" }}        oneOf:{% endif %}
        - type: integer
        - format: float
          type: number
        - type: string
      type: array
    DeveloperSummaries:
      description: List of developer activity statistics and profile details.
      example:
      - avatar: https://avatars0.githubusercontent.com/u/60340680?v=4
        login: github.com/gkwillie
        name: Groundskeeper Willie
        updates:
          prs: 4
          commit_author: 10
          commit_committer: 10
          commenter: 3
      items:
        $ref: '#/components/schemas/DeveloperSummary'
      type: array
    DeveloperSummary:
      additionalProperties: false
      description: Developer activity statistics and profile details.
      example:
        avatar: https://avatars0.githubusercontent.com/u/60340680?v=4
        login: github.com/gkwillie
        name: Groundskeeper Willie
        updates:
          prs: 4
          commit_author: 10
          commit_committer: 10
          commenter: 3
      properties:
        login:
          description: Developer's login name.
          example: github.com/gkwillie
          type: string
        name:
          description: Developer's full name.
          example: Groundskeeper Willie
          type: string
        avatar:
          description: Developer's avatar URL.
          example: https://avatars0.githubusercontent.com/u/60340680?v=4
          format: url
          type: string
        updates:
          $ref: '#/components/schemas/DeveloperUpdates'
      required:
      - avatar
      - login
      - name
      - updates
      type: object
    DeveloperUpdates:
      additionalProperties: false
      description: 'Various developer contributions statistics over the specified
        time period. Note: any of these properties may be missing if there was no
        such activity.'
      example:
        prs: 4
        commit_author: 10
        commit_committer: 10
        merger: 3
      properties:
        prs:
          description: 'How many PRs authored by this developer updated. Note: this
            is not the same as the number of PRs this developer opened. Note: the
            update origin is not necessarily this developer.'
          minimum: 0
          type: integer
        reviewer:
          description: 'How many reviews this developer submitted. Note: this is not
            the same as the number of unique PRs reviewed.'
          minimum: 0
          type: integer
        commit_author:
          description: How many commits this developer authored.
          minimum: 0
          type: integer
        commit_committer:
          description: How many commits this developer pushed.
          minimum: 0
          type: integer
        commenter:
          description: 'How many regular PR comments this developer left. Note: issues
            are not taken into account, only the PRs.'
          minimum: 0
          type: integer
        releaser:
          description: How many releases this developer created.
          minimum: 0
          type: integer
      type: object
    FilteredReleases:
      additionalProperties: false
      description: Response of `/filter/releases` - releases metadata and user details.
      example:
        include:
          users:
            github.com/gkwillie:
              avatar: https://avatars0.githubusercontent.com/u/60340680?v=4
        data:
        - added_lines: 1000
          commits: 20
          deleted_lines: 200
          name: v0.0.93
          published: 2020-03-25T10:57:00Z
          publisher: github.com/vmarkovtsev
          publisher_avatar: https://avatars0.githubusercontent.com/u/60340680?v=4
          repository: github.com/athenianco/athenian-api
          url: https://github.com/athenianco/athenian-api/releases/tag/v0.0.93
        - added_lines: 1000
          commits: 20
          deleted_lines: 200
          name: v0.0.93
          published: 2020-03-25T10:57:00Z
          publisher: github.com/vmarkovtsev
          publisher_avatar: https://avatars0.githubusercontent.com/u/60340680?v=4
          repository: github.com/athenianco/athenian-api
          url: https://github.com/athenianco/athenian-api/releases/tag/v0.0.93
      properties:
        include:
          $ref: '#/components/schemas/IncludedNativeUsers'
        data:
          description: List of matching release metadata.
          items:
            $ref: '#/components/schemas/FilteredRelease'
          type: array
      type: object
    FilteredRelease:
      additionalProperties: false
      description: Various information about a repository release.
      example:
        added_lines: 1000
        commits: 20
        deleted_lines: 200
        name: v0.0.93
        published: 2020-03-25T10:57:00Z
        publisher: github.com/vmarkovtsev
        publisher_avatar: https://avatars0.githubusercontent.com/u/60340680?v=4
        repository: github.com/athenianco/athenian-api
        url: https://github.com/athenianco/athenian-api/releases/tag/v0.0.93
        prs:
        - number: 176
          title: Fix first account creation
          additions: 34
          deletions: 3
          author: github.com/se7entyse7en
      properties:
        name:
          description: Title of the release.
          type: string
        repository:
          description: Name of the repository where the release exists.
          type: string
        url:
          description: Link to the release.
          format: url
          type: string
        published:
          description: When the release was created.
          format: date-time
          type: string
        age:
          description: Time since the previous release /\d+s/.
          type: string
        added_lines:
          description: Cumulative number of lines inserted since the previous release.
          minimum: 0
          type: integer
        deleted_lines:
          description: Cumulative number of lines removed since the previous release.
          minimum: 0
          type: integer
        commits:
          description: Number of commits since the previous release.
          minimum: 0
          type: integer
        publisher:
          description: Login of the person who created the release.
          type: string
        commit_authors:
          description: List of released commit commit_authors' logins.
          items:
            $ref: '#/components/schemas/DeveloperID'
          type: array
        prs:
          description: List of released pull requests.
          items:
            $ref: '#/components/schemas/ReleasedPullRequest'
          type: array
      required:
      - added_lines
      - age
      - commit_authors
      - commits
      - deleted_lines
      - name
      - prs
      - published
      - publisher
      - repository
      - url
      type: object
    ReleasedPullRequest:
      additionalProperties: false
      description: Details about a pull request listed in `/filter/releases`.
      properties:
        number:
          type: integer
        title:
          type: string
        additions:
          type: integer
        deletions:
          type: integer
        author:
          $ref: '#/components/schemas/DeveloperID'
      required:
      - additions
      - author
      - deletions
      - number
      - title
      type: object
    ReleaseMatchRequest:
      additionalProperties: false
      description: Release matching rule setting.
      example:
        account: 1
        repositories:
        - github.com/athenianco/athenian-webapp
        - github.com/athenianco/athenian-api
        match: branch
        branches: master
        tags: .*
      properties:
        account:
          description: Account ID.
          type: integer
        repositories:
          $ref: '#/components/schemas/RepositorySet'
        branches:
          description: 'Regular expression to match branch names. Reference: https://www.postgresql.org/docs/current/functions-matching.html#FUNCTIONS-SIMILARTO-REGEXP'
          type: string
        tags:
          description: 'Regular expression to match tag names. Reference: https://www.postgresql.org/docs/current/functions-matching.html#FUNCTIONS-SIMILARTO-REGEXP'
          type: string
        match:
          $ref: '#/components/schemas/ReleaseMatchStrategy'
      required:
      - account
      - match
      - repositories
      type: object
    ReleaseMatchStrategy:
      description: |-
        Release workflow choice: how we should detect releases.
        * `branch`: merges to certain branches are considered releases and nothing else.
        * `tag`: tags with certain name patterns are considered releases and nothing else.
        * `tag_or_branch`: follow "tag"; if the repository does not have tags, fallback to "branch".
      enum:
      - branch
      - tag
      - tag_or_branch
      type: string
    ReleaseMatchSettings:
      additionalProperties:
        $ref: '#/components/schemas/ReleaseMatchSetting'
      description: Mapping from repository names to their release match settings.
      type: object
    ReleaseMatchSetting:
      additionalProperties: false
      description: Release matching setting for a specific repository.
      example:
        branches: '{{ "{{default}}" }}'
        default_branch: master
        tags: .*
        match: tag_or_branch
      properties:
        branches:
          description: 'Regular expression to match branch names. Reference: https://www.postgresql.org/docs/current/functions-matching.html#FUNCTIONS-SIMILARTO-REGEXP'
          type: string
        tags:
          description: 'Regular expression to match tag names. Reference: https://www.postgresql.org/docs/current/functions-matching.html#FUNCTIONS-SIMILARTO-REGEXP'
          type: string
        match:
          $ref: '#/components/schemas/ReleaseMatchStrategy'
        default_branch:
          description: Name of the default branch of this repository.
          type: string
      required:
      - branches
      - default_branch
      - match
      - tags
      type: object
    AccountUserChangeRequest:
      additionalProperties: false
      description: Request to change an account member's status.
      example:
        user: github|60340680
        account: 1
        status: regular
      properties:
        account:
          description: Account ID.
          type: integer
        user:
          description: Account member ID.
          type: string
        status:
          description: Account membership role.
          enum:
          - regular
          - admin
          - banished
          type: string
      required:
      - account
      - status
      - user
      type: object
    Versions:
      additionalProperties: false
      example:
        api: 0.2.10
        metadata: 14
      properties:
        api:
          type: string
        metadata:
          type: string
      required:
      - api
      - metadata
      type: object
    GetPullRequestsRequest:
      additionalProperties: false
      description: Request body of `/get/pull_requests`. Declaration of which PRs
        the user wants to analyze.
      example:
        account: 1
        prs:
        - repository: github.com/athenianco/athenian-api
          numbers:
          - 483
          - 484
          - 485
      properties:
        account:
          description: Account ID.
          type: integer
        prs:
          description: List of repositories and PR numbers to analyze.
          items:
            $ref: '#/components/schemas/PullRequestNumbers'
          type: array
      required:
      - account
      - prs
      type: object
    PullRequestNumbers:
      additionalProperties: false
      description: Repository name and a list of PR numbers in that repository.
      example:
        repository: github.com/athenianco/athenian-api
        numbers:
        - 483
        - 484
        - 485
      properties:
        repository:
          $ref: '#/components/schemas/RepositoryID'
        numbers:
          items:
            type: integer
          type: array
      required:
      - numbers
      - repository
      type: object
    FilterLabelsRequest:
      additionalProperties: false
      description: Request body of `/filter/labels`. Defines the account and the repositories
        where to look for the labels.
      example:
        account: 1
        repositories:
        - github.com/athenianco/athenian-api
        - github.com/athenianco/athenian-webapp
      properties:
        account:
          description: Account ID.
          type: integer
        repositories:
          $ref: '#/components/schemas/RepositorySet'
      required:
      - account
      type: object
    FilteredLabel:
      additionalProperties: false
      description: Details about a label and some basic stats.
      example:
        name: bug
        color: ff0000
        used_prs: 100
      properties:
        name:
          type: string
        description:
          type: string
        color:
          type: string
        used_prs:
          minimum: 0
          type: integer
      required:
      - color
      - name
      - used_prs
      type: object
    FilteredLabels:
      description: List of labels.
      example:
      - name: bug
        color: ff0000
        used_prs: 100
      - name: enhancement
        description: New project feature.
        color: 00ff00
        used_prs: 200
      items:
        $ref: '#/components/schemas/FilteredLabel'
      type: array
    JIRAFilter:
      additionalProperties: false
      description: PR filters related to JIRA traits. The aggregation between each
        filter type is *AND*.
      example:
        epics:
        - DEV-167
        - DEV-230
        labels_include:
        - api,performance
        - metadata
        labels_exclude:
        - feature
        issue_types:
        - Bug
        - Task
      properties:
        epics:
          description: PRs must be linked to at least one JIRA epic from the list.
          items:
            type: string
          type: array
        labels_include:
          description: PRs must relate to at least one JIRA issue label from the list.
            Several labels may be concatenated by a comma `,` so that all of them
            are required.
          items:
            type: string
          type: array
        labels_exclude:
          description: PRs cannot relate to JIRA issue labels from the list.
          items:
            type: string
          type: array
        issue_types:
          description: PRs must be linked to certain JIRA issue types, e.g. Bug, Task,
            Design Document, etc.
          items:
            type: string
          type: array
      type: object
    JIRAIssue:
      additionalProperties: false
      description: JIRA issue details.
      example:
        id: DEV-344
        title: Write the API specs to filter PRs by Jira epic, ticket type and label
        epic: DEV-149
        labels:
        - API
        type: task
      properties:
        id:
          description: Identifier of this issue.
          type: string
        title:
          description: Title of this issue.
          type: string
        epic:
          description: Identifier of the epic that owns this issue.
          type: string
        labels:
          description: List of JIRA labels in this issue.
          items:
            type: string
          type: array
        type:
          description: Type of this issue.
          type: string
      required:
      - id
      - title
      - type
      type: object
    ProductFeatures:
      description: Enabled client-side product features.
      example:
      - name: jira
        parameters:
          epics: true
          labels: false
      items:
        $ref: '#/components/schemas/ProductFeature'
      type: array
    ProductFeature:
      additionalProperties: false
      description: Client-side product feature definition.
      example:
        name: jira
        parameters:
          epics: true
          labels: false
      properties:
        name:
          type: string
        parameters:
          type: object
      required:
      - name
      - parameters
      type: object
    CreateTokenRequest:
      additionalProperties: false
      description: Request body of `/token/create` - creating a new Personal Access
        Token.
      example:
        account: 1
        name: Release webhook
      properties:
        account:
          description: Account ID.
          type: integer
        name:
          type: string
      required:
      - account
      - name
      type: object
    CreatedToken:
      additionalProperties: false
      description: Value and ID of the generated Personal Access Token.
      example:
        id: 1007
        token: 99129c581b6d2950233dac583629ba591319b2c6
      properties:
        id:
          description: Token identifier - can be used in `/token/{id}` DELETE.
          type: integer
        token:
          description: Secret token - not stored server-side!
          type: string
      required:
      - id
      - token
      type: object
    ListedTokens:
      items:
        $ref: '#/components/schemas/ListedToken'
      type: array
    ListedToken:
      additionalProperties: false
      description: Details about a token - without the token itself, which is not
        stored.
      example:
        last_used: 2020-06-23T04:56:07Z
        name: webhook
        id: 1008
      properties:
        id:
          description: Token identifier - can be used in `/token/{id}` DELETE.
          type: integer
        name:
          description: Name of the token (see `/token/create`).
          type: string
        last_used:
          description: When this token was used last time.
          format: date-time
          type: string
      required:
      - id
      - last_used
      - name
      type: object
    PatchTokenRequest:
      additionalProperties: false
      description: Request body of `/token/{id}` PATCH. Allows changing the token
        name.
      example:
        name: release-webhook
      properties:
        name:
          description: New name of the token.
          type: string
      type: object
    TimeZone:
      description: Local time zone offset in minutes, used to adjust `date_from` and
        `date_to`.
      maximum: 720
      minimum: -720
      type: integer
    TimeDuration:
      description: Time duration value.
      pattern: ^\d+s$
      type: string
    PullRequestHistogramsRequest:
      additionalProperties: false
      description: Request of `/histograms/prs`.
      example:
        bins: 20
        timezone: 120
        for:
        - repositories:
          - github.com/athenianco/athenian-webapp
          - github.com/athenianco/athenian-api
          with:
            author:
            - github.com/vmarkovtsev
            - github.com/dpordomingo
          labels_include:
          - bug
        scale: log
        metrics:
        - pr-lead-time
        - pr-cycle-time
        date_to: 2000-01-23
        account: 1
        date_from: 2000-01-23
        exclude_inactive: true
      properties:
        for:
          description: |-
            Sets of developers and repositories for which to calculate the histograms.
            The aggregation is `AND` between repositories and developers.
            The aggregation is `OR` inside both repositories and developers.
          items:
            $ref: '#/components/schemas/ForSet'
          type: array
        histograms:
          description: Histogram parameters for each wanted topic.
          items:
            $ref: '#/components/schemas/HistogramDefinition'
          type: array
        metrics:
          description: DEPRECATED List of desired histogram topics.
          items:
            $ref: '#/components/schemas/PullRequestMetricID'
          type: array
        scale:
          # DEPRECATED
          $ref: '#/components/schemas/HistogramScale'
        bins:
          description: DEPRECATED Number of bars in the histogram. 0 or null means
            automatic.
          minimum: 0
          type: integer
        date_from:
          description: Date from when to start measuring the distribution.
          format: date
          type: string
        date_to:
          description: Date up to which to measure the distribution.
          format: date
          type: string
        timezone:
          $ref: '#/components/schemas/TimeZone'
        exclude_inactive:
          description: Value indicating whether PRs without events in the given time
            frame shall be ignored.
          type: boolean
        quantiles:
          $ref: '#/components/schemas/Quantiles'
        account:
          description: Session account ID.
          type: integer
        fresh:
          description: Force histograms calculation on the most up to date data.
          type: boolean
      required:
      - account
      - date_from
      - date_to
      - exclude_inactive
      - for
      type: object
    HistogramDefinition:
      additionalProperties: false
      description: 'Histogram parameters: topic, bins.'
      example:
        metric: pr-size
        ticks:
        - 1
        - 10
        - 50
        - 100
        - 500
      properties:
        metric:
          $ref: '#/components/schemas/PullRequestMetricID'
        scale:
          allOf:
          - $ref: '#/components/schemas/HistogramScale'
          - description: Histogram's X axis scale.
        bins:
          description: Number of bars in the histogram. 0 or null means automatic.
          minimum: 0
          type: integer
        ticks:
          description: |-
            Alternatively to `bins` and `scale`, set the X axis bar borders manually.
            Only one of two may be specified. The ticks are automatically prepended
            the distribution minimum and appended the distribution maximum.
          items:
# {% if False %}
            allOf:
# {% else %}{{ "\n" }}            oneOf:{% endif %}
            - type: number
            - $ref: '#/components/schemas/TimeDuration'
          minItems: 1
          type: array
      required:
      - metric
      type: object
    HistogramScale:
      description: 'X axis scale: linear or logarithmic.'
      enum:
      - linear
      - log
      example: log
      type: string
    CalculatedPullRequestHistograms:
      description: Response from `/histograms/prs`.
      items:
        $ref: '#/components/schemas/CalculatedPullRequestHistogram'
      type: array
    CalculatedPullRequestHistogram:
      additionalProperties: false
      description: Calculated histogram definition.
      example:
        for:
          repositories:
          - github.com/athenianco/athenian-webapp
          - github.com/athenianco/athenian-api
        metric: pr-size
        scale: linear
        ticks:
        - 0
        - 1
        - 10
        - 50
        - 100
        - 500
        - 10000
        frequencies:
        - 0
        - 38
        - 28
        - 13
        - 12
        - 8
        interquartile:
          left: 3
          right: 76
      properties:
        for:
          $ref: '#/components/schemas/ForSet'
        metric:
          $ref: '#/components/schemas/PullRequestMetricID'
        scale:
          $ref: '#/components/schemas/HistogramScale'
        ticks:
          description: Series of horizontal bar borders aka X axis. Their count is
            `len(y) + 1` because there are `N` intervals between `(N + 1)` ticks.
          items:
# {% if False %}
            allOf:
# {% else %}{{ "\n" }}            oneOf:{% endif %}
            - type: number
            - $ref: '#/components/schemas/TimeDuration'
          type: array
        frequencies:
          description: Series of histogram bar heights aka Y axis.
          items:
            minimum: 0
            type: integer
          type: array
        interquartile:
          $ref: '#/components/schemas/Interquartile'
      required:
      - for
      - frequencies
      - interquartile
      - metric
      - scale
      - ticks
      type: object
    Interquartile:
      additionalProperties: false
      description: Middle 50% range.
      example:
        left: 3
        right: 76
      properties:
        left:
# {% if False %}
          allOf:
# {% else %}{{ "\n" }}          oneOf:{% endif %}
          - type: number
          - $ref: '#/components/schemas/TimeDuration'
        right:
# {% if False %}
          allOf:
# {% else %}{{ "\n" }}          oneOf:{% endif %}
          - type: number
          - $ref: '#/components/schemas/TimeDuration'
      required:
      - left
      - right
      type: object
    FoundJIRAStuff:
      additionalProperties: false
      description: |-
        Response from `/filter/jira`: found JIRA epics, labels, issue types, priorities,
        and mentioned users.
      example:
        epics:
        - id: DEV-158
          title: Precomputed DB - stage 2
          updated: 2020-08-03T23:47:00Z
          children:
          - DEV-157
          - DEV-156
          - DEV-533
          - DEV-536
          - DEV-538
          - DEV-539
          - DEV-620
        - id: DEV-158
          title: Precomputed DB - stage 2
          updated: 2020-08-03T23:47:00Z
          children:
          - DEV-157
          - DEV-156
          - DEV-533
          - DEV-536
          - DEV-538
          - DEV-539
          - DEV-620
        labels:
        - title: performance
          last_used: 2020-08-10T12:47:00Z
          issues_count: 300
          kind: regular
        - title: performance
          last_used: 2020-08-10T12:47:00Z
          issues_count: 300
          kind: regular
        issue_types:
        - Story
        - Task
        priorities:
        - Lowest
        - Low
        - Medium
        - High
        - Critical
        users:
        - athenianco.atlassian.net/Vadim Markovtsev
        - athenianco.atlassian.net/Lou Marvin Caraig
      properties:
        epics:
          items:
            $ref: '#/components/schemas/JIRAEpic'
          type: array
        labels:
          items:
            $ref: '#/components/schemas/JIRALabel'
          type: array
        issue_types:
          description: Types of the updated issues.
          items:
            type: string
          type: array
        priorities:
          description: Issue priority names sorted by importance in ascending order.
          items:
            type: string
          type: array
        users:
          description: Mentioned users in the found JIRA issues.
          items:
            $ref: '#/components/schemas/DeveloperID'
          type: array
      required:
      - epics
      - issue_types
      - labels
      - priorities
      - users
      type: object
    JIRAEpic:
      additionalProperties: false
      description: Details about a JIRA epic - a "big" issue with sub-issues.
      example:
        id: DEV-158
        title: Precomputed DB - stage 2
        updated: 2020-08-03T23:47:00Z
        children:
        - DEV-157
        - DEV-156
        - DEV-533
        - DEV-536
        - DEV-538
        - DEV-539
        - DEV-620
      properties:
        id:
          type: string
        title:
          type: string
        updated:
          description: When this epic was last updated.
          format: date-time
          type: string
        children:
          description: IDs of the owned sub-issues.
          items:
            type: string
          type: array
      required:
      - children
      - id
      - title
      - updated
      type: object
    JIRALabel:
      additionalProperties: false
      description: Details about a JIRA label.
      example:
        title: performance
        last_used: 2020-08-10T12:47:00Z
        issues_count: 300
        kind: Label
      properties:
        title:
          type: string
        last_used:
          description: When this label was last assigned to an issue.
          format: date-time
          type: string
        issues_count:
          description: In how many issues (in the specified time interval) this label
            was used.
          type: integer
        kind:
          description: Label kind - "Label", "Component", etc.
          type: string
      required:
      - issues_count
      - last_used
      - title
      type: object
    FilterJIRAStuff:
      additionalProperties: false
      description: Request of `/filter/jira` to retrieve epics and labels.
      example:
        account: 1
        date_from: 2020-01-01
        date_to: 2020-12-01
        timezone: 120
      properties:
        account:
          type: integer
        date_from:
          format: date
          type: string
        date_to:
          format: date
          type: string
        timezone:
          $ref: '#/components/schemas/TimeZone'
      required:
      - account
      - date_from
      - date_to
      type: object
    ReleaseMetricsRequest:
      additionalProperties: false
      description: Request of `/metrics/releases` to calculate metrics on releases.
      example:
        for:
        - - athenianco/athenian-api
          - athenianco/athenian-webapp
        with:
          pr_author:
          - github.com/se7entyse7en
          releaser:
          - github.com/gkwillie
        metrics:
        - release-count
        granularities:
        - day
        date_from: 2020-01-01T00:00:00Z
        date_to: 2020-10-01T00:00:00Z
        account: 1
      properties:
        for:
          description: List of repository groups for which to calculate the metrics.
          items:
            $ref: '#/components/schemas/RepositorySet'
          type: array
        with:
          $ref: '#/components/schemas/ReleaseWith'
        metrics:
          description: List of desired release metrics.
          items:
            $ref: '#/components/schemas/ReleaseMetricID'
          type: array
        date_from:
          description: Date from when to start measuring the metrics.
          format: date
          type: string
        date_to:
          description: Date up to which to measure the metrics.
          format: date
          type: string
        timezone:
          $ref: '#/components/schemas/TimeZone'
        granularities:
          items:
            $ref: '#/components/schemas/Granularity'
          type: array
        quantiles:
          $ref: '#/components/schemas/Quantiles'
        account:
          description: Session account ID.
          type: integer
      required:
      - account
      - date_from
      - date_to
      - for
      - granularities
      - metrics
      type: object
    ReleaseMetricID:
      description: |-
        Currently supported release metric types.
        * `release-count` - number of all releases in the time interval.
        * `release-tag-count` - number of releases by tag in the time interval.
        * `release-branch-count` - number of releases by branch merge in the time interval.
        * `release-prs` - number of PRs released in the time interval.
        * `release-tag-prs` - number of PRs released by tag in the time interval.
        * `release-branch-prs` - number of PRs released by branch merge in the time interval.
        * `release-commits` - number of commits which were released in the time interval.
        * `release-tag-commits` - number of commits which were released by tag in the time interval.
        * `release-branch-commits` - number of commits which were released by branch merge in the time interval.
        * `release-lines` - sum of the changed (added or removed) diff lines of the commits released in the time interval.
        * `release-tag-lines` - sum of the changed (added or removed) diff lines of the commits released by tag in the time interval.
        * `release-branch-lines` - sum of the changed (added or removed) diff lines of the commits released by branch merge in the time interval.
        * `release-avg-prs` - average (by release) number of PRs released in the time interval. Quantiles are applied.
        * `release-tag-avg-prs` - average (by release) number of PRs released by tag in the time interval. Quantiles are applied.
        * `release-branch-avg-prs` - average number of PRs released by branch merge in the time interval. Quantiles are applied.
        * `release-avg-commits` - average (by release) number of commits released in the time interval. Quantiles are applied.
        * `release-tag-avg-commits` - average (by release) number of commits released by tag in the time interval. Quantiles are applied.
        * `release-branch-avg-commits` - average (by release) number of commits released by branch merge in the time interval. Quantiles are applied.
        * `release-avg-lines` - average (by release) number of changed (added + removed) diff lines of the commits released in the time interval. Quantiles are applied.
        * `release-tag-avg-lines` - average (by release) number of changed (added + removed) diff lines of the commits released by tag in the time interval. Quantiles are applied.
        * `release-branch-avg-lines` - average (by release) number of changed (added + removed) diff lines of the commits released by branch merge in the time interval. Quantiles are applied.
        * `release-age` - average timedelta between releases of the same alignment (as determined by the commit DAG). Quantiles are applied.
        * `release-tag-age` - average timedelta between releases by tag of the same alignment (as determined by the commit DAG). Quantiles are applied.
        * `release-branch-age` - average timedelta between releases by branch of the same alignment (as determined by the commit DAG). Quantiles are applied.
      enum:
      - release-count
      - release-tag-count
      - release-branch-count
      - release-prs
      - release-tag-prs
      - release-branch-prs
      - release-commits
      - release-tag-commits
      - release-branch-commits
      - release-lines
      - release-tag-lines
      - release-branch-lines
      - release-avg-prs
      - release-tag-avg-prs
      - release-branch-avg-prs
      - release-avg-commits
      - release-tag-avg-commits
      - release-branch-avg-commits
      - release-avg-lines
      - release-tag-avg-lines
      - release-branch-avg-lines
      - release-age
      - release-tag-age
      - release-branch-age
      type: string
    CalculatedReleaseMetrics:
      description: Response from `/metrics/releases`.
      items:
        $ref: '#/components/schemas/CalculatedReleaseMetric'
      type: array
    CalculatedReleaseMetric:
      additionalProperties: false
      description: Calculated release metric values.
      example:
        for:
        - athenianco/athenian-api
        - athenianco/athenian-webapp
        metrics:
        - release-count
        granularity: day
        values:
          date: 2020-01-23
          values:
          - 0.8008282
          - 0.8008282
          confidence_mins:
          - 0.5
          - 0.5
          confidence_maxs:
          - 1.0
          - 1.0
          confidence_scores:
          - 75
          - 75
      properties:
        for:
          $ref: '#/components/schemas/RepositorySet'
        matches:
          additionalProperties:
            $ref: '#/components/schemas/ReleaseMatchStrategy'
          description: Applied release matching strategies for the repositories in
            `for`.
          type: object
        metrics:
          items:
            $ref: '#/components/schemas/ReleaseMetricID'
          type: array
        granularity:
          $ref: '#/components/schemas/Granularity'
        values:
          items:
            $ref: '#/components/schemas/CalculatedLinearMetricValues'
          type: array
      required:
      - for
      - granularity
      - matches
      - metrics
      - values
      type: object
    PaginatePullRequestsRequest:
      additionalProperties: false
      description: |-
        Request of `/paginate/pull_requests`. According to the target batch size,
        compute the optimal PR updated timestamp ranges. `request` should match
        the body to be sent to `/filter/pull_requests`. `updated_from` and `updated_to`
        inside `request` are ignored.
      example:
        request:
          account: 1
          date_from: 2020-01-23
          date_to: 2020-05-23
          in:
          - '{1}'
          properties:
          - wip
          with:
            author:
            - github.com/vmarkovtsev
        batch: 100
      properties:
        batch:
          description: Target batch size. The returned ranges do not guarantee the
            exact match.
          minimum: 1
          type: integer
        request:
          $ref: '#/components/schemas/FilterPullRequestsRequest'
      required:
      - batch
      - request
      type: object
    PullRequestPaginationPlan:
      additionalProperties: false
      description: Response of `/paginate/pull_requests`. Computed split of the PR
        updated timestamp range.
      example:
        updated:
        - 2020-10-01
        - 2020-10-07
        - 2020-10-08
      properties:
        updated:
          items:
            format: date
            type: string
          type: array
      type: object
    RepositoryGroups:
      description: Lists of indexes in `repositories` that define independent groups
        that must be processed individually. The groups may have intersections.
      example:
      - 0
      - 1
      items:
        items:
          minItems: 1
          minimum: 0
          type: integer
        type: array
      minItems: 1
      type: array
    ReleaseWith:
      additionalProperties: false
      description: Release contribution roles. The aggregation is `OR` everywhere.
      example:
        pr_author:
        - github.com/se7entyse7en
        releaser:
        - github.com/gkwillie
      properties:
        pr_author:
          allOf:
          - $ref: '#/components/schemas/DeveloperSet'
          - description: Authors of released pull requests.
        commit_author:
          allOf:
          - $ref: '#/components/schemas/DeveloperSet'
          - description: Authors of released commits.
        releaser:
          allOf:
          - $ref: '#/components/schemas/DeveloperSet'
          - description: Release publishers.
      type: object
    JIRAMetricID:
      description: |-
        Currently supported JIRA activity metrics.
        * `jira-bug-open` - number of bug-like issues active by the end of the time interval.
        * `jira-bug-resolved` - number of bug-like issues closed in the given time range.
        * `jira-bug-raised` - number of bug-like issues reported in the given time range.
      enum:
      - jira-bug-open
      - jira-bug-resolved
      - jira-bug-raised
      example: jira-bug-resolved
      type: string
    JIRAMetricsRequest:
      additionalProperties: false
      description: Request body of `/metrics/jira`.
      example:
        account: 1
        date_from: 2020-10-01
        date_to: 2020-10-30
        priorities:
        - High
        metrics:
        - jira-bug-open
        - jira-bug-resolved
        - jira-bug-raised
        granularities:
        - all
      properties:
        account:
          description: Session account ID.
          type: integer
        date_from:
          description: Issues must be resolved after this date.
          format: date
          type: string
        date_to:
          description: Issues must be created before this date.
          format: date
          type: string
        timezone:
          $ref: '#/components/schemas/TimeZone'
        priorities:
          description: Selected issue priorities.
          items:
            type: string
          type: array
        assignees:
          description: Selected issue assignee users.
          items:
            $ref: '#/components/schemas/DeveloperID'
          type: array
        reporters:
          description: Selected issue reporter users.
          items:
            $ref: '#/components/schemas/DeveloperID'
          type: array
        commenters:
          description: Selected issue commenter users.
          items:
            $ref: '#/components/schemas/DeveloperID'
          type: array
        stakeholders:
          description: Selected issue stakeholder users.
          items:
            $ref: '#/components/schemas/DeveloperID'
          type: array
        metrics:
          description: List of measured metrics.
          items:
            $ref: '#/components/schemas/JIRAMetricID'
          type: array
        quantiles:
          $ref: '#/components/schemas/Quantiles'
        granularities:
          description: Splits of the specified time range `[date_from, date_to)`.
          items:
            $ref: '#/components/schemas/Granularity'
          type: array
      required:
      - account
      - date_from
      - date_to
      - granularities
      - metrics
      type: object
    CalculatedJIRAMetrics:
      description: Response from `/metrics/jira`.
      items:
        $ref: '#/components/schemas/CalculatedJIRAMetricValues'
      type: array
    CalculatedJIRAMetricValues:
      additionalProperties: false
      description: Calculated JIRA metrics for a specific granularity.
      properties:
        granularity:
          $ref: '#/components/schemas/Granularity'
        values:
          items:
            $ref: '#/components/schemas/CalculatedLinearMetricValues'
          type: array
      required:
      - granularity
      - values
      type: object