generator/openapi.yaml in athenian-2.1.81 vs generator/openapi.yaml in athenian-2.1.85
- old
+ new
@@ -20,11 +20,11 @@
* __504__ endpoint took too much time and was interrupted. We reported the incident to Sentry and will see how to improve the performance. Repeating the request will not help, most probably.
</details>
license:
name: CC-BY-4.0
title: '{{ title }}'
- version: 2.1.81
+ version: 2.1.85
servers:
- description: '{{ server_description }} - {{ server_url }}'
url: '{{ server_url }}/v1'
# yamllint disable-line rule:key-ordering
paths:
@@ -4153,20 +4153,24 @@
additionalProperties: false
description: Status of the user's account membership.
example:
is_admin: true
expired: false
+ stale: false
has_jira: true
has_ci: true
has_deployments: true
properties:
is_admin:
description: Indicates whether the user is an account administrator.
type: boolean
expired:
description: Indicates whether the account is disabled.
type: boolean
+ stale:
+ description: Indicates whether the account is temporarily not receiving data updates.
+ type: boolean
has_jira:
description: Indicates whether the account installed the integration with
JIRA.
type: boolean
has_ci:
@@ -4180,10 +4184,11 @@
- expired
- has_ci
- has_deployments
- has_jira
- is_admin
+ - stale
type: object
# yamllint disable-line rule:key-ordering
InvitedUser:
additionalProperties: false
description: Details about the user who has accepted an invitation.
@@ -6848,10 +6853,11 @@
example:
issues:
- comments: 0
created: '2023-02-21T09:25:30Z'
id: P1-2
+ acknowledge_time: 132200s
life_time: 259200s
priority: HIGH
project: '1'
prs:
- comments: 0
@@ -7535,10 +7541,11 @@
comments: 1
prs: 0
priority: Low
status: Backlog
type: Epic
+ acknowledge_time: '132200s'
life_time: '59172893s'
url: https://example.com/?my-jira#DEV-158
project: '10012'
story_points: 5
children:
@@ -7552,10 +7559,11 @@
priority: Low
status: Released
prs: 0
type: Task
url: https://example.com/?my-jira#DEV-157
+ acknowledge_time: '132200s'
life_time: '59172892s'
subtasks: 42
- id: DEV-156
title: Design the architecture of the precomputing service
created: 2020-05-21T18:27:00Z
@@ -7566,10 +7574,11 @@
priority: Low
status: Released
prs: 0
type: Task
url: https://example.com/?my-jira#DEV-156
+ acknowledge_time: '132200s'
life_time: '59172891s'
subtasks: 3
story_points: 5
issues: []
labels:
@@ -7712,10 +7721,11 @@
comments: 1
prs: 0
priority: Low
status: Backlog
type: Epic
+ acknowledge_time: 132200s
life_time: 10000s
url: https://example.com/?my-jira#DEV-158
project: '1002'
children:
- id: DEV-157
@@ -7728,10 +7738,11 @@
priority: Low
status: Released
prs: 0
type: Task
url: https://example.com/?my-jira#DEV-157
+ acknowledge_time: 132200s
life_time: 10000s
subtasks: 0
- id: DEV-156
title: Design the architecture of the precomputing service
created: 2020-05-21T18:27:00Z
@@ -7742,10 +7753,11 @@
priority: Low
status: Released
prs: 0
type: Task
url: https://example.com/?my-jira#DEV-156
+ acknowledge_time: 132200s
life_time: 20000s
subtasks: 2
type: object
# yamllint disable-line rule:key-ordering
JIRAEpicChild:
@@ -7772,10 +7784,11 @@
comments: 10
priority: Low
status: Released
prs: 0
type: Task
+ acknowledge_time: 132200s
life_time: 10000s
url: https://example.com/?my-jira#DEV-157
subtasks: 2
type: object
# yamllint disable-line rule:key-ordering
@@ -7821,10 +7834,16 @@
description: |-
When the issue finished: the stage is "Done" and all PRs are either released or rejected.
This timestamp can be missing and is always greater than or equal to `work_began`.
format: date-time
type: string
+ acknowledge_time:
+ allOf:
+ - description: |-
+ Issue's time spent between `work_began` and `created`. If work on issue has not
+ begun, time between `now()` and `created. See also `jira-acknowledge-time` metric.
+ - $ref: '#/components/schemas/TimeDuration'
lead_time:
allOf:
- description: |-
Issue's time spent between `work_began` and `resolved`. If not resolved,
between `work_began` and `now()`.
@@ -7871,10 +7890,11 @@
type: string
required:
- comments
- created
- id
+ - acknowledge_time
- life_time
- priority
- reporter
- status
- title
@@ -8430,10 +8450,11 @@
* `jira-life-time` - Mean Life Time - the time between min(issue creation, work began) and max(issue resolution, fixes released).
* `jira-life-time-below-threshold-ratio` - ratio of issues with a `jira-life-time` below the threshold, disregarding the quantiles. The default threshold is 5 days.
* `jira-lead-time` - Mean Lead Time - the time between when the work began and max(issue resolution, fixes released).
* `jira-lead-time-below-threshold-ratio` - ratio of issues with a `jira-lead-time` below the threshold, disregarding the quantiles. The default threshold is 5 days.
* `jira-acknowledge-time` - Mean Acknowledge Time - the time between when the issue was created and the work began = `min(transitioned to "In Progress", PR created)`. It equals to 0 for retrofitted issues with PRs before their creation times.
+ * `jira-acknowledge-time-below-threshold-ratio` - ratio of issues with a `jira-acknowledge-time` below the threshold, disregarding the quantiles. The default threshold is 3 days.
* `jira-pr-lag-time` - the time between when the issue transitioned to "In Progress" and the first PR was created. It equals to 0 if the difference is negative or no PRs are mapped to the issue.
* `jira-backlog-time` - the time between when the issue was created and transitioned to "In Progress".
* `jira-resolution-rate` - ratio between the number of resolved issues to the number of raised issues.
enum:
- jira-open
@@ -8444,10 +8465,11 @@
- jira-life-time
- jira-life-time-below-threshold-ratio
- jira-lead-time
- jira-lead-time-below-threshold-ratio
- jira-acknowledge-time
+ - jira-acknowledge-time-below-threshold-ratio
- jira-pr-lag-time
- jira-backlog-time
- jira-resolution-rate
example: jira-resolved
type: string
@@ -10775,10 +10797,12 @@
* `dep-duration-successful` - average successful deployment procedure time - the difference between `date_finished` and `date_started` of `DeploymentNotification` with `conclusion = 'SUCCESS'`.
* `dep-duration-failed` - average failed deployment procedure time - the difference between `date_finished` and `date_started` of `DeploymentNotification` with `conclusion = 'FAILURE'`.
* `dep-success-count` - number of successful deployments in the time period.
* `dep-failure-count` - number of failed deployments in the time period.
* `dep-success-ratio` - ratio between successful and all deployments.
+ * `dep-change-failure-count` - number of successful deployments introducing a failure in the system. This pertains deployments effects so is different from `dep-failure-count` which is about deployments execution. A deployment can be marked as introducing a failure by associating it with the `failure` label, with any value.
+ * `dep-change-failure-ratio` - ratio between `dep-change-failure-count` and `dep-success-count`.
* `dep-size-prs` - average number of deployed pull requests.
* `dep-size-releases` - average number of deployed releases.
* `dep-size-lines` - average number of deployed lines of code (changed = insertions + removals).
* `dep-size-commits` - average number of deployed commits.
* `dep-prs-count` - number of pull requests deployed in the time period.
@@ -10793,9 +10817,11 @@
- dep-duration-successful
- dep-duration-failed
- dep-success-count
- dep-failure-count
- dep-success-ratio
+ - dep-change-failure-count
+ - dep-change-failure-ratio
- dep-size-prs
- dep-size-releases
- dep-size-lines
- dep-size-commits
- dep-prs-count