From 373ba50ead2496437c2c50223dca8119e787ae74 Mon Sep 17 00:00:00 2001 From: Andrew Brain <61482022+ABrain7710@users.noreply.github.com> Date: Thu, 19 Aug 2021 11:47:56 -0500 Subject: [PATCH 01/17] Initial fixes to api docs Signed-off-by: Andrew Brain <61482022+ABrain7710@users.noreply.github.com> --- augur/routes/util.py | 4 +-- docs/source/rest-api/spec.yml | 56 +++++++++++++++++------------------ 2 files changed, 30 insertions(+), 30 deletions(-) diff --git a/augur/routes/util.py b/augur/routes/util.py index 69a733193d..54ecb6cbd4 100644 --- a/augur/routes/util.py +++ b/augur/routes/util.py @@ -94,7 +94,7 @@ def get_repos_in_repo_group(repo_group_id): status=200, mimetype="application/json") - @server.app.route('/{}/owner//name/'.format(server.api_version)) + @server.app.route('/{}/owner//repo/'.format(server.api_version)) def get_repo_by_git_name(owner, repo): get_repo_by_git_name_sql = s.sql.text(""" @@ -191,7 +191,7 @@ def get_issues(repo_group_id, repo_id=None): repo_name FROM issues JOIN repo ON issues.repo_id = repo.repo_id, issue_events WHERE issues.repo_id = :repo_id - AND issues.pull_request IS NULL + AND issues.pull_request IS NULL AND issues.issue_id = issue_events.issue_id GROUP BY issues.issue_id, repo_name ORDER by OPEN_DAY DESC diff --git a/docs/source/rest-api/spec.yml b/docs/source/rest-api/spec.yml index 2778e9ea78..5100fcc91f 100644 --- a/docs/source/rest-api/spec.yml +++ b/docs/source/rest-api/spec.yml @@ -12,7 +12,7 @@ paths: /owner/:owner/repo/:repo: get: description: Get the repo_group_id and repo_id of a particular repo. - operationId: Get Repo + operationId: Get Repo by Owner and Repo responses: '200': description: OK @@ -31,7 +31,7 @@ paths: /repo-groups: get: description: Get all the downloaded repo groups. - operationId: Repo Groups + operationId: Get All Repo Groups responses: '200': description: OK @@ -80,7 +80,7 @@ paths: externalDocs: description: CHAOSS Metric Definition url: https://github.com/chaoss/wg-risk/blob/master/metrics/Committers.md - operationId: (Repo Group) + operationId: Committers (Repo Group) parameters: - description: Repository Group ID in: path @@ -124,7 +124,7 @@ paths: type: array tags: - risk - /repo-groups/:repo_group_id/abandoned_issues: + /repo-groups/:repo_group_id/abandoned-issues: get: description: List of abandoned issues (last updated >= 1 year ago) operationId: Abandoned Issues (Repo) @@ -215,7 +215,7 @@ paths: get: description: 'This is an Augur-specific metric. We are currently working to define these more formally. ' - operationId: Annual Commit Count Ranked by New Repo in Repo Group(Repo) + operationId: Annual Commit Count Ranked by New Repo in Repo Group (Repo) parameters: - description: Repository Group ID. in: path @@ -275,7 +275,7 @@ paths: get: description: 'This is an Augur-specific metric. We are currently working to define these more formally. ' - operationId: Annual Commit Count Ranked by Repo in Repo Group(Repo) + operationId: Annual Commit Count Ranked by Repo in Repo Group (Repo) parameters: - description: Base64 version of the URL of the GitHub repository as it appears in the Facade DB @@ -309,7 +309,7 @@ paths: get: description: 'This is an Augur-specific metric. We are currently working to define these more formally. ' - operationId: Annual Lines of Code Ranked by New Repo in Repo Group(Repo) + operationId: Annual Lines of Code Ranked by New Repo in Repo Group (Repo) parameters: - description: Base64 version of the URL of the GitHub repository as it appears in the Facade DB @@ -343,7 +343,7 @@ paths: get: description: 'This is an Augur-specific metric. We are currently working to define these more formally. ' - operationId: Annual Lines of Code Ranked by Repo in Repo Group(Repo) + operationId: Annual Lines of Code Ranked by Repo in Repo Group (Repo) parameters: - description: Base64 version of the URL of the GitHub repository as it appears in the Facade DB @@ -373,7 +373,7 @@ paths: type: array tags: - experimental - /repo-groups/:repo_group_id/avgerage-issue-resolution-time: + /repo-groups/:repo_group_id/average-issue-resolution-time: get: description: 'The average issue resolution time. ' externalDocs: @@ -1465,7 +1465,7 @@ paths: externalDocs: description: CHAOSS Metric Definition url: https://github.com/chaoss/wg-risk/blob/master/metrics/License_Coverage.md - operationId: License Coverage(Repo Group) + operationId: License Coverage (Repo Group) parameters: - description: Repository Group ID in: path @@ -1500,7 +1500,7 @@ paths: externalDocs: description: CHAOSS Metric Definition url: https://github.com/chaoss/wg-risk/blob/master/metrics/License_Coverage.md - operationId: License Declared(Repo Group) + operationId: License Declared (Repo Group) parameters: - description: Repository Group ID in: path @@ -1532,7 +1532,7 @@ paths: externalDocs: description: CHAOSS Metric Definition url: https://github.com/chaoss/wg-evolution/blob/master/metrics/contributors-new.md - operationId: Lines Changed by Author(Repo) + operationId: Lines Changed by Author (Repo) parameters: - description: Repository Group ID in: path @@ -1652,10 +1652,10 @@ paths: type: array tags: - experimental - /repo-groups/:repo_group_id/pull-request-closed-no-merge: + /repo-groups/:repo_group_id/pull-requests-closed-no-merge: get: description: Timeseries of pull request which were closed but not merged - operationId: Pull Request Closed but not merged(Repo) + operationId: Pull Request Closed but Not Merged (Repo) parameters: - description: Repository Group ID. in: path @@ -1747,7 +1747,7 @@ paths: /repo-groups/:repo_group_id/repos: get: description: Get all the repos in a repo group. - operationId: Repos in Repo Group + operationId: Get Repos in Repo Group responses: '200': description: OK @@ -2202,7 +2202,7 @@ paths: /repos: get: description: Get all the downloaded repos. - operationId: Repos + operationId: Get All Repos responses: '200': description: OK @@ -2521,7 +2521,7 @@ paths: externalDocs: description: CHAOSS Metric Definition url: https://github.com/chaoss/wg-risk/blob/master/metrics/Committers.md - operationId: Committers(Repo) + operationId: Committers (Repo) parameters: - description: Repository Group ID. in: path @@ -3420,7 +3420,7 @@ paths: externalDocs: description: CHAOSS Metric Definition url: https://github.com/chaoss/wg-risk/blob/master/metrics/License_Coverage.md - operationId: License Coverage(Repo) + operationId: License Coverage (Repo) parameters: - description: Repository Group ID. in: path @@ -3462,7 +3462,7 @@ paths: externalDocs: description: CHAOSS Metric Definition url: https://github.com/chaoss/wg-risk/blob/master/metrics/License_Coverage.md - operationId: License Declared(Repo) + operationId: License Declared (Repo) parameters: - description: Repository Group ID. in: path @@ -3540,10 +3540,10 @@ paths: type: array tags: - experimental - /repos/:repo_id/pull-request-closed-no-merge: + /repos/:repo_id/pull-requests-closed-no-merge: get: description: '' - operationId: Pull Request Closed but not merged(Repo) + operationId: Pull Request Closed but Not Merged (Repo) parameters: - description: Repository ID. in: path @@ -3683,7 +3683,7 @@ paths: externalDocs: description: CHAOSS Metric Definition url: https://github.com/chaoss/wg-evolution/blob/master/metrics/Reviews_Duration.md - operationId: review Duration (Repo) + operationId: Review Duration (Repo) parameters: - description: Repository Group ID. in: path @@ -4105,7 +4105,7 @@ paths: /repos/:repo_id/watchers-count: get: description: Watchers count. - operationId: watchers Count (Repo) + operationId: Watchers Count (Repo) parameters: - description: Repository Group ID. in: path @@ -4137,7 +4137,7 @@ paths: /rg-name/:rg_name/repo-name/:repo_name: get: description: Get the repo_group_id and repo_id of a particular repo. - operationId: Get Repo + operationId: Get Repo by Repo Group Name and Repo Name responses: '200': description: OK @@ -4156,10 +4156,10 @@ paths: type: array tags: - utility - /rg-names/:rg_name: + /rg-name/:rg_name: get: description: Get the repo_id of a particular repo group. - operationId: Get Repo + operationId: Get Repo by Repo Name responses: '200': description: OK @@ -4175,10 +4175,10 @@ paths: type: array tags: - utility - /top-insights: + /repo-groups/:repo_group_id/top-insights: get: description: Get all the downloaded repo groups. - operationId: Top Insights + operationId: Get Top Insights responses: '200': description: OK From 7dd7e950447e977b2b1e300d4fb404c158fafa66 Mon Sep 17 00:00:00 2001 From: Andrew Brain <61482022+ABrain7710@users.noreply.github.com> Date: Thu, 19 Aug 2021 12:13:09 -0500 Subject: [PATCH 02/17] Reoganize utility endpoint docs Signed-off-by: Andrew Brain <61482022+ABrain7710@users.noreply.github.com> --- docs/source/rest-api/spec.yml | 326 +++++++++++++++++----------------- 1 file changed, 163 insertions(+), 163 deletions(-) diff --git a/docs/source/rest-api/spec.yml b/docs/source/rest-api/spec.yml index 5100fcc91f..66b4ac1430 100644 --- a/docs/source/rest-api/spec.yml +++ b/docs/source/rest-api/spec.yml @@ -9,6 +9,92 @@ info: version: 0.12.0 openapi: 3.0.0 paths: + /repo-groups: + get: + description: Get all the downloaded repo groups. + operationId: Get All Repo Groups + responses: + '200': + description: OK + schema: + items: + properties: + data_collection_date: + description: 'Example: 2019-06-05T13:36:25.000Z' + type: string + data_source: + description: 'Example: git' + type: string + repo_group_id: + description: 'Example: 20' + type: integer + rg_description: + description: 'Example: Rails Ecosystem.' + type: string + rg_last_modified: + description: 'Example: 2019-06-03T15:55:20.000Z' + type: string + rg_name: + description: 'Example: Rails' + type: string + rg_recache: + description: 'Example: 0' + type: integer + rg_type: + description: 'Example: GitHub Organization' + type: string + rg_website: + description: 'Example: ' + type: string + tool_source: + description: 'Example: load' + type: string + tool_version: + description: 'Example: one' + type: string + type: array + tags: + - utility + /repos: + get: + description: Get all the downloaded repos. + operationId: Get All Repos + responses: + '200': + description: OK + schema: + items: + properties: + base64_url: + description: 'Example: Z2l0aHViLmNvbS9hcGFjaGUvaW5jdWJhdG9yLWFyZ3VzLmdpdA==' + type: string + commits_all_time: + description: 'Example: None' + type: string + description: + description: 'Example: None' + type: string + issues_all_time: + description: 'Example: None' + type: string + repo_id: + description: 'Example: 21996' + type: integer + repo_name: + description: 'Example: incubator-argus' + type: string + repo_status: + description: 'Example: Update' + type: string + rg_name: + description: 'Example: Apache' + type: string + url: + description: 'Example: github.com/apache/incubator-argus.git' + type: string + type: array + tags: + - utility /owner/:owner/repo/:repo: get: description: Get the repo_group_id and repo_id of a particular repo. @@ -28,10 +114,85 @@ paths: type: array tags: - utility - /repo-groups: + /rg-name/:rg_name/repo-name/:repo_name: + get: + description: Get the repo_group_id and repo_id of a particular repo. + operationId: Get Repo by Repo Group Name and Repo Name + responses: + '200': + description: OK + schema: + items: + properties: + repo_git: + description: 'Example: https://github.com/rails/rails.git' + type: string + repo_group_id: + description: 'Example: 20' + type: integer + repo_id: + description: 'Example: 21000' + type: integer + type: array + tags: + - utility + /rg-name/:rg_name: + get: + description: Get the repo_id of a particular repo group. + operationId: Get Repo by Repo Name + responses: + '200': + description: OK + schema: + items: + properties: + repo_group_id: + description: 'Example: 20' + type: integer + rg_name: + description: 'Example: Rails' + type: string + type: array + tags: + - utility + /repo-groups/:repo_group_id/repos: + get: + description: Get all the repos in a repo group. + operationId: Get Repos in Repo Group + responses: + '200': + description: OK + schema: + items: + properties: + commits_all_time: + description: 'Example: 6874' + type: integer + description: + description: 'Example: None' + type: string + issues_all_time: + description: 'Example: 81' + type: integer + repo_id: + description: 'Example: 21326' + type: integer + repo_name: + description: 'Example: graphql-js' + type: string + repo_status: + description: 'Example: Complete' + type: string + url: + description: 'Example: https://github.com/graphql/graphql-js.git' + type: string + type: array + tags: + - utility + /repo-groups/:repo_group_id/top-insights: get: description: Get all the downloaded repo groups. - operationId: Get All Repo Groups + operationId: Get Top Insights responses: '200': description: OK @@ -1744,40 +1905,6 @@ paths: type: array tags: - evolution - /repo-groups/:repo_group_id/repos: - get: - description: Get all the repos in a repo group. - operationId: Get Repos in Repo Group - responses: - '200': - description: OK - schema: - items: - properties: - commits_all_time: - description: 'Example: 6874' - type: integer - description: - description: 'Example: None' - type: string - issues_all_time: - description: 'Example: 81' - type: integer - repo_id: - description: 'Example: 21326' - type: integer - repo_name: - description: 'Example: graphql-js' - type: string - repo_status: - description: 'Example: Complete' - type: string - url: - description: 'Example: https://github.com/graphql/graphql-js.git' - type: string - type: array - tags: - - utility /repo-groups/:repo_group_id/review-duration: get: description: 'Time since an review/pull request is proposed until it is accepted. ' @@ -2199,46 +2326,6 @@ paths: type: array tags: - value - /repos: - get: - description: Get all the downloaded repos. - operationId: Get All Repos - responses: - '200': - description: OK - schema: - items: - properties: - base64_url: - description: 'Example: Z2l0aHViLmNvbS9hcGFjaGUvaW5jdWJhdG9yLWFyZ3VzLmdpdA==' - type: string - commits_all_time: - description: 'Example: None' - type: string - description: - description: 'Example: None' - type: string - issues_all_time: - description: 'Example: None' - type: string - repo_id: - description: 'Example: 21996' - type: integer - repo_name: - description: 'Example: incubator-argus' - type: string - repo_status: - description: 'Example: Update' - type: string - rg_name: - description: 'Example: Apache' - type: string - url: - description: 'Example: github.com/apache/incubator-argus.git' - type: string - type: array - tags: - - utility /repos/:repo_id/aggregate-summary: get: description: Returns the current count of watchers, stars, and forks and the @@ -4134,93 +4221,6 @@ paths: type: array tags: - value - /rg-name/:rg_name/repo-name/:repo_name: - get: - description: Get the repo_group_id and repo_id of a particular repo. - operationId: Get Repo by Repo Group Name and Repo Name - responses: - '200': - description: OK - schema: - items: - properties: - repo_git: - description: 'Example: https://github.com/rails/rails.git' - type: string - repo_group_id: - description: 'Example: 20' - type: integer - repo_id: - description: 'Example: 21000' - type: integer - type: array - tags: - - utility - /rg-name/:rg_name: - get: - description: Get the repo_id of a particular repo group. - operationId: Get Repo by Repo Name - responses: - '200': - description: OK - schema: - items: - properties: - repo_group_id: - description: 'Example: 20' - type: integer - rg_name: - description: 'Example: Rails' - type: string - type: array - tags: - - utility - /repo-groups/:repo_group_id/top-insights: - get: - description: Get all the downloaded repo groups. - operationId: Get Top Insights - responses: - '200': - description: OK - schema: - items: - properties: - data_collection_date: - description: 'Example: 2019-06-05T13:36:25.000Z' - type: string - data_source: - description: 'Example: git' - type: string - repo_group_id: - description: 'Example: 20' - type: integer - rg_description: - description: 'Example: Rails Ecosystem.' - type: string - rg_last_modified: - description: 'Example: 2019-06-03T15:55:20.000Z' - type: string - rg_name: - description: 'Example: Rails' - type: string - rg_recache: - description: 'Example: 0' - type: integer - rg_type: - description: 'Example: GitHub Organization' - type: string - rg_website: - description: 'Example: ' - type: string - tool_source: - description: 'Example: load' - type: string - tool_version: - description: 'Example: one' - type: string - type: array - tags: - - utility /contributor_reports/new_contributors_bar/: get: description: Get bar chart of new contributor counts. From c409f4259a29924991e7c525a97c622b30f8c3b8 Mon Sep 17 00:00:00 2001 From: Andrew Brain <61482022+ABrain7710@users.noreply.github.com> Date: Thu, 19 Aug 2021 12:24:56 -0500 Subject: [PATCH 03/17] Organize risk endpoint docs Signed-off-by: Andrew Brain <61482022+ABrain7710@users.noreply.github.com> --- docs/source/rest-api/spec.yml | 1202 ++++++++++++++++----------------- 1 file changed, 601 insertions(+), 601 deletions(-) diff --git a/docs/source/rest-api/spec.yml b/docs/source/rest-api/spec.yml index 66b4ac1430..7fa366d816 100644 --- a/docs/source/rest-api/spec.yml +++ b/docs/source/rest-api/spec.yml @@ -285,6 +285,550 @@ paths: type: array tags: - risk + /repo-groups/:repo_group_id/average-issue-resolution-time: + get: + description: 'The average issue resolution time. ' + externalDocs: + description: CHAOSS Metric Definition + url: https://github.com/chaoss/wg-risk/blob/master/focus-areas/business-risk.md + operationId: Average Issue Resolution Time (Repo Group) + parameters: + - description: Repository Group ID + in: path + name: repo_group_id + schema: + type: string + type: string + responses: + '200': + description: OK + schema: + items: + properties: + avg_issue_resolution_time: + description: 'Example: 1413 days 15:39:48' + type: string + repo_id: + description: 'Example: 21353' + type: integer + repo_name: + description: 'Example: open_id_authentication' + type: string + type: array + tags: + - risk + /repo-groups/:repo_group_id/cii-best-practices-badge: + get: + description: 'The CII Best Practices Badge level. ' + externalDocs: + description: CHAOSS Metric Definition + url: https://github.com/chaoss/wg-risk/blob/master/focus-areas/security.md + operationId: CII Best Practices Badge (Repo Group) + parameters: + - description: Repository Group ID + in: path + name: repo_group_id + schema: + type: string + type: string + responses: + '200': + description: OK + schema: + items: + properties: + badge_level: + description: 'Example: in_progress' + type: string + repo_id: + description: 'Example: 21252' + type: integer + repo_name: + description: 'Example: php-legal-licenses' + type: string + type: array + tags: + - risk + /repo-groups/:repo_group_id/fork-count: + get: + description: 'Fork count. ' + externalDocs: + description: CHAOSS Metric Definition + url: https://github.com/chaoss/wg-risk/blob/master/focus-areas/business-risk.md + operationId: Fork Count (Repo Group) + parameters: + - description: Repository Group ID + in: path + name: repo_group_id + schema: + type: string + type: string + responses: + '200': + description: OK + schema: + items: + properties: + forks: + description: 'Example: 4' + type: integer + repo_id: + description: 'Example: 21364' + type: integer + repo_name: + description: 'Example: irs_process_scripts' + type: string + type: array + tags: + - risk + /repo-groups/:repo_group_id/forks: + get: + description: 'A time series of fork count. ' + externalDocs: + description: CHAOSS Metric Definition + url: https://github.com/chaoss/wg-risk/blob/master/focus-areas/business-risk.md + operationId: Forks (Repo Group) + parameters: + - description: Repository Group ID + in: path + name: repo_group_id + schema: + type: string + type: string + responses: + '200': + description: OK + schema: + items: + properties: + date: + description: 'Example: 2019-07-03T23:26:42.000Z' + type: string + forks: + description: 'Example: 519' + type: integer + repo_id: + description: 'Example: 21036' + type: integer + repo_name: + description: 'Example: jquery-ujs' + type: string + type: array + tags: + - risk + /repo-groups/:repo_group_id/languages: + get: + description: 'The primary language of the repository. ' + externalDocs: + description: CHAOSS Metric Definition + url: https://github.com/chaoss/wg-risk/blob/master/focus-areas/security.md + operationId: Languages (Repo Group) + parameters: + - description: Repository Group ID + in: path + name: repo_group_id + schema: + type: string + type: string + responses: + '200': + description: OK + schema: + items: + properties: + primary_language: + description: 'Example: Go' + type: string + repo_id: + description: 'Example: 21277' + type: integer + type: array + tags: + - risk + /repo-groups/:repo_group_id/license-count: + get: + description: 'The declared software package license (fetched from CII Best Practices + badging data). ' + externalDocs: + description: CHAOSS Metric Definition + url: https://github.com/chaoss/wg-risk/blob/master/focus-areas/licensing.md + operationId: License Count (Repo Group) + parameters: + - description: Repository Group ID + in: path + name: repo_group_id + schema: + type: string + type: string + responses: + '200': + description: OK + schema: + items: + properties: + file_without_licenses: + description: 'Example: True' + type: string + name: + description: 'Example: ActorServiceRegistry' + type: string + number_of_license: + description: 'Example: 2' + type: integer + type: array + tags: + - risk + /repo-groups/:repo_group_id/license-coverage: + get: + description: 'Number of persons opening an issue for the first time. ' + externalDocs: + description: CHAOSS Metric Definition + url: https://github.com/chaoss/wg-risk/blob/master/metrics/License_Coverage.md + operationId: License Coverage (Repo Group) + parameters: + - description: Repository Group ID + in: path + name: repo_group_id + schema: + type: string + type: string + responses: + '200': + description: OK + schema: + items: + properties: + coverage: + description: 'Example: 0.373' + type: string + license_declared_files: + description: 'Example: 19' + type: integer + name: + description: 'Example: ActorServiceRegistry' + type: string + total_files: + description: 'Example: 51' + type: integer + type: array + tags: + - risk + /repo-groups/:repo_group_id/license-declared: + get: + description: 'Number of persons opening an issue for the first time. ' + externalDocs: + description: CHAOSS Metric Definition + url: https://github.com/chaoss/wg-risk/blob/master/metrics/License_Coverage.md + operationId: License Declared (Repo Group) + parameters: + - description: Repository Group ID + in: path + name: repo_group_id + schema: + type: string + type: string + responses: + '200': + description: OK + schema: + items: + properties: + name: + description: 'Example: trickster' + type: string + note: + description: 'Example: ' + type: string + short_name: + description: 'Example: Apache-2.0' + type: string + type: array + tags: + - risk + /repos/:repo_id/average-issue-resolution-time: + get: + description: 'The average issue resolution time. ' + externalDocs: + description: CHAOSS Metric Definition + url: https://github.com/chaoss/wg-risk/blob/master/focus-areas/business-risk.md + operationId: Average Issue Resolution Time (Repo) + parameters: + - description: Repository Group ID. + in: path + name: repo_group_id + schema: + type: string + type: string + - description: Repository ID. + in: path + name: repo_id + schema: + type: string + type: string + responses: + '200': + description: OK + schema: + items: + properties: + avg_issue_resolution_time: + description: 'Example: 276 days 13:54:13.2' + type: string + repo_name: + description: 'Example: maven-release' + type: string + type: array + tags: + - risk + /repos/:repo_id/cii-best-practices-badge: + get: + description: 'The CII Best Practices Badge level. ' + externalDocs: + description: CHAOSS Metric Definition + url: https://github.com/chaoss/wg-risk/blob/master/focus-areas/security.md + operationId: CII Best Practices Badge (Repo) + parameters: + - description: Repository Group ID. + in: path + name: repo_group_id + schema: + type: string + type: string + - description: Repository ID. + in: path + name: repo_id + schema: + type: string + type: string + responses: + '200': + description: OK + schema: + items: + properties: + badge_level: + description: 'Example: passing' + type: string + repo_name: + description: 'Example: trickster' + type: string + type: array + tags: + - risk + /repos/:repo_id/committers: + get: + description: 'Number of persons contributing with an accepted commit for the + first time. ' + externalDocs: + description: CHAOSS Metric Definition + url: https://github.com/chaoss/wg-risk/blob/master/metrics/Committers.md + operationId: Committers (Repo) + parameters: + - description: Repository Group ID. + in: path + name: repo_group_id + schema: + type: string + type: string + - description: Repository ID. + in: path + name: repo_id + schema: + type: string + type: string + - description: Periodicity specification. + in: path + name: period + schema: + type: string + type: string + - description: 'Beginning date specification. E.g. values: 2018, 2018-05, 2019-05-01' + in: path + name: begin_date + schema: + type: string + type: string + - description: 'Ending date specification. E.g. values: 2018, 2018-05, 2019-05-01' + in: path + name: end_date + schema: + type: string + type: string + responses: + '200': + description: OK + schema: + items: + properties: + count: + description: 'Example: 1' + type: integer + date: + description: 'Example: 2018-10-25T00:00:00.000Z' + type: string + repo_name: + description: 'Example: weasel' + type: string + rg_name: + description: 'Example: Comcast' + type: string + type: array + tags: + - risk + /repos/:repo_id/fork-count: + get: + description: 'Fork count. ' + externalDocs: + description: CHAOSS Metric Definition + url: https://github.com/chaoss/wg-risk/blob/master/focus-areas/business-risk.md + operationId: Fork Count (Repo) + parameters: + - description: Repository Group ID. + in: path + name: repo_group_id + schema: + type: string + type: string + - description: Repository ID. + in: path + name: repo_id + schema: + type: string + type: string + responses: + '200': + description: OK + schema: + items: + properties: + forks: + description: 'Example: 844' + type: integer + repo_name: + description: 'Example: graphiql' + type: string + type: array + tags: + - risk + /repos/:repo_id/forks: + get: + description: 'A time series of fork count. ' + externalDocs: + description: CHAOSS Metric Definition + url: https://github.com/chaoss/wg-risk/blob/master/focus-areas/business-risk.md + operationId: Forks (Repo) + parameters: + - description: Repository Group ID. + in: path + name: repo_group_id + schema: + type: string + type: string + - description: Repository ID. + in: path + name: repo_id + schema: + type: string + type: string + responses: + '200': + description: OK + schema: + items: + properties: + date: + description: 'Example: 2019-07-03T23:27:42.000Z' + type: string + forks: + description: 'Example: 843' + type: integer + repo_name: + description: 'Example: graphiql' + type: string + type: array + tags: + - risk + /repos/:repo_id/license-coverage: + get: + description: 'Number of persons contributing with an accepted commit for the + first time. ' + externalDocs: + description: CHAOSS Metric Definition + url: https://github.com/chaoss/wg-risk/blob/master/metrics/License_Coverage.md + operationId: License Coverage (Repo) + parameters: + - description: Repository Group ID. + in: path + name: repo_group_id + schema: + type: string + type: string + - description: Repository ID. + in: path + name: repo_id + schema: + type: string + type: string + responses: + '200': + description: OK + schema: + items: + properties: + coverage: + description: 'Example: 0.347' + type: string + license_declared_file: + description: 'Example: 33' + type: integer + repo_name: + description: 'Example: zucchini' + type: string + total_files: + description: 'Example: 95' + type: integer + type: array + tags: + - risk + /repos/:repo_id/license-declared: + get: + description: 'Number of persons contributing with an accepted commit for the + first time. ' + externalDocs: + description: CHAOSS Metric Definition + url: https://github.com/chaoss/wg-risk/blob/master/metrics/License_Coverage.md + operationId: License Declared (Repo) + parameters: + - description: Repository Group ID. + in: path + name: repo_group_id + schema: + type: string + type: string + - description: Repository ID. + in: path + name: repo_id + schema: + type: string + type: string + responses: + '200': + description: OK + schema: + items: + properties: + name: + description: 'Example: trickster' + type: string + note: + description: 'Example: ' + type: string + short_name: + description: 'Example: Apache-2.0' + type: string + type: array + tags: + - risk /repo-groups/:repo_group_id/abandoned-issues: get: description: List of abandoned issues (last updated >= 1 year ago) @@ -534,70 +1078,6 @@ paths: type: array tags: - experimental - /repo-groups/:repo_group_id/average-issue-resolution-time: - get: - description: 'The average issue resolution time. ' - externalDocs: - description: CHAOSS Metric Definition - url: https://github.com/chaoss/wg-risk/blob/master/focus-areas/business-risk.md - operationId: Average Issue Resolution Time (Repo Group) - parameters: - - description: Repository Group ID - in: path - name: repo_group_id - schema: - type: string - type: string - responses: - '200': - description: OK - schema: - items: - properties: - avg_issue_resolution_time: - description: 'Example: 1413 days 15:39:48' - type: string - repo_id: - description: 'Example: 21353' - type: integer - repo_name: - description: 'Example: open_id_authentication' - type: string - type: array - tags: - - risk - /repo-groups/:repo_group_id/cii-best-practices-badge: - get: - description: 'The CII Best Practices Badge level. ' - externalDocs: - description: CHAOSS Metric Definition - url: https://github.com/chaoss/wg-risk/blob/master/focus-areas/security.md - operationId: CII Best Practices Badge (Repo Group) - parameters: - - description: Repository Group ID - in: path - name: repo_group_id - schema: - type: string - type: string - responses: - '200': - description: OK - schema: - items: - properties: - badge_level: - description: 'Example: in_progress' - type: string - repo_id: - description: 'Example: 21252' - type: integer - repo_name: - description: 'Example: php-legal-licenses' - type: string - type: array - tags: - - risk /repo-groups/:repo_group_id/closed-issues-count: get: description: 'Count of closed issues. ' @@ -822,90 +1302,23 @@ paths: in: path name: repo_group_id schema: - type: string - type: string - - description: Periodicity specification. - in: path - name: period - schema: - type: string - type: string - - description: 'Beginning date specification. E.g. values: 2018, 2018-05, 2019-05-01' - in: path - name: begin_date - schema: - type: string - type: string - - description: 'Ending date specification. E.g. values: 2018, 2018-05, 2019-05-01' - in: path - name: end_date - schema: - type: string - type: string - responses: - '200': - description: OK - schema: - items: - properties: - date: - description: 'Example: 2018-05-20T00:00:00.000Z' - type: string - new_contributors: - description: 'Example: 3' - type: integer - repo_id: - description: 'Example: 21000' - type: integer - repo_name: - description: 'Example: rails' - type: string - type: array - tags: - - evolution - /repo-groups/:repo_group_id/fork-count: - get: - description: 'Fork count. ' - externalDocs: - description: CHAOSS Metric Definition - url: https://github.com/chaoss/wg-risk/blob/master/focus-areas/business-risk.md - operationId: Fork Count (Repo Group) - parameters: - - description: Repository Group ID - in: path - name: repo_group_id - schema: - type: string - type: string - responses: - '200': - description: OK - schema: - items: - properties: - forks: - description: 'Example: 4' - type: integer - repo_id: - description: 'Example: 21364' - type: integer - repo_name: - description: 'Example: irs_process_scripts' - type: string - type: array - tags: - - risk - /repo-groups/:repo_group_id/forks: - get: - description: 'A time series of fork count. ' - externalDocs: - description: CHAOSS Metric Definition - url: https://github.com/chaoss/wg-risk/blob/master/focus-areas/business-risk.md - operationId: Forks (Repo Group) - parameters: - - description: Repository Group ID + type: string + type: string + - description: Periodicity specification. in: path - name: repo_group_id + name: period + schema: + type: string + type: string + - description: 'Beginning date specification. E.g. values: 2018, 2018-05, 2019-05-01' + in: path + name: begin_date + schema: + type: string + type: string + - description: 'Ending date specification. E.g. values: 2018, 2018-05, 2019-05-01' + in: path + name: end_date schema: type: string type: string @@ -916,20 +1329,20 @@ paths: items: properties: date: - description: 'Example: 2019-07-03T23:26:42.000Z' + description: 'Example: 2018-05-20T00:00:00.000Z' type: string - forks: - description: 'Example: 519' + new_contributors: + description: 'Example: 3' type: integer repo_id: - description: 'Example: 21036' + description: 'Example: 21000' type: integer repo_name: - description: 'Example: jquery-ujs' + description: 'Example: rails' type: string type: array tags: - - risk + - evolution /repo-groups/:repo_group_id/issue-backlog: get: description: 'Number of issues currently open. ' @@ -1558,135 +1971,6 @@ paths: type: array tags: - evolution - /repo-groups/:repo_group_id/languages: - get: - description: 'The primary language of the repository. ' - externalDocs: - description: CHAOSS Metric Definition - url: https://github.com/chaoss/wg-risk/blob/master/focus-areas/security.md - operationId: Languages (Repo Group) - parameters: - - description: Repository Group ID - in: path - name: repo_group_id - schema: - type: string - type: string - responses: - '200': - description: OK - schema: - items: - properties: - primary_language: - description: 'Example: Go' - type: string - repo_id: - description: 'Example: 21277' - type: integer - type: array - tags: - - risk - /repo-groups/:repo_group_id/license-count: - get: - description: 'The declared software package license (fetched from CII Best Practices - badging data). ' - externalDocs: - description: CHAOSS Metric Definition - url: https://github.com/chaoss/wg-risk/blob/master/focus-areas/licensing.md - operationId: License Count (Repo Group) - parameters: - - description: Repository Group ID - in: path - name: repo_group_id - schema: - type: string - type: string - responses: - '200': - description: OK - schema: - items: - properties: - file_without_licenses: - description: 'Example: True' - type: string - name: - description: 'Example: ActorServiceRegistry' - type: string - number_of_license: - description: 'Example: 2' - type: integer - type: array - tags: - - risk - /repo-groups/:repo_group_id/license-coverage: - get: - description: 'Number of persons opening an issue for the first time. ' - externalDocs: - description: CHAOSS Metric Definition - url: https://github.com/chaoss/wg-risk/blob/master/metrics/License_Coverage.md - operationId: License Coverage (Repo Group) - parameters: - - description: Repository Group ID - in: path - name: repo_group_id - schema: - type: string - type: string - responses: - '200': - description: OK - schema: - items: - properties: - coverage: - description: 'Example: 0.373' - type: string - license_declared_files: - description: 'Example: 19' - type: integer - name: - description: 'Example: ActorServiceRegistry' - type: string - total_files: - description: 'Example: 51' - type: integer - type: array - tags: - - risk - /repo-groups/:repo_group_id/license-declared: - get: - description: 'Number of persons opening an issue for the first time. ' - externalDocs: - description: CHAOSS Metric Definition - url: https://github.com/chaoss/wg-risk/blob/master/metrics/License_Coverage.md - operationId: License Declared (Repo Group) - parameters: - - description: Repository Group ID - in: path - name: repo_group_id - schema: - type: string - type: string - responses: - '200': - description: OK - schema: - items: - properties: - name: - description: 'Example: trickster' - type: string - note: - description: 'Example: ' - type: string - short_name: - description: 'Example: Apache-2.0' - type: string - type: array - tags: - - risk /repo-groups/:repo_group_id/lines-changed-by-author: get: description: 'Count of closed issues. ' @@ -2328,104 +2612,10 @@ paths: - value /repos/:repo_id/aggregate-summary: get: - description: Returns the current count of watchers, stars, and forks and the - counts of all commits, committers, and pull requests merged between a given - beginning and end date (default between now and 365 days ago). - operationId: Aggregate Summary (Repo) - parameters: - - description: Repository Group ID. - in: path - name: repo_group_id - schema: - type: string - type: string - - description: Repository ID. - in: path - name: repo_id - schema: - type: string - type: string - - description: 'Beginning date specification. E.g. values: 2018, 2018-05, 2019-05-01' - in: path - name: begin_date - schema: - type: string - type: string - - description: 'Ending date specification. E.g. values: 2018, 2018-05, 2019-05-01' - in: path - name: end_date - schema: - type: string - type: string - responses: - '200': - description: OK - schema: - items: - properties: - commit_count: - description: 'Example: 133' - type: integer - committer_count: - description: 'Example: 5' - type: integer - fork_count: - description: 'Example: 449' - type: integer - merged_count: - description: 'Example: 0' - type: integer - star_count: - description: 'Example: 581' - type: integer - watcher_count: - description: 'Example: 83' - type: integer - type: array - tags: - - experimental - /repos/:repo_id/average-issue-resolution-time: - get: - description: 'The average issue resolution time. ' - externalDocs: - description: CHAOSS Metric Definition - url: https://github.com/chaoss/wg-risk/blob/master/focus-areas/business-risk.md - operationId: Average Issue Resolution Time (Repo) - parameters: - - description: Repository Group ID. - in: path - name: repo_group_id - schema: - type: string - type: string - - description: Repository ID. - in: path - name: repo_id - schema: - type: string - type: string - responses: - '200': - description: OK - schema: - items: - properties: - avg_issue_resolution_time: - description: 'Example: 276 days 13:54:13.2' - type: string - repo_name: - description: 'Example: maven-release' - type: string - type: array - tags: - - risk - /repos/:repo_id/cii-best-practices-badge: - get: - description: 'The CII Best Practices Badge level. ' - externalDocs: - description: CHAOSS Metric Definition - url: https://github.com/chaoss/wg-risk/blob/master/focus-areas/security.md - operationId: CII Best Practices Badge (Repo) + description: Returns the current count of watchers, stars, and forks and the + counts of all commits, committers, and pull requests merged between a given + beginning and end date (default between now and 365 days ago). + operationId: Aggregate Summary (Repo) parameters: - description: Repository Group ID. in: path @@ -2439,21 +2629,45 @@ paths: schema: type: string type: string + - description: 'Beginning date specification. E.g. values: 2018, 2018-05, 2019-05-01' + in: path + name: begin_date + schema: + type: string + type: string + - description: 'Ending date specification. E.g. values: 2018, 2018-05, 2019-05-01' + in: path + name: end_date + schema: + type: string + type: string responses: '200': description: OK schema: items: properties: - badge_level: - description: 'Example: passing' - type: string - repo_name: - description: 'Example: trickster' - type: string + commit_count: + description: 'Example: 133' + type: integer + committer_count: + description: 'Example: 5' + type: integer + fork_count: + description: 'Example: 449' + type: integer + merged_count: + description: 'Example: 0' + type: integer + star_count: + description: 'Example: 581' + type: integer + watcher_count: + description: 'Example: 83' + type: integer type: array tags: - - risk + - experimental /repos/:repo_id/closed-issues-count: get: description: 'Count of closed issues. ' @@ -2601,66 +2815,6 @@ paths: type: array tags: - evolution - /repos/:repo_id/committers: - get: - description: 'Number of persons contributing with an accepted commit for the - first time. ' - externalDocs: - description: CHAOSS Metric Definition - url: https://github.com/chaoss/wg-risk/blob/master/metrics/Committers.md - operationId: Committers (Repo) - parameters: - - description: Repository Group ID. - in: path - name: repo_group_id - schema: - type: string - type: string - - description: Repository ID. - in: path - name: repo_id - schema: - type: string - type: string - - description: Periodicity specification. - in: path - name: period - schema: - type: string - type: string - - description: 'Beginning date specification. E.g. values: 2018, 2018-05, 2019-05-01' - in: path - name: begin_date - schema: - type: string - type: string - - description: 'Ending date specification. E.g. values: 2018, 2018-05, 2019-05-01' - in: path - name: end_date - schema: - type: string - type: string - responses: - '200': - description: OK - schema: - items: - properties: - count: - description: 'Example: 1' - type: integer - date: - description: 'Example: 2018-10-25T00:00:00.000Z' - type: string - repo_name: - description: 'Example: weasel' - type: string - rg_name: - description: 'Example: Comcast' - type: string - type: array - tags: - - risk /repos/:repo_id/contributors: get: description: 'List of contributors and their contributions. ' @@ -2785,79 +2939,6 @@ paths: type: array tags: - evolution - /repos/:repo_id/fork-count: - get: - description: 'Fork count. ' - externalDocs: - description: CHAOSS Metric Definition - url: https://github.com/chaoss/wg-risk/blob/master/focus-areas/business-risk.md - operationId: Fork Count (Repo) - parameters: - - description: Repository Group ID. - in: path - name: repo_group_id - schema: - type: string - type: string - - description: Repository ID. - in: path - name: repo_id - schema: - type: string - type: string - responses: - '200': - description: OK - schema: - items: - properties: - forks: - description: 'Example: 844' - type: integer - repo_name: - description: 'Example: graphiql' - type: string - type: array - tags: - - risk - /repos/:repo_id/forks: - get: - description: 'A time series of fork count. ' - externalDocs: - description: CHAOSS Metric Definition - url: https://github.com/chaoss/wg-risk/blob/master/focus-areas/business-risk.md - operationId: Forks (Repo) - parameters: - - description: Repository Group ID. - in: path - name: repo_group_id - schema: - type: string - type: string - - description: Repository ID. - in: path - name: repo_id - schema: - type: string - type: string - responses: - '200': - description: OK - schema: - items: - properties: - date: - description: 'Example: 2019-07-03T23:27:42.000Z' - type: string - forks: - description: 'Example: 843' - type: integer - repo_name: - description: 'Example: graphiql' - type: string - type: array - tags: - - risk /repos/:repo_id/issue-backlog: get: description: 'Time since an issue is proposed until it is closed. ' @@ -3500,87 +3581,6 @@ paths: type: array tags: - evolution - /repos/:repo_id/license-coverage: - get: - description: 'Number of persons contributing with an accepted commit for the - first time. ' - externalDocs: - description: CHAOSS Metric Definition - url: https://github.com/chaoss/wg-risk/blob/master/metrics/License_Coverage.md - operationId: License Coverage (Repo) - parameters: - - description: Repository Group ID. - in: path - name: repo_group_id - schema: - type: string - type: string - - description: Repository ID. - in: path - name: repo_id - schema: - type: string - type: string - responses: - '200': - description: OK - schema: - items: - properties: - coverage: - description: 'Example: 0.347' - type: string - license_declared_file: - description: 'Example: 33' - type: integer - repo_name: - description: 'Example: zucchini' - type: string - total_files: - description: 'Example: 95' - type: integer - type: array - tags: - - risk - /repos/:repo_id/license-declared: - get: - description: 'Number of persons contributing with an accepted commit for the - first time. ' - externalDocs: - description: CHAOSS Metric Definition - url: https://github.com/chaoss/wg-risk/blob/master/metrics/License_Coverage.md - operationId: License Declared (Repo) - parameters: - - description: Repository Group ID. - in: path - name: repo_group_id - schema: - type: string - type: string - - description: Repository ID. - in: path - name: repo_id - schema: - type: string - type: string - responses: - '200': - description: OK - schema: - items: - properties: - name: - description: 'Example: trickster' - type: string - note: - description: 'Example: ' - type: string - short_name: - description: 'Example: Apache-2.0' - type: string - type: array - tags: - - risk /repos/:repo_id/pull-request-acceptance-rate: get: description: Timeseries of pull request acceptance rate (expressed as the ratio From 85e770687c5ade1aff332337d51e33259d409b7e Mon Sep 17 00:00:00 2001 From: Andrew Brain <61482022+ABrain7710@users.noreply.github.com> Date: Thu, 19 Aug 2021 12:33:36 -0500 Subject: [PATCH 04/17] Organize experimental endpoint docs Signed-off-by: Andrew Brain <61482022+ABrain7710@users.noreply.github.com> --- docs/source/rest-api/spec.yml | 1378 ++++++++++++++++----------------- 1 file changed, 689 insertions(+), 689 deletions(-) diff --git a/docs/source/rest-api/spec.yml b/docs/source/rest-api/spec.yml index 7fa366d816..411f084984 100644 --- a/docs/source/rest-api/spec.yml +++ b/docs/source/rest-api/spec.yml @@ -1078,6 +1078,617 @@ paths: type: array tags: - experimental + /repo-groups/:repo_group_id/issue-comments-mean: + get: + description: Mean(Average) of issue comments per day. + operationId: Issue Comments Mean (Repo Group) + parameters: + - description: Repository Group ID. + in: path + name: repo_group_id + schema: + type: string + type: string + - description: 'Allows for results to be grouped by day, week, month, or year. + E.g. values: year, day, month' + in: path + name: group_by + schema: + type: string + type: string + responses: + '200': + description: OK + schema: + items: + properties: + date: + description: 'Example: 2018-01-01T00:00:00.000Z' + type: string + mean: + description: 'Example: 0.6191780822' + type: string + repo_id: + description: 'Example: 21326' + type: integer + type: array + tags: + - experimental + /repo-groups/:repo_group_id/issue-comments-mean-std: + get: + description: Mean(Average) and Standard Deviation of issue comments per day. + operationId: Issue Comments Mean Std (Repo Group) + parameters: + - description: Repository Group ID. + in: path + name: repo_group_id + schema: + type: string + type: string + - description: 'Allows for results to be grouped by day, week, month, or year. + E.g. values: year, day, month' + in: path + name: group_by + schema: + type: string + type: string + responses: + '200': + description: OK + schema: + items: + properties: + date: + description: 'Example: 2018-01-01T00:00:00.000Z' + type: string + mean: + description: 'Example: 0.6191780822' + type: string + repo_id: + description: 'Example: 21326' + type: integer + type: array + tags: + - experimental + /repo-groups/:repo_group_id/lines-changed-by-author: + get: + description: 'Count of closed issues. ' + externalDocs: + description: CHAOSS Metric Definition + url: https://github.com/chaoss/wg-evolution/blob/master/metrics/contributors-new.md + operationId: Lines Changed by Author (Repo) + parameters: + - description: Repository Group ID + in: path + name: repo_group_id + schema: + type: string + type: string + - description: Repository ID. + in: path + name: repo_id + schema: + type: string + type: string + responses: + '200': + description: OK + schema: + items: + properties: + additions: + description: 'Example: 25611' + type: integer + affiliation: + description: 'Example: NULL' + type: string + cmt_author_date: + description: 'Example: 2004-11-24' + type: string + cmt_author_email: + description: 'Example: david@loudthinking.com' + type: string + deletions: + description: 'Example: 296' + type: integer + whitespace: + description: 'Example: 5279' + type: integer + type: array + tags: + - experimental + /repo-groups/:repo_group_id/pull-request-acceptance-rate: + get: + description: Timeseries of pull request acceptance rate (expressed as the ratio + of pull requests merged on a date to the count of pull requests opened on + a date) + operationId: Pull Request Acceptance Rate (Repo Group) + parameters: + - description: Repository Group ID. + in: path + name: repo_group_id + schema: + type: string + type: string + - description: 'Beginning date specification. E.g. values: 2018, 2018-05, 2019-05-01' + in: path + name: begin_date + schema: + type: string + type: string + - description: 'Ending date specification. E.g. values: 2018, 2018-05, 2019-05-01' + in: path + name: end_date + schema: + type: string + type: string + - description: 'Allows for results to be grouped by day, week, month, or year. + E.g. values: year, day, month' + in: path + name: group_by + schema: + type: string + type: string + responses: + '200': + description: OK + schema: + items: + properties: + date: + description: 'Example: 2019-02-11T00:00:00.000Z' + type: string + rate: + description: 'Example: 120.5' + type: string + type: array + tags: + - experimental + /repo-groups/:repo_group_id/pull-requests-closed-no-merge: + get: + description: Timeseries of pull request which were closed but not merged + operationId: Pull Request Closed but Not Merged (Repo) + parameters: + - description: Repository Group ID. + in: path + name: repo_group_id + schema: + type: string + type: string + - description: 'Beginning date specification. E.g. values: 2018, 2018-05, 2019-05-01' + in: path + name: begin_date + schema: + type: string + type: string + - description: 'Ending date specification. E.g. values: 2018, 2018-05, 2019-05-01' + in: path + name: end_date + schema: + type: string + type: string + responses: + '200': + description: OK + schema: + items: + properties: + date: + description: 'Example: 2019-01-01T00:00:00.000Z' + type: string + pr_count: + description: 'Example: 3' + type: integer + type: array + tags: + - experimental + /repo-groups/:repo_group_id/top-committers: + get: + description: Returns a list of contributors contributing N% of all commits. + operationId: Top Committers (Repo Group) + parameters: + - description: Repository Group ID + in: path + name: repo_group_id + schema: + type: string + type: string + - description: 'Specify the year to return the results for. Default value: current + year' + in: path + name: year + schema: + type: string + type: string + - description: Specify N%. Accepts a value between 0 & 1 where 0 specifies + 0% and 1 specifies 100%. + in: path + name: threshold + schema: + type: string + type: string + responses: + '200': + description: OK + schema: + items: + properties: + commits: + description: 'Example: 502' + type: integer + email: + description: 'Example: kamipo@gmail.com' + type: string + repo_group_id: + description: 'Example: 20' + type: integer + repo_group_name: + description: 'Example: Rails' + type: string + type: array + tags: + - experimental + /repos/:repo_id/aggregate-summary: + get: + description: Returns the current count of watchers, stars, and forks and the + counts of all commits, committers, and pull requests merged between a given + beginning and end date (default between now and 365 days ago). + operationId: Aggregate Summary (Repo) + parameters: + - description: Repository Group ID. + in: path + name: repo_group_id + schema: + type: string + type: string + - description: Repository ID. + in: path + name: repo_id + schema: + type: string + type: string + - description: 'Beginning date specification. E.g. values: 2018, 2018-05, 2019-05-01' + in: path + name: begin_date + schema: + type: string + type: string + - description: 'Ending date specification. E.g. values: 2018, 2018-05, 2019-05-01' + in: path + name: end_date + schema: + type: string + type: string + responses: + '200': + description: OK + schema: + items: + properties: + commit_count: + description: 'Example: 133' + type: integer + committer_count: + description: 'Example: 5' + type: integer + fork_count: + description: 'Example: 449' + type: integer + merged_count: + description: 'Example: 0' + type: integer + star_count: + description: 'Example: 581' + type: integer + watcher_count: + description: 'Example: 83' + type: integer + type: array + tags: + - experimental + /repos/:repo_id/issue-comments-mean: + get: + description: Mean(Average) of issue comments per day. + operationId: Issue Comments Mean (Repo) + parameters: + - description: Repository Group ID. + in: path + name: repo_group_id + schema: + type: string + type: string + - description: Repository ID. + in: path + name: repo_id + schema: + type: string + type: string + responses: + '200': + description: OK + schema: + items: + properties: + date: + description: 'Example: 2018-01-01T00:00:00.000Z' + type: string + mean: + description: 'Example: 0.6191780822' + type: string + repo_id: + description: 'Example: 21326' + type: integer + type: array + tags: + - experimental + /repos/:repo_id/issue-comments-mean-std: + get: + description: Mean(Average) and Standard Deviation of issue comments per day. + operationId: Issue Comments Mean Std (Repo) + parameters: + - description: Repository Group ID. + in: path + name: repo_group_id + schema: + type: string + type: string + - description: Repository ID. + in: path + name: repo_id + schema: + type: string + type: string + responses: + '200': + description: OK + schema: + items: + properties: + average: + description: 'Example: 2.5' + type: string + date: + description: 'Example: 2011-01-01T00:00:00.000Z' + type: string + repo_id: + description: 'Example: 21000' + type: integer + standard_deviation: + description: 'Example: 1.7159383568' + type: string + type: array + tags: + - experimental + /repos/:repo_id/pull-request-acceptance-rate: + get: + description: Timeseries of pull request acceptance rate (expressed as the ratio + of pull requests merged on a date to the count of pull requests opened on + a date) + operationId: Pull Request Acceptance Rate (Repo) + parameters: + - description: Repository Group ID. + in: path + name: repo_group_id + schema: + type: string + type: string + - description: Repository ID. + in: path + name: repo_id + schema: + type: string + type: string + - description: 'Beginning date specification. E.g. values: 2018, 2018-05, 2019-05-01' + in: path + name: begin_date + schema: + type: string + type: string + - description: 'Ending date specification. E.g. values: 2018, 2018-05, 2019-05-01' + in: path + name: end_date + schema: + type: string + type: string + responses: + '200': + description: OK + schema: + items: + properties: + date: + description: 'Example: 2019-01-01T00:00:00.000Z' + type: string + rate: + description: 'Example: 5.3333333333' + type: string + type: array + tags: + - experimental + /repos/:repo_id/pull-requests-closed-no-merge: + get: + description: '' + operationId: Pull Request Closed but Not Merged (Repo) + parameters: + - description: Repository ID. + in: path + name: repo_id + schema: + type: string + type: string + - description: 'Beginning date specification. E.g. values: 2018, 2018-05, 2019-05-01' + in: path + name: begin_date + schema: + type: string + type: string + - description: 'Ending date specification. E.g. values: 2018, 2018-05, 2019-05-01 + ___' + in: path + name: end_date + schema: + type: string + type: string + responses: + '200': + description: OK + schema: + items: + properties: + date: + description: 'Example: 2019-01-01T00:00:00.000Z' + type: string + pr_count: + description: 'Example: 3' + type: integer + type: array + tags: + - experimental + /repos/:repo_id/top-committers: + get: + description: Returns a list of contributors contributing N% of all commits. + operationId: Top Committers (Repo) + parameters: + - description: Repository Group ID. + in: path + name: repo_group_id + schema: + type: string + type: string + - description: Repository ID. + in: path + name: repo_id + schema: + type: string + type: string + - description: 'Specify the year to return the results for. Default value: current + year' + in: path + name: year + schema: + type: string + type: string + - description: Specify N%. Accepts a value between 0 & 1 where 0 specifies + 0% and 1 specifies 100%. + in: path + name: threshold + schema: + type: string + type: string + responses: + '200': + description: OK + schema: + items: + properties: + commits: + description: 'Example: 4' + type: integer + email: + description: 'Example: caniszczyk@gmail.com' + type: string + repo_id: + description: 'Example: 21334' + type: integer + repo_name: + description: 'Example: graphql' + type: string + type: array + tags: + - experimental + /repo-groups/:repo_group_id/open-issues-count: + get: + description: 'Count of open issues. ' + externalDocs: + description: CHAOSS Metric Definition + url: https://github.com/chaoss/wg-evolution/blob/master/metrics/Issues_New.md + operationId: Open Issues Count (Repo Group) + parameters: + - description: Repository Group ID + in: path + name: repo_group_id + schema: + type: string + type: string + responses: + '200': + description: OK + schema: + items: + properties: + date: + description: 'Example: 2017-09-11T00:00:00.000Z' + type: string + open_count: + description: 'Example: 1' + type: integer + rg_name: + description: 'Example: Netflix' + type: string + type: array + tags: + - evolution + /repo-groups/:repo_group_id/watchers: + get: + description: A time series of watchers count. + operationId: Watchers (Repo Group) + parameters: + - description: Repository Group ID + in: path + name: repo_group_id + schema: + type: string + type: string + responses: + '200': + description: OK + schema: + items: + properties: + date: + description: 'Example: 2019-07-03T23:26:42.000Z' + type: string + repo_id: + description: 'Example: 21036' + type: integer + repo_name: + description: 'Example: jquery-ujs' + type: string + watchers: + description: 'Example: 60' + type: integer + type: array + tags: + - value + /repo-groups/:repo_group_id/watchers-count: + get: + description: Watchers count. + operationId: Watchers Count (Repo Group) + parameters: + - description: Repository Group ID + in: path + name: repo_group_id + schema: + type: string + type: string + responses: + '200': + description: OK + schema: + items: + properties: + repo_id: + description: 'Example: 21039' + type: integer + repo_name: + description: 'Example: rails_xss' + type: string + watchers: + description: 'Example: 20' + type: integer + type: array + tags: + - value /repo-groups/:repo_group_id/closed-issues-count: get: description: 'Count of closed issues. ' @@ -1375,78 +1986,6 @@ paths: type: array tags: - evolution - /repo-groups/:repo_group_id/issue-comments-mean: - get: - description: Mean(Average) of issue comments per day. - operationId: Issue Comments Mean (Repo Group) - parameters: - - description: Repository Group ID. - in: path - name: repo_group_id - schema: - type: string - type: string - - description: 'Allows for results to be grouped by day, week, month, or year. - E.g. values: year, day, month' - in: path - name: group_by - schema: - type: string - type: string - responses: - '200': - description: OK - schema: - items: - properties: - date: - description: 'Example: 2018-01-01T00:00:00.000Z' - type: string - mean: - description: 'Example: 0.6191780822' - type: string - repo_id: - description: 'Example: 21326' - type: integer - type: array - tags: - - experimental - /repo-groups/:repo_group_id/issue-comments-mean-std: - get: - description: Mean(Average) and Standard Deviation of issue comments per day. - operationId: Issue Comments Mean Std (Repo Group) - parameters: - - description: Repository Group ID. - in: path - name: repo_group_id - schema: - type: string - type: string - - description: 'Allows for results to be grouped by day, week, month, or year. - E.g. values: year, day, month' - in: path - name: group_by - schema: - type: string - type: string - responses: - '200': - description: OK - schema: - items: - properties: - date: - description: 'Example: 2018-01-01T00:00:00.000Z' - type: string - mean: - description: 'Example: 0.6191780822' - type: string - repo_id: - description: 'Example: 21326' - type: integer - type: array - tags: - - experimental /repo-groups/:repo_group_id/issue-duration: get: description: 'Time since an issue is proposed until it is closed. ' @@ -1836,195 +2375,13 @@ paths: type: array tags: - evolution - /repo-groups/:repo_group_id/issues-maintainer-response-duration: - get: - description: 'Duration of time for issues to be resolved. ' - externalDocs: - description: CHAOSS Metric Definition - url: https://github.com/chaoss/wg-evolution/blob/master/metrics/issues-maintainer-response-duration.md - operationId: Issue Response Time (Repo Group) - parameters: - - description: Repository Group ID - in: path - name: repo_group_id - schema: - type: string - type: string - - description: 'Beginning date specification. E.g. values: 2018, 2018-05, 2019-05-01' - in: path - name: begin_date - schema: - type: string - type: string - - description: 'Ending date specification. E.g. values: 2018, 2018-05, 2019-05-01' - in: path - name: end_date - schema: - type: string - type: string - responses: - '200': - description: OK - schema: - items: - properties: - average_days_comment: - description: 'Example: 27.1111111111' - type: string - repo_id: - description: 'Example: 21987' - type: integer - repo_name: - description: 'Example: qpid-proton' - type: string - type: array - tags: - - evolution - /repo-groups/:repo_group_id/issues-new: - get: - description: 'Time series of number of new issues opened during a certain period. ' - externalDocs: - description: CHAOSS Metric Definition - url: https://github.com/chaoss/wg-evolution/blob/master/metrics/Issues_New.md - operationId: Issues New (Repo Group) - parameters: - - description: Repository Group ID - in: path - name: repo_group_id - schema: - type: string - type: string - - description: Periodicity specification. - in: path - name: period - schema: - type: string - type: string - - description: 'Beginning date specification. E.g. values: 2018, 2018-05, 2019-05-01' - in: path - name: begin_date - schema: - type: string - type: string - - description: 'Ending date specification. E.g. values: 2018, 2018-05, 2019-05-01' - in: path - name: end_date - schema: - type: string - type: string - responses: - '200': - description: OK - schema: - items: - properties: - date: - description: 'Example: 2019-01-01T00:00:00.000Z' - type: string - issues: - description: 'Example: 318' - type: integer - repo_id: - description: 'Example: 21000' - type: integer - repo_name: - description: 'Example: rails' - type: string - type: array - tags: - - evolution - /repo-groups/:repo_group_id/issues-open-age: - get: - description: 'Age of open issues. ' - externalDocs: - description: CHAOSS Metric Definition - url: https://github.com/chaoss/wg-evolution/blob/master/metrics/issues-open-age.md - operationId: Open Issue Age (Repo Group) - parameters: - - description: Repository Group ID - in: path - name: repo_group_id - schema: - type: string - type: string - responses: - '200': - description: OK - schema: - items: - properties: - date: - description: 'Example: 2009-05-15T19:48:43.000Z' - type: string - issue_id: - description: 'Example: 38318' - type: integer - open_date: - description: 'Example: 3696' - type: integer - repo_id: - description: 'Example: 21000' - type: integer - repo_name: - description: 'Example: rails' - type: string - type: array - tags: - - evolution - /repo-groups/:repo_group_id/lines-changed-by-author: - get: - description: 'Count of closed issues. ' - externalDocs: - description: CHAOSS Metric Definition - url: https://github.com/chaoss/wg-evolution/blob/master/metrics/contributors-new.md - operationId: Lines Changed by Author (Repo) - parameters: - - description: Repository Group ID - in: path - name: repo_group_id - schema: - type: string - type: string - - description: Repository ID. - in: path - name: repo_id - schema: - type: string - type: string - responses: - '200': - description: OK - schema: - items: - properties: - additions: - description: 'Example: 25611' - type: integer - affiliation: - description: 'Example: NULL' - type: string - cmt_author_date: - description: 'Example: 2004-11-24' - type: string - cmt_author_email: - description: 'Example: david@loudthinking.com' - type: string - deletions: - description: 'Example: 296' - type: integer - whitespace: - description: 'Example: 5279' - type: integer - type: array - tags: - - experimental - /repo-groups/:repo_group_id/open-issues-count: + /repo-groups/:repo_group_id/issues-maintainer-response-duration: get: - description: 'Count of open issues. ' + description: 'Duration of time for issues to be resolved. ' externalDocs: description: CHAOSS Metric Definition - url: https://github.com/chaoss/wg-evolution/blob/master/metrics/Issues_New.md - operationId: Open Issues Count (Repo Group) + url: https://github.com/chaoss/wg-evolution/blob/master/metrics/issues-maintainer-response-duration.md + operationId: Issue Response Time (Repo Group) parameters: - description: Repository Group ID in: path @@ -2032,53 +2389,65 @@ paths: schema: type: string type: string + - description: 'Beginning date specification. E.g. values: 2018, 2018-05, 2019-05-01' + in: path + name: begin_date + schema: + type: string + type: string + - description: 'Ending date specification. E.g. values: 2018, 2018-05, 2019-05-01' + in: path + name: end_date + schema: + type: string + type: string responses: '200': description: OK schema: items: properties: - date: - description: 'Example: 2017-09-11T00:00:00.000Z' + average_days_comment: + description: 'Example: 27.1111111111' type: string - open_count: - description: 'Example: 1' + repo_id: + description: 'Example: 21987' type: integer - rg_name: - description: 'Example: Netflix' + repo_name: + description: 'Example: qpid-proton' type: string type: array tags: - evolution - /repo-groups/:repo_group_id/pull-request-acceptance-rate: + /repo-groups/:repo_group_id/issues-new: get: - description: Timeseries of pull request acceptance rate (expressed as the ratio - of pull requests merged on a date to the count of pull requests opened on - a date) - operationId: Pull Request Acceptance Rate (Repo Group) + description: 'Time series of number of new issues opened during a certain period. ' + externalDocs: + description: CHAOSS Metric Definition + url: https://github.com/chaoss/wg-evolution/blob/master/metrics/Issues_New.md + operationId: Issues New (Repo Group) parameters: - - description: Repository Group ID. + - description: Repository Group ID in: path name: repo_group_id schema: type: string type: string - - description: 'Beginning date specification. E.g. values: 2018, 2018-05, 2019-05-01' + - description: Periodicity specification. in: path - name: begin_date + name: period schema: type: string type: string - - description: 'Ending date specification. E.g. values: 2018, 2018-05, 2019-05-01' + - description: 'Beginning date specification. E.g. values: 2018, 2018-05, 2019-05-01' in: path - name: end_date + name: begin_date schema: type: string type: string - - description: 'Allows for results to be grouped by day, week, month, or year. - E.g. values: year, day, month' + - description: 'Ending date specification. E.g. values: 2018, 2018-05, 2019-05-01' in: path - name: group_by + name: end_date schema: type: string type: string @@ -2089,37 +2458,34 @@ paths: items: properties: date: - description: 'Example: 2019-02-11T00:00:00.000Z' + description: 'Example: 2019-01-01T00:00:00.000Z' type: string - rate: - description: 'Example: 120.5' + issues: + description: 'Example: 318' + type: integer + repo_id: + description: 'Example: 21000' + type: integer + repo_name: + description: 'Example: rails' type: string type: array tags: - - experimental - /repo-groups/:repo_group_id/pull-requests-closed-no-merge: + - evolution + /repo-groups/:repo_group_id/issues-open-age: get: - description: Timeseries of pull request which were closed but not merged - operationId: Pull Request Closed but Not Merged (Repo) + description: 'Age of open issues. ' + externalDocs: + description: CHAOSS Metric Definition + url: https://github.com/chaoss/wg-evolution/blob/master/metrics/issues-open-age.md + operationId: Open Issue Age (Repo Group) parameters: - - description: Repository Group ID. + - description: Repository Group ID in: path name: repo_group_id schema: type: string type: string - - description: 'Beginning date specification. E.g. values: 2018, 2018-05, 2019-05-01' - in: path - name: begin_date - schema: - type: string - type: string - - description: 'Ending date specification. E.g. values: 2018, 2018-05, 2019-05-01' - in: path - name: end_date - schema: - type: string - type: string responses: '200': description: OK @@ -2127,14 +2493,23 @@ paths: items: properties: date: - description: 'Example: 2019-01-01T00:00:00.000Z' + description: 'Example: 2009-05-15T19:48:43.000Z' type: string - pr_count: - description: 'Example: 3' + issue_id: + description: 'Example: 38318' + type: integer + open_date: + description: 'Example: 3696' + type: integer + repo_id: + description: 'Example: 21000' type: integer + repo_name: + description: 'Example: rails' + type: string type: array tags: - - experimental + - evolution /repo-groups/:repo_group_id/pull-requests-merge-contributor-new: get: description: 'Number of persons contributing with an accepted commit for the @@ -2454,181 +2829,31 @@ paths: items: properties: repo_id: - description: 'Example: 21364' - type: integer - repo_name: - description: 'Example: irs_process_scripts' - type: string - stars: - description: 'Example: 20' - type: integer - type: array - tags: - - value - /repo-groups/:repo_group_id/sub-projects: - get: - description: 'Number of sub-projects. ' - externalDocs: - description: CHAOSS Metric Definition - url: https://github.com/chaoss/wg-evolution/blob/master/metrics/sub-projects.md - operationId: Sub-Projects (Repo Group) - parameters: - - description: Repository Group ID - in: path - name: repo_group_id - schema: - type: string - type: string - - description: 'Beginning date specification. E.g. values: 2018, 2018-05, 2019-05-01' - in: path - name: begin_date - schema: - type: string - type: string - - description: 'Ending date specification. E.g. values: 2018, 2018-05, 2019-05-01' - in: path - name: end_date - schema: - type: string - type: string - responses: - '200': - description: OK - schema: - items: - properties: - sub_protject_count: - description: 'Example: 2' - type: integer - type: array - tags: - - evolution - /repo-groups/:repo_group_id/top-committers: - get: - description: Returns a list of contributors contributing N% of all commits. - operationId: Top Committers (Repo Group) - parameters: - - description: Repository Group ID - in: path - name: repo_group_id - schema: - type: string - type: string - - description: 'Specify the year to return the results for. Default value: current - year' - in: path - name: year - schema: - type: string - type: string - - description: Specify N%. Accepts a value between 0 & 1 where 0 specifies - 0% and 1 specifies 100%. - in: path - name: threshold - schema: - type: string - type: string - responses: - '200': - description: OK - schema: - items: - properties: - commits: - description: 'Example: 502' - type: integer - email: - description: 'Example: kamipo@gmail.com' - type: string - repo_group_id: - description: 'Example: 20' - type: integer - repo_group_name: - description: 'Example: Rails' - type: string - type: array - tags: - - experimental - /repo-groups/:repo_group_id/watchers: - get: - description: A time series of watchers count. - operationId: Watchers (Repo Group) - parameters: - - description: Repository Group ID - in: path - name: repo_group_id - schema: - type: string - type: string - responses: - '200': - description: OK - schema: - items: - properties: - date: - description: 'Example: 2019-07-03T23:26:42.000Z' - type: string - repo_id: - description: 'Example: 21036' - type: integer - repo_name: - description: 'Example: jquery-ujs' - type: string - watchers: - description: 'Example: 60' - type: integer - type: array - tags: - - value - /repo-groups/:repo_group_id/watchers-count: - get: - description: Watchers count. - operationId: Watchers Count (Repo Group) - parameters: - - description: Repository Group ID - in: path - name: repo_group_id - schema: - type: string - type: string - responses: - '200': - description: OK - schema: - items: - properties: - repo_id: - description: 'Example: 21039' + description: 'Example: 21364' type: integer repo_name: - description: 'Example: rails_xss' + description: 'Example: irs_process_scripts' type: string - watchers: + stars: description: 'Example: 20' type: integer type: array tags: - value - /repos/:repo_id/aggregate-summary: + /repo-groups/:repo_group_id/sub-projects: get: - description: Returns the current count of watchers, stars, and forks and the - counts of all commits, committers, and pull requests merged between a given - beginning and end date (default between now and 365 days ago). - operationId: Aggregate Summary (Repo) + description: 'Number of sub-projects. ' + externalDocs: + description: CHAOSS Metric Definition + url: https://github.com/chaoss/wg-evolution/blob/master/metrics/sub-projects.md + operationId: Sub-Projects (Repo Group) parameters: - - description: Repository Group ID. + - description: Repository Group ID in: path name: repo_group_id schema: type: string type: string - - description: Repository ID. - in: path - name: repo_id - schema: - type: string - type: string - description: 'Beginning date specification. E.g. values: 2018, 2018-05, 2019-05-01' in: path name: begin_date @@ -2647,27 +2872,12 @@ paths: schema: items: properties: - commit_count: - description: 'Example: 133' - type: integer - committer_count: - description: 'Example: 5' - type: integer - fork_count: - description: 'Example: 449' - type: integer - merged_count: - description: 'Example: 0' - type: integer - star_count: - description: 'Example: 581' - type: integer - watcher_count: - description: 'Example: 83' + sub_protject_count: + description: 'Example: 2' type: integer type: array tags: - - experimental + - evolution /repos/:repo_id/closed-issues-count: get: description: 'Count of closed issues. ' @@ -2995,79 +3205,6 @@ paths: type: array tags: - evolution - /repos/:repo_id/issue-comments-mean: - get: - description: Mean(Average) of issue comments per day. - operationId: Issue Comments Mean (Repo) - parameters: - - description: Repository Group ID. - in: path - name: repo_group_id - schema: - type: string - type: string - - description: Repository ID. - in: path - name: repo_id - schema: - type: string - type: string - responses: - '200': - description: OK - schema: - items: - properties: - date: - description: 'Example: 2018-01-01T00:00:00.000Z' - type: string - mean: - description: 'Example: 0.6191780822' - type: string - repo_id: - description: 'Example: 21326' - type: integer - type: array - tags: - - experimental - /repos/:repo_id/issue-comments-mean-std: - get: - description: Mean(Average) and Standard Deviation of issue comments per day. - operationId: Issue Comments Mean Std (Repo) - parameters: - - description: Repository Group ID. - in: path - name: repo_group_id - schema: - type: string - type: string - - description: Repository ID. - in: path - name: repo_id - schema: - type: string - type: string - responses: - '200': - description: OK - schema: - items: - properties: - average: - description: 'Example: 2.5' - type: string - date: - description: 'Example: 2011-01-01T00:00:00.000Z' - type: string - repo_id: - description: 'Example: 21000' - type: integer - standard_deviation: - description: 'Example: 1.7159383568' - type: string - type: array - tags: - - experimental /repos/:repo_id/issue-participants: get: description: 'How many persons participated in the discussion of issues. ' @@ -3581,91 +3718,6 @@ paths: type: array tags: - evolution - /repos/:repo_id/pull-request-acceptance-rate: - get: - description: Timeseries of pull request acceptance rate (expressed as the ratio - of pull requests merged on a date to the count of pull requests opened on - a date) - operationId: Pull Request Acceptance Rate (Repo) - parameters: - - description: Repository Group ID. - in: path - name: repo_group_id - schema: - type: string - type: string - - description: Repository ID. - in: path - name: repo_id - schema: - type: string - type: string - - description: 'Beginning date specification. E.g. values: 2018, 2018-05, 2019-05-01' - in: path - name: begin_date - schema: - type: string - type: string - - description: 'Ending date specification. E.g. values: 2018, 2018-05, 2019-05-01' - in: path - name: end_date - schema: - type: string - type: string - responses: - '200': - description: OK - schema: - items: - properties: - date: - description: 'Example: 2019-01-01T00:00:00.000Z' - type: string - rate: - description: 'Example: 5.3333333333' - type: string - type: array - tags: - - experimental - /repos/:repo_id/pull-requests-closed-no-merge: - get: - description: '' - operationId: Pull Request Closed but Not Merged (Repo) - parameters: - - description: Repository ID. - in: path - name: repo_id - schema: - type: string - type: string - - description: 'Beginning date specification. E.g. values: 2018, 2018-05, 2019-05-01' - in: path - name: begin_date - schema: - type: string - type: string - - description: 'Ending date specification. E.g. values: 2018, 2018-05, 2019-05-01 - ___' - in: path - name: end_date - schema: - type: string - type: string - responses: - '200': - description: OK - schema: - items: - properties: - date: - description: 'Example: 2019-01-01T00:00:00.000Z' - type: string - pr_count: - description: 'Example: 3' - type: integer - type: array - tags: - - experimental /repos/:repo_id/pull-requests-merge-contributor-new: get: description: 'Number of persons contributing with an accepted commit for the @@ -4102,58 +4154,6 @@ paths: type: array tags: - evolution - /repos/:repo_id/top-committers: - get: - description: Returns a list of contributors contributing N% of all commits. - operationId: Top Committers (Repo) - parameters: - - description: Repository Group ID. - in: path - name: repo_group_id - schema: - type: string - type: string - - description: Repository ID. - in: path - name: repo_id - schema: - type: string - type: string - - description: 'Specify the year to return the results for. Default value: current - year' - in: path - name: year - schema: - type: string - type: string - - description: Specify N%. Accepts a value between 0 & 1 where 0 specifies - 0% and 1 specifies 100%. - in: path - name: threshold - schema: - type: string - type: string - responses: - '200': - description: OK - schema: - items: - properties: - commits: - description: 'Example: 4' - type: integer - email: - description: 'Example: caniszczyk@gmail.com' - type: string - repo_id: - description: 'Example: 21334' - type: integer - repo_name: - description: 'Example: graphql' - type: string - type: array - tags: - - experimental /repos/:repo_id/watchers: get: description: A time series of watchers count. From f8f3ac222df077b416ebbdd2a9d1d3974789dd8d Mon Sep 17 00:00:00 2001 From: Andrew Brain <61482022+ABrain7710@users.noreply.github.com> Date: Thu, 19 Aug 2021 12:37:15 -0500 Subject: [PATCH 05/17] Organize value endpoint docs Signed-off-by: Andrew Brain <61482022+ABrain7710@users.noreply.github.com> --- docs/source/rest-api/spec.yml | 300 +++++++++++++++++----------------- 1 file changed, 150 insertions(+), 150 deletions(-) diff --git a/docs/source/rest-api/spec.yml b/docs/source/rest-api/spec.yml index 411f084984..2603cf3a7f 100644 --- a/docs/source/rest-api/spec.yml +++ b/docs/source/rest-api/spec.yml @@ -1628,67 +1628,6 @@ paths: type: array tags: - evolution - /repo-groups/:repo_group_id/watchers: - get: - description: A time series of watchers count. - operationId: Watchers (Repo Group) - parameters: - - description: Repository Group ID - in: path - name: repo_group_id - schema: - type: string - type: string - responses: - '200': - description: OK - schema: - items: - properties: - date: - description: 'Example: 2019-07-03T23:26:42.000Z' - type: string - repo_id: - description: 'Example: 21036' - type: integer - repo_name: - description: 'Example: jquery-ujs' - type: string - watchers: - description: 'Example: 60' - type: integer - type: array - tags: - - value - /repo-groups/:repo_group_id/watchers-count: - get: - description: Watchers count. - operationId: Watchers Count (Repo Group) - parameters: - - description: Repository Group ID - in: path - name: repo_group_id - schema: - type: string - type: string - responses: - '200': - description: OK - schema: - items: - properties: - repo_id: - description: 'Example: 21039' - type: integer - repo_name: - description: 'Example: rails_xss' - type: string - watchers: - description: 'Example: 20' - type: integer - type: array - tags: - - value /repo-groups/:repo_group_id/closed-issues-count: get: description: 'Count of closed issues. ' @@ -2779,67 +2718,6 @@ paths: type: array tags: - evolution - /repo-groups/:repo_group_id/stars: - get: - description: A time series of stars count. - operationId: Stars (Repo Group) - parameters: - - description: Repository Group ID - in: path - name: repo_group_id - schema: - type: string - type: string - responses: - '200': - description: OK - schema: - items: - properties: - date: - description: 'Example: 2019-07-03T23:23:36.000Z' - type: string - repo_id: - description: 'Example: 21491' - type: integer - repo_name: - description: 'Example: commons-io' - type: string - stars: - description: 'Example: 600' - type: integer - type: array - tags: - - value - /repo-groups/:repo_group_id/stars-count: - get: - description: Stars count. - operationId: Stars Count (Repo Group) - parameters: - - description: Repository Group ID - in: path - name: repo_group_id - schema: - type: string - type: string - responses: - '200': - description: OK - schema: - items: - properties: - repo_id: - description: 'Example: 21364' - type: integer - repo_name: - description: 'Example: irs_process_scripts' - type: string - stars: - description: 'Example: 20' - type: integer - type: array - tags: - - value /repo-groups/:repo_group_id/sub-projects: get: description: 'Number of sub-projects. ' @@ -4043,10 +3921,13 @@ paths: type: array tags: - evolution - /repos/:repo_id/stars: + /repos/:repo_id/sub-projects: get: - description: A time series of stars count. - operationId: Stars (Repo) + description: 'Number of sub-projects. ' + externalDocs: + description: CHAOSS Metric Definition + url: https://github.com/chaoss/wg-evolution/blob/master/metrics/sub-projects.md + operationId: Sub-Projects (Repo) parameters: - description: Repository Group ID. in: path @@ -4060,6 +3941,41 @@ paths: schema: type: string type: string + - description: 'Beginning date specification. E.g. values: 2018, 2018-05, 2019-05-01' + in: path + name: begin_date + schema: + type: string + type: string + - description: 'Ending date specification. E.g. values: 2018, 2018-05, 2019-05-01' + in: path + name: end_date + schema: + type: string + type: string + responses: + '200': + description: OK + schema: + items: + properties: + sub_protject_count: + description: 'Example: 2' + type: integer + type: array + tags: + - evolution + /repo-groups/:repo_group_id/watchers: + get: + description: A time series of watchers count. + operationId: Watchers (Repo Group) + parameters: + - description: Repository Group ID + in: path + name: repo_group_id + schema: + type: string + type: string responses: '200': description: OK @@ -4067,31 +3983,57 @@ paths: items: properties: date: - description: 'Example: 2019-07-03T23:27:42.000Z' + description: 'Example: 2019-07-03T23:26:42.000Z' type: string + repo_id: + description: 'Example: 21036' + type: integer repo_name: - description: 'Example: graphiql' + description: 'Example: jquery-ujs' type: string - stars: - description: 'Example: 8652' + watchers: + description: 'Example: 60' type: integer type: array tags: - value - /repos/:repo_id/stars-count: + /repo-groups/:repo_group_id/watchers-count: get: - description: Stars count. - operationId: Stars Count (Repo) + description: Watchers count. + operationId: Watchers Count (Repo Group) parameters: - - description: Repository Group ID. + - description: Repository Group ID in: path name: repo_group_id schema: type: string type: string - - description: Repository ID. + responses: + '200': + description: OK + schema: + items: + properties: + repo_id: + description: 'Example: 21039' + type: integer + repo_name: + description: 'Example: rails_xss' + type: string + watchers: + description: 'Example: 20' + type: integer + type: array + tags: + - value + /repo-groups/:repo_group_id/stars: + get: + description: A time series of stars count. + operationId: Stars (Repo Group) + parameters: + - description: Repository Group ID in: path - name: repo_id + name: repo_group_id schema: type: string type: string @@ -4101,22 +4043,54 @@ paths: schema: items: properties: + date: + description: 'Example: 2019-07-03T23:23:36.000Z' + type: string + repo_id: + description: 'Example: 21491' + type: integer repo_name: - description: 'Example: graphiql' + description: 'Example: commons-io' type: string stars: - description: 'Example: 8653' + description: 'Example: 600' type: integer type: array tags: - value - /repos/:repo_id/sub-projects: + /repo-groups/:repo_group_id/stars-count: get: - description: 'Number of sub-projects. ' - externalDocs: - description: CHAOSS Metric Definition - url: https://github.com/chaoss/wg-evolution/blob/master/metrics/sub-projects.md - operationId: Sub-Projects (Repo) + description: Stars count. + operationId: Stars Count (Repo Group) + parameters: + - description: Repository Group ID + in: path + name: repo_group_id + schema: + type: string + type: string + responses: + '200': + description: OK + schema: + items: + properties: + repo_id: + description: 'Example: 21364' + type: integer + repo_name: + description: 'Example: irs_process_scripts' + type: string + stars: + description: 'Example: 20' + type: integer + type: array + tags: + - value + /repos/:repo_id/stars: + get: + description: A time series of stars count. + operationId: Stars (Repo) parameters: - description: Repository Group ID. in: path @@ -4130,15 +4104,38 @@ paths: schema: type: string type: string - - description: 'Beginning date specification. E.g. values: 2018, 2018-05, 2019-05-01' + responses: + '200': + description: OK + schema: + items: + properties: + date: + description: 'Example: 2019-07-03T23:27:42.000Z' + type: string + repo_name: + description: 'Example: graphiql' + type: string + stars: + description: 'Example: 8652' + type: integer + type: array + tags: + - value + /repos/:repo_id/stars-count: + get: + description: Stars count. + operationId: Stars Count (Repo) + parameters: + - description: Repository Group ID. in: path - name: begin_date + name: repo_group_id schema: type: string type: string - - description: 'Ending date specification. E.g. values: 2018, 2018-05, 2019-05-01' + - description: Repository ID. in: path - name: end_date + name: repo_id schema: type: string type: string @@ -4148,12 +4145,15 @@ paths: schema: items: properties: - sub_protject_count: - description: 'Example: 2' + repo_name: + description: 'Example: graphiql' + type: string + stars: + description: 'Example: 8653' type: integer type: array tags: - - evolution + - value /repos/:repo_id/watchers: get: description: A time series of watchers count. From 319e8c533db34c78bf64a03cd86bb8ecdf2be0e0 Mon Sep 17 00:00:00 2001 From: Andrew Brain <61482022+ABrain7710@users.noreply.github.com> Date: Thu, 19 Aug 2021 13:05:58 -0500 Subject: [PATCH 06/17] Reorder risk endpoint docs Signed-off-by: Andrew Brain <61482022+ABrain7710@users.noreply.github.com> --- docs/source/rest-api/spec.yml | 460 +++++++++++++++++----------------- 1 file changed, 230 insertions(+), 230 deletions(-) diff --git a/docs/source/rest-api/spec.yml b/docs/source/rest-api/spec.yml index 2603cf3a7f..6e37ae9a0d 100644 --- a/docs/source/rest-api/spec.yml +++ b/docs/source/rest-api/spec.yml @@ -235,13 +235,13 @@ paths: type: array tags: - utility - /repo-groups/:repo_group_id/committers: + /repo-groups/:repo_group_id/average-issue-resolution-time: get: - description: 'Number of persons opening an issue for the first time. ' + description: 'The average issue resolution time. ' externalDocs: description: CHAOSS Metric Definition - url: https://github.com/chaoss/wg-risk/blob/master/metrics/Committers.md - operationId: Committers (Repo Group) + url: https://github.com/chaoss/wg-risk/blob/master/focus-areas/business-risk.md + operationId: Average Issue Resolution Time (Repo Group) parameters: - description: Repository Group ID in: path @@ -249,56 +249,44 @@ paths: schema: type: string type: string - - description: Periodicity specification. - in: path - name: period - schema: - type: string - type: string - - description: 'Beginning date specification. E.g. values: 2018, 2018-05, 2019-05-01' - in: path - name: begin_date - schema: - type: string - type: string - - description: 'Ending date specification. E.g. values: 2018, 2018-05, 2019-05-01' - in: path - name: end_date - schema: - type: string - type: string responses: '200': description: OK schema: items: properties: - count: - description: 'Example: 372' - type: integer - date: - description: 'Example: 2007-01-01T00:00:00.000Z' + avg_issue_resolution_time: + description: 'Example: 1413 days 15:39:48' type: string - rg_name: - description: 'Example: Comcast' + repo_id: + description: 'Example: 21353' + type: integer + repo_name: + description: 'Example: open_id_authentication' type: string type: array tags: - risk - /repo-groups/:repo_group_id/average-issue-resolution-time: + /repos/:repo_id/average-issue-resolution-time: get: description: 'The average issue resolution time. ' externalDocs: description: CHAOSS Metric Definition url: https://github.com/chaoss/wg-risk/blob/master/focus-areas/business-risk.md - operationId: Average Issue Resolution Time (Repo Group) + operationId: Average Issue Resolution Time (Repo) parameters: - - description: Repository Group ID + - description: Repository Group ID. in: path name: repo_group_id schema: type: string type: string + - description: Repository ID. + in: path + name: repo_id + schema: + type: string + type: string responses: '200': description: OK @@ -306,13 +294,10 @@ paths: items: properties: avg_issue_resolution_time: - description: 'Example: 1413 days 15:39:48' + description: 'Example: 276 days 13:54:13.2' type: string - repo_id: - description: 'Example: 21353' - type: integer repo_name: - description: 'Example: open_id_authentication' + description: 'Example: maven-release' type: string type: array tags: @@ -349,45 +334,48 @@ paths: type: array tags: - risk - /repo-groups/:repo_group_id/fork-count: + /repos/:repo_id/cii-best-practices-badge: get: - description: 'Fork count. ' + description: 'The CII Best Practices Badge level. ' externalDocs: description: CHAOSS Metric Definition - url: https://github.com/chaoss/wg-risk/blob/master/focus-areas/business-risk.md - operationId: Fork Count (Repo Group) + url: https://github.com/chaoss/wg-risk/blob/master/focus-areas/security.md + operationId: CII Best Practices Badge (Repo) parameters: - - description: Repository Group ID + - description: Repository Group ID. in: path name: repo_group_id schema: type: string type: string + - description: Repository ID. + in: path + name: repo_id + schema: + type: string + type: string responses: '200': description: OK schema: items: properties: - forks: - description: 'Example: 4' - type: integer - repo_id: - description: 'Example: 21364' - type: integer + badge_level: + description: 'Example: passing' + type: string repo_name: - description: 'Example: irs_process_scripts' + description: 'Example: trickster' type: string type: array tags: - risk - /repo-groups/:repo_group_id/forks: + /repo-groups/:repo_group_id/committers: get: - description: 'A time series of fork count. ' + description: 'Number of persons opening an issue for the first time. ' externalDocs: description: CHAOSS Metric Definition - url: https://github.com/chaoss/wg-risk/blob/master/focus-areas/business-risk.md - operationId: Forks (Repo Group) + url: https://github.com/chaoss/wg-risk/blob/master/metrics/Committers.md + operationId: Committers (Repo Group) parameters: - description: Repository Group ID in: path @@ -395,64 +383,109 @@ paths: schema: type: string type: string + - description: Periodicity specification. + in: path + name: period + schema: + type: string + type: string + - description: 'Beginning date specification. E.g. values: 2018, 2018-05, 2019-05-01' + in: path + name: begin_date + schema: + type: string + type: string + - description: 'Ending date specification. E.g. values: 2018, 2018-05, 2019-05-01' + in: path + name: end_date + schema: + type: string + type: string responses: '200': description: OK schema: items: properties: + count: + description: 'Example: 372' + type: integer date: - description: 'Example: 2019-07-03T23:26:42.000Z' + description: 'Example: 2007-01-01T00:00:00.000Z' type: string - forks: - description: 'Example: 519' - type: integer - repo_id: - description: 'Example: 21036' - type: integer - repo_name: - description: 'Example: jquery-ujs' + rg_name: + description: 'Example: Comcast' type: string type: array tags: - risk - /repo-groups/:repo_group_id/languages: + /repos/:repo_id/committers: get: - description: 'The primary language of the repository. ' + description: 'Number of persons contributing with an accepted commit for the + first time. ' externalDocs: description: CHAOSS Metric Definition - url: https://github.com/chaoss/wg-risk/blob/master/focus-areas/security.md - operationId: Languages (Repo Group) + url: https://github.com/chaoss/wg-risk/blob/master/metrics/Committers.md + operationId: Committers (Repo) parameters: - - description: Repository Group ID + - description: Repository Group ID. in: path name: repo_group_id schema: type: string type: string + - description: Repository ID. + in: path + name: repo_id + schema: + type: string + type: string + - description: Periodicity specification. + in: path + name: period + schema: + type: string + type: string + - description: 'Beginning date specification. E.g. values: 2018, 2018-05, 2019-05-01' + in: path + name: begin_date + schema: + type: string + type: string + - description: 'Ending date specification. E.g. values: 2018, 2018-05, 2019-05-01' + in: path + name: end_date + schema: + type: string + type: string responses: '200': description: OK schema: items: properties: - primary_language: - description: 'Example: Go' - type: string - repo_id: - description: 'Example: 21277' + count: + description: 'Example: 1' type: integer + date: + description: 'Example: 2018-10-25T00:00:00.000Z' + type: string + repo_name: + description: 'Example: weasel' + type: string + rg_name: + description: 'Example: Comcast' + type: string type: array tags: - risk - /repo-groups/:repo_group_id/license-count: + /repo-groups/:repo_group_id/fork-count: get: - description: 'The declared software package license (fetched from CII Best Practices - badging data). ' + description: 'Fork count. ' externalDocs: description: CHAOSS Metric Definition - url: https://github.com/chaoss/wg-risk/blob/master/focus-areas/licensing.md - operationId: License Count (Repo Group) + url: https://github.com/chaoss/wg-risk/blob/master/focus-areas/business-risk.md + operationId: Fork Count (Repo Group) parameters: - description: Repository Group ID in: path @@ -466,60 +499,60 @@ paths: schema: items: properties: - file_without_licenses: - description: 'Example: True' - type: string - name: - description: 'Example: ActorServiceRegistry' - type: string - number_of_license: - description: 'Example: 2' + forks: + description: 'Example: 4' type: integer + repo_id: + description: 'Example: 21364' + type: integer + repo_name: + description: 'Example: irs_process_scripts' + type: string type: array tags: - risk - /repo-groups/:repo_group_id/license-coverage: + /repos/:repo_id/fork-count: get: - description: 'Number of persons opening an issue for the first time. ' + description: 'Fork count. ' externalDocs: description: CHAOSS Metric Definition - url: https://github.com/chaoss/wg-risk/blob/master/metrics/License_Coverage.md - operationId: License Coverage (Repo Group) + url: https://github.com/chaoss/wg-risk/blob/master/focus-areas/business-risk.md + operationId: Fork Count (Repo) parameters: - - description: Repository Group ID + - description: Repository Group ID. in: path name: repo_group_id schema: type: string type: string + - description: Repository ID. + in: path + name: repo_id + schema: + type: string + type: string responses: '200': description: OK schema: items: properties: - coverage: - description: 'Example: 0.373' - type: string - license_declared_files: - description: 'Example: 19' + forks: + description: 'Example: 844' type: integer - name: - description: 'Example: ActorServiceRegistry' + repo_name: + description: 'Example: graphiql' type: string - total_files: - description: 'Example: 51' - type: integer type: array tags: - risk - /repo-groups/:repo_group_id/license-declared: + /repo-groups/:repo_group_id/forks: get: - description: 'Number of persons opening an issue for the first time. ' + description: 'A time series of fork count. ' externalDocs: description: CHAOSS Metric Definition - url: https://github.com/chaoss/wg-risk/blob/master/metrics/License_Coverage.md - operationId: License Declared (Repo Group) + url: https://github.com/chaoss/wg-risk/blob/master/focus-areas/business-risk.md + operationId: Forks (Repo Group) parameters: - description: Repository Group ID in: path @@ -533,25 +566,28 @@ paths: schema: items: properties: - name: - description: 'Example: trickster' - type: string - note: - description: 'Example: ' + date: + description: 'Example: 2019-07-03T23:26:42.000Z' type: string - short_name: - description: 'Example: Apache-2.0' + forks: + description: 'Example: 519' + type: integer + repo_id: + description: 'Example: 21036' + type: integer + repo_name: + description: 'Example: jquery-ujs' type: string type: array tags: - risk - /repos/:repo_id/average-issue-resolution-time: + /repos/:repo_id/forks: get: - description: 'The average issue resolution time. ' + description: 'A time series of fork count. ' externalDocs: description: CHAOSS Metric Definition url: https://github.com/chaoss/wg-risk/blob/master/focus-areas/business-risk.md - operationId: Average Issue Resolution Time (Repo) + operationId: Forks (Repo) parameters: - description: Repository Group ID. in: path @@ -571,58 +607,61 @@ paths: schema: items: properties: - avg_issue_resolution_time: - description: 'Example: 276 days 13:54:13.2' + date: + description: 'Example: 2019-07-03T23:27:42.000Z' type: string + forks: + description: 'Example: 843' + type: integer repo_name: - description: 'Example: maven-release' + description: 'Example: graphiql' type: string type: array tags: - risk - /repos/:repo_id/cii-best-practices-badge: + /repo-groups/:repo_group_id/license-coverage: get: - description: 'The CII Best Practices Badge level. ' + description: 'Number of persons opening an issue for the first time. ' externalDocs: description: CHAOSS Metric Definition - url: https://github.com/chaoss/wg-risk/blob/master/focus-areas/security.md - operationId: CII Best Practices Badge (Repo) + url: https://github.com/chaoss/wg-risk/blob/master/metrics/License_Coverage.md + operationId: License Coverage (Repo Group) parameters: - - description: Repository Group ID. + - description: Repository Group ID in: path name: repo_group_id schema: type: string type: string - - description: Repository ID. - in: path - name: repo_id - schema: - type: string - type: string responses: '200': description: OK schema: items: properties: - badge_level: - description: 'Example: passing' + coverage: + description: 'Example: 0.373' type: string - repo_name: - description: 'Example: trickster' + license_declared_files: + description: 'Example: 19' + type: integer + name: + description: 'Example: ActorServiceRegistry' type: string + total_files: + description: 'Example: 51' + type: integer type: array tags: - risk - /repos/:repo_id/committers: + /repos/:repo_id/license-coverage: get: description: 'Number of persons contributing with an accepted commit for the first time. ' externalDocs: description: CHAOSS Metric Definition - url: https://github.com/chaoss/wg-risk/blob/master/metrics/Committers.md - operationId: Committers (Repo) + url: https://github.com/chaoss/wg-risk/blob/master/metrics/License_Coverage.md + operationId: License Coverage (Repo) parameters: - description: Repository Group ID. in: path @@ -636,87 +675,67 @@ paths: schema: type: string type: string - - description: Periodicity specification. - in: path - name: period - schema: - type: string - type: string - - description: 'Beginning date specification. E.g. values: 2018, 2018-05, 2019-05-01' - in: path - name: begin_date - schema: - type: string - type: string - - description: 'Ending date specification. E.g. values: 2018, 2018-05, 2019-05-01' - in: path - name: end_date - schema: - type: string - type: string responses: '200': description: OK schema: items: properties: - count: - description: 'Example: 1' - type: integer - date: - description: 'Example: 2018-10-25T00:00:00.000Z' + coverage: + description: 'Example: 0.347' type: string + license_declared_file: + description: 'Example: 33' + type: integer repo_name: - description: 'Example: weasel' - type: string - rg_name: - description: 'Example: Comcast' + description: 'Example: zucchini' type: string + total_files: + description: 'Example: 95' + type: integer type: array tags: - risk - /repos/:repo_id/fork-count: + /repo-groups/:repo_group_id/license-declared: get: - description: 'Fork count. ' + description: 'Number of persons opening an issue for the first time. ' externalDocs: description: CHAOSS Metric Definition - url: https://github.com/chaoss/wg-risk/blob/master/focus-areas/business-risk.md - operationId: Fork Count (Repo) + url: https://github.com/chaoss/wg-risk/blob/master/metrics/License_Coverage.md + operationId: License Declared (Repo Group) parameters: - - description: Repository Group ID. + - description: Repository Group ID in: path name: repo_group_id schema: type: string type: string - - description: Repository ID. - in: path - name: repo_id - schema: - type: string - type: string responses: '200': description: OK schema: items: properties: - forks: - description: 'Example: 844' - type: integer - repo_name: - description: 'Example: graphiql' + name: + description: 'Example: trickster' + type: string + note: + description: 'Example: ' + type: string + short_name: + description: 'Example: Apache-2.0' type: string type: array tags: - risk - /repos/:repo_id/forks: + /repos/:repo_id/license-declared: get: - description: 'A time series of fork count. ' + description: 'Number of persons contributing with an accepted commit for the + first time. ' externalDocs: description: CHAOSS Metric Definition - url: https://github.com/chaoss/wg-risk/blob/master/focus-areas/business-risk.md - operationId: Forks (Repo) + url: https://github.com/chaoss/wg-risk/blob/master/metrics/License_Coverage.md + operationId: License Declared (Repo) parameters: - description: Repository Group ID. in: path @@ -736,96 +755,77 @@ paths: schema: items: properties: - date: - description: 'Example: 2019-07-03T23:27:42.000Z' + name: + description: 'Example: trickster' type: string - forks: - description: 'Example: 843' - type: integer - repo_name: - description: 'Example: graphiql' + note: + description: 'Example: ' + type: string + short_name: + description: 'Example: Apache-2.0' type: string type: array tags: - risk - /repos/:repo_id/license-coverage: + /repo-groups/:repo_group_id/languages: get: - description: 'Number of persons contributing with an accepted commit for the - first time. ' + description: 'The primary language of the repository. ' externalDocs: description: CHAOSS Metric Definition - url: https://github.com/chaoss/wg-risk/blob/master/metrics/License_Coverage.md - operationId: License Coverage (Repo) + url: https://github.com/chaoss/wg-risk/blob/master/focus-areas/security.md + operationId: Languages (Repo Group) parameters: - - description: Repository Group ID. + - description: Repository Group ID in: path name: repo_group_id schema: type: string type: string - - description: Repository ID. - in: path - name: repo_id - schema: - type: string - type: string responses: '200': description: OK schema: items: properties: - coverage: - description: 'Example: 0.347' - type: string - license_declared_file: - description: 'Example: 33' - type: integer - repo_name: - description: 'Example: zucchini' + primary_language: + description: 'Example: Go' type: string - total_files: - description: 'Example: 95' + repo_id: + description: 'Example: 21277' type: integer type: array tags: - risk - /repos/:repo_id/license-declared: + /repo-groups/:repo_group_id/license-count: get: - description: 'Number of persons contributing with an accepted commit for the - first time. ' + description: 'The declared software package license (fetched from CII Best Practices + badging data). ' externalDocs: description: CHAOSS Metric Definition - url: https://github.com/chaoss/wg-risk/blob/master/metrics/License_Coverage.md - operationId: License Declared (Repo) + url: https://github.com/chaoss/wg-risk/blob/master/focus-areas/licensing.md + operationId: License Count (Repo Group) parameters: - - description: Repository Group ID. + - description: Repository Group ID in: path name: repo_group_id schema: type: string type: string - - description: Repository ID. - in: path - name: repo_id - schema: - type: string - type: string responses: '200': description: OK schema: items: properties: - name: - description: 'Example: trickster' - type: string - note: - description: 'Example: ' + file_without_licenses: + description: 'Example: True' type: string - short_name: - description: 'Example: Apache-2.0' + name: + description: 'Example: ActorServiceRegistry' type: string + number_of_license: + description: 'Example: 2' + type: integer type: array tags: - risk From 7cce809f9c8ab852e938bd43608baf01ff6bcfc7 Mon Sep 17 00:00:00 2001 From: Andrew Brain <61482022+ABrain7710@users.noreply.github.com> Date: Thu, 19 Aug 2021 13:12:55 -0500 Subject: [PATCH 07/17] Reorder experimental endpoint docs Signed-off-by: Andrew Brain <61482022+ABrain7710@users.noreply.github.com> --- docs/source/rest-api/spec.yml | 406 +++++++++++++++++----------------- 1 file changed, 203 insertions(+), 203 deletions(-) diff --git a/docs/source/rest-api/spec.yml b/docs/source/rest-api/spec.yml index 6e37ae9a0d..a24d16410f 100644 --- a/docs/source/rest-api/spec.yml +++ b/docs/source/rest-api/spec.yml @@ -829,20 +829,28 @@ paths: type: array tags: - risk - /repo-groups/:repo_group_id/abandoned-issues: + /repo-groups/:repo_group_id/aggregate-summary: get: - description: List of abandoned issues (last updated >= 1 year ago) - operationId: Abandoned Issues (Repo) + description: Returns the current count of watchers, stars, and forks and the + counts of all commits, committers, and pull requests merged between a given + beginning and end date (default between now and 365 days ago). + operationId: Aggregate Summary (Repo Group) parameters: - - description: Repository Group ID + - description: Repository Group ID. in: path name: repo_group_id schema: type: string type: string - - description: Repository ID. + - description: 'Beginning date specification. E.g. values: 2018, 2018-05, 2019-05-01' in: path - name: repo_id + name: begin_date + schema: + type: string + type: string + - description: 'Ending date specification. E.g. values: 2018, 2018-05, 2019-05-01' + in: path + name: end_date schema: type: string type: string @@ -852,24 +860,33 @@ paths: schema: items: properties: - issue_id: - description: 'Example: 125071' + commit_count: + description: 'Example: 7890143' type: integer - repo_id: - description: 'Example: 22004' + committer_count: + description: 'Example: 8553' + type: integer + fork_count: + description: 'Example: 226841' + type: integer + merged_count: + description: 'Example: 3883' + type: integer + star_count: + description: 'Example: 460447' + type: integer + watcher_count: + description: 'Example: 69106' type: integer - updated_at: - description: 'Example: 2017-10-30T06:52:19.000Z' - type: string type: array tags: - experimental - /repo-groups/:repo_group_id/aggregate-summary: + /repos/:repo_id/aggregate-summary: get: description: Returns the current count of watchers, stars, and forks and the counts of all commits, committers, and pull requests merged between a given beginning and end date (default between now and 365 days ago). - operationId: Aggregate Summary (Repo Group) + operationId: Aggregate Summary (Repo) parameters: - description: Repository Group ID. in: path @@ -877,6 +894,12 @@ paths: schema: type: string type: string + - description: Repository ID. + in: path + name: repo_id + schema: + type: string + type: string - description: 'Beginning date specification. E.g. values: 2018, 2018-05, 2019-05-01' in: path name: begin_date @@ -896,22 +919,22 @@ paths: items: properties: commit_count: - description: 'Example: 7890143' + description: 'Example: 133' type: integer committer_count: - description: 'Example: 8553' + description: 'Example: 5' type: integer fork_count: - description: 'Example: 226841' + description: 'Example: 449' type: integer merged_count: - description: 'Example: 3883' + description: 'Example: 0' type: integer star_count: - description: 'Example: 460447' + description: 'Example: 581' type: integer watcher_count: - description: 'Example: 69106' + description: 'Example: 83' type: integer type: array tags: @@ -1114,6 +1137,41 @@ paths: type: array tags: - experimental + /repos/:repo_id/issue-comments-mean: + get: + description: Mean(Average) of issue comments per day. + operationId: Issue Comments Mean (Repo) + parameters: + - description: Repository Group ID. + in: path + name: repo_group_id + schema: + type: string + type: string + - description: Repository ID. + in: path + name: repo_id + schema: + type: string + type: string + responses: + '200': + description: OK + schema: + items: + properties: + date: + description: 'Example: 2018-01-01T00:00:00.000Z' + type: string + mean: + description: 'Example: 0.6191780822' + type: string + repo_id: + description: 'Example: 21326' + type: integer + type: array + tags: + - experimental /repo-groups/:repo_group_id/issue-comments-mean-std: get: description: Mean(Average) and Standard Deviation of issue comments per day. @@ -1150,15 +1208,12 @@ paths: type: array tags: - experimental - /repo-groups/:repo_group_id/lines-changed-by-author: + /repos/:repo_id/issue-comments-mean-std: get: - description: 'Count of closed issues. ' - externalDocs: - description: CHAOSS Metric Definition - url: https://github.com/chaoss/wg-evolution/blob/master/metrics/contributors-new.md - operationId: Lines Changed by Author (Repo) + description: Mean(Average) and Standard Deviation of issue comments per day. + operationId: Issue Comments Mean Std (Repo) parameters: - - description: Repository Group ID + - description: Repository Group ID. in: path name: repo_group_id schema: @@ -1176,24 +1231,18 @@ paths: schema: items: properties: - additions: - description: 'Example: 25611' - type: integer - affiliation: - description: 'Example: NULL' - type: string - cmt_author_date: - description: 'Example: 2004-11-24' + average: + description: 'Example: 2.5' type: string - cmt_author_email: - description: 'Example: david@loudthinking.com' + date: + description: 'Example: 2011-01-01T00:00:00.000Z' type: string - deletions: - description: 'Example: 296' - type: integer - whitespace: - description: 'Example: 5279' + repo_id: + description: 'Example: 21000' type: integer + standard_deviation: + description: 'Example: 1.7159383568' + type: string type: array tags: - experimental @@ -1244,10 +1293,12 @@ paths: type: array tags: - experimental - /repo-groups/:repo_group_id/pull-requests-closed-no-merge: + /repos/:repo_id/pull-request-acceptance-rate: get: - description: Timeseries of pull request which were closed but not merged - operationId: Pull Request Closed but Not Merged (Repo) + description: Timeseries of pull request acceptance rate (expressed as the ratio + of pull requests merged on a date to the count of pull requests opened on + a date) + operationId: Pull Request Acceptance Rate (Repo) parameters: - description: Repository Group ID. in: path @@ -1255,6 +1306,12 @@ paths: schema: type: string type: string + - description: Repository ID. + in: path + name: repo_id + schema: + type: string + type: string - description: 'Beginning date specification. E.g. values: 2018, 2018-05, 2019-05-01' in: path name: begin_date @@ -1276,34 +1333,32 @@ paths: date: description: 'Example: 2019-01-01T00:00:00.000Z' type: string - pr_count: - description: 'Example: 3' - type: integer + rate: + description: 'Example: 5.3333333333' + type: string type: array tags: - experimental - /repo-groups/:repo_group_id/top-committers: + /repo-groups/:repo_group_id/pull-requests-closed-no-merge: get: - description: Returns a list of contributors contributing N% of all commits. - operationId: Top Committers (Repo Group) + description: Timeseries of pull request which were closed but not merged + operationId: Pull Request Closed but Not Merged (Repo) parameters: - - description: Repository Group ID + - description: Repository Group ID. in: path name: repo_group_id schema: type: string type: string - - description: 'Specify the year to return the results for. Default value: current - year' + - description: 'Beginning date specification. E.g. values: 2018, 2018-05, 2019-05-01' in: path - name: year + name: begin_date schema: type: string type: string - - description: Specify N%. Accepts a value between 0 & 1 where 0 specifies - 0% and 1 specifies 100%. + - description: 'Ending date specification. E.g. values: 2018, 2018-05, 2019-05-01' in: path - name: threshold + name: end_date schema: type: string type: string @@ -1313,34 +1368,20 @@ paths: schema: items: properties: - commits: - description: 'Example: 502' - type: integer - email: - description: 'Example: kamipo@gmail.com' + date: + description: 'Example: 2019-01-01T00:00:00.000Z' type: string - repo_group_id: - description: 'Example: 20' + pr_count: + description: 'Example: 3' type: integer - repo_group_name: - description: 'Example: Rails' - type: string type: array tags: - experimental - /repos/:repo_id/aggregate-summary: + /repos/:repo_id/pull-requests-closed-no-merge: get: - description: Returns the current count of watchers, stars, and forks and the - counts of all commits, committers, and pull requests merged between a given - beginning and end date (default between now and 365 days ago). - operationId: Aggregate Summary (Repo) + description: '' + operationId: Pull Request Closed but Not Merged (Repo) parameters: - - description: Repository Group ID. - in: path - name: repo_group_id - schema: - type: string - type: string - description: Repository ID. in: path name: repo_id @@ -1353,7 +1394,8 @@ paths: schema: type: string type: string - - description: 'Ending date specification. E.g. values: 2018, 2018-05, 2019-05-01' + - description: 'Ending date specification. E.g. values: 2018, 2018-05, 2019-05-01 + ___' in: path name: end_date schema: @@ -1365,76 +1407,37 @@ paths: schema: items: properties: - commit_count: - description: 'Example: 133' - type: integer - committer_count: - description: 'Example: 5' - type: integer - fork_count: - description: 'Example: 449' - type: integer - merged_count: - description: 'Example: 0' - type: integer - star_count: - description: 'Example: 581' - type: integer - watcher_count: - description: 'Example: 83' + date: + description: 'Example: 2019-01-01T00:00:00.000Z' + type: string + pr_count: + description: 'Example: 3' type: integer type: array tags: - experimental - /repos/:repo_id/issue-comments-mean: + /repo-groups/:repo_group_id/top-committers: get: - description: Mean(Average) of issue comments per day. - operationId: Issue Comments Mean (Repo) + description: Returns a list of contributors contributing N% of all commits. + operationId: Top Committers (Repo Group) parameters: - - description: Repository Group ID. + - description: Repository Group ID in: path name: repo_group_id schema: type: string type: string - - description: Repository ID. - in: path - name: repo_id - schema: - type: string - type: string - responses: - '200': - description: OK - schema: - items: - properties: - date: - description: 'Example: 2018-01-01T00:00:00.000Z' - type: string - mean: - description: 'Example: 0.6191780822' - type: string - repo_id: - description: 'Example: 21326' - type: integer - type: array - tags: - - experimental - /repos/:repo_id/issue-comments-mean-std: - get: - description: Mean(Average) and Standard Deviation of issue comments per day. - operationId: Issue Comments Mean Std (Repo) - parameters: - - description: Repository Group ID. + - description: 'Specify the year to return the results for. Default value: current + year' in: path - name: repo_group_id + name: year schema: type: string type: string - - description: Repository ID. + - description: Specify N%. Accepts a value between 0 & 1 where 0 specifies + 0% and 1 specifies 100%. in: path - name: repo_id + name: threshold schema: type: string type: string @@ -1444,27 +1447,25 @@ paths: schema: items: properties: - average: - description: 'Example: 2.5' - type: string - date: - description: 'Example: 2011-01-01T00:00:00.000Z' + commits: + description: 'Example: 502' + type: integer + email: + description: 'Example: kamipo@gmail.com' type: string - repo_id: - description: 'Example: 21000' + repo_group_id: + description: 'Example: 20' type: integer - standard_deviation: - description: 'Example: 1.7159383568' + repo_group_name: + description: 'Example: Rails' type: string type: array tags: - experimental - /repos/:repo_id/pull-request-acceptance-rate: + /repos/:repo_id/top-committers: get: - description: Timeseries of pull request acceptance rate (expressed as the ratio - of pull requests merged on a date to the count of pull requests opened on - a date) - operationId: Pull Request Acceptance Rate (Repo) + description: Returns a list of contributors contributing N% of all commits. + operationId: Top Committers (Repo) parameters: - description: Repository Group ID. in: path @@ -1478,15 +1479,17 @@ paths: schema: type: string type: string - - description: 'Beginning date specification. E.g. values: 2018, 2018-05, 2019-05-01' + - description: 'Specify the year to return the results for. Default value: current + year' in: path - name: begin_date + name: year schema: type: string type: string - - description: 'Ending date specification. E.g. values: 2018, 2018-05, 2019-05-01' + - description: Specify N%. Accepts a value between 0 & 1 where 0 specifies + 0% and 1 specifies 100%. in: path - name: end_date + name: threshold schema: type: string type: string @@ -1496,36 +1499,35 @@ paths: schema: items: properties: - date: - description: 'Example: 2019-01-01T00:00:00.000Z' + commits: + description: 'Example: 4' + type: integer + email: + description: 'Example: caniszczyk@gmail.com' type: string - rate: - description: 'Example: 5.3333333333' + repo_id: + description: 'Example: 21334' + type: integer + repo_name: + description: 'Example: graphql' type: string type: array tags: - experimental - /repos/:repo_id/pull-requests-closed-no-merge: + /repo-groups/:repo_group_id/abandoned-issues: get: - description: '' - operationId: Pull Request Closed but Not Merged (Repo) + description: List of abandoned issues (last updated >= 1 year ago) + operationId: Abandoned Issues (Repo) parameters: - - description: Repository ID. - in: path - name: repo_id - schema: - type: string - type: string - - description: 'Beginning date specification. E.g. values: 2018, 2018-05, 2019-05-01' + - description: Repository Group ID in: path - name: begin_date + name: repo_group_id schema: type: string type: string - - description: 'Ending date specification. E.g. values: 2018, 2018-05, 2019-05-01 - ___' + - description: Repository ID. in: path - name: end_date + name: repo_id schema: type: string type: string @@ -1535,21 +1537,27 @@ paths: schema: items: properties: - date: - description: 'Example: 2019-01-01T00:00:00.000Z' - type: string - pr_count: - description: 'Example: 3' + issue_id: + description: 'Example: 125071' + type: integer + repo_id: + description: 'Example: 22004' type: integer + updated_at: + description: 'Example: 2017-10-30T06:52:19.000Z' + type: string type: array tags: - experimental - /repos/:repo_id/top-committers: + /repo-groups/:repo_group_id/lines-changed-by-author: get: - description: Returns a list of contributors contributing N% of all commits. - operationId: Top Committers (Repo) + description: 'Count of closed issues. ' + externalDocs: + description: CHAOSS Metric Definition + url: https://github.com/chaoss/wg-evolution/blob/master/metrics/contributors-new.md + operationId: Lines Changed by Author (Repo) parameters: - - description: Repository Group ID. + - description: Repository Group ID in: path name: repo_group_id schema: @@ -1561,38 +1569,30 @@ paths: schema: type: string type: string - - description: 'Specify the year to return the results for. Default value: current - year' - in: path - name: year - schema: - type: string - type: string - - description: Specify N%. Accepts a value between 0 & 1 where 0 specifies - 0% and 1 specifies 100%. - in: path - name: threshold - schema: - type: string - type: string responses: '200': description: OK schema: items: properties: - commits: - description: 'Example: 4' + additions: + description: 'Example: 25611' type: integer - email: - description: 'Example: caniszczyk@gmail.com' + affiliation: + description: 'Example: NULL' type: string - repo_id: - description: 'Example: 21334' - type: integer - repo_name: - description: 'Example: graphql' + cmt_author_date: + description: 'Example: 2004-11-24' + type: string + cmt_author_email: + description: 'Example: david@loudthinking.com' type: string + deletions: + description: 'Example: 296' + type: integer + whitespace: + description: 'Example: 5279' + type: integer type: array tags: - experimental From 2fa86588961285b8fbba06a914b11447634370fe Mon Sep 17 00:00:00 2001 From: Andrew Brain <61482022+ABrain7710@users.noreply.github.com> Date: Thu, 19 Aug 2021 13:30:07 -0500 Subject: [PATCH 08/17] Reorder evolution endpoints Signed-off-by: Andrew Brain <61482022+ABrain7710@users.noreply.github.com> --- docs/source/rest-api/spec.yml | 1514 ++++++++++++++++----------------- 1 file changed, 757 insertions(+), 757 deletions(-) diff --git a/docs/source/rest-api/spec.yml b/docs/source/rest-api/spec.yml index a24d16410f..a505854a8a 100644 --- a/docs/source/rest-api/spec.yml +++ b/docs/source/rest-api/spec.yml @@ -1596,13 +1596,13 @@ paths: type: array tags: - experimental - /repo-groups/:repo_group_id/open-issues-count: + /repo-groups/:repo_group_id/code-changes: get: - description: 'Count of open issues. ' + description: 'Time series of number of commits during a certain period. ' externalDocs: description: CHAOSS Metric Definition - url: https://github.com/chaoss/wg-evolution/blob/master/metrics/Issues_New.md - operationId: Open Issues Count (Repo Group) + url: https://github.com/chaoss/wg-evolution/blob/master/metrics/Code_Changes.md + operationId: Code Changes (Repo Group) parameters: - description: Repository Group ID in: path @@ -1610,33 +1610,54 @@ paths: schema: type: string type: string + - description: Periodicity specification. + in: path + name: period + schema: + type: string + type: string + - description: 'Beginning date specification. E.g. values: 2018, 2018-05, 2019-05-01' + in: path + name: begin_date + schema: + type: string + type: string + - description: 'Ending date specification. E.g. values: 2018, 2018-05, 2019-05-01' + in: path + name: end_date + schema: + type: string + type: string responses: '200': description: OK schema: items: properties: + commit_count: + description: 'Example: 173' + type: integer date: - description: 'Example: 2017-09-11T00:00:00.000Z' + description: 'Example: 2018-01-01T00:00:00.000Z' type: string - open_count: - description: 'Example: 1' + repo_id: + description: 'Example: 21337' type: integer - rg_name: - description: 'Example: Netflix' + repo_name: + description: 'Example: graphql-wg' type: string type: array tags: - evolution - /repo-groups/:repo_group_id/closed-issues-count: + /repos/:repo_id/code-changes: get: - description: 'Count of closed issues. ' + description: 'Time series number of commits during a certain period. ' externalDocs: description: CHAOSS Metric Definition - url: https://github.com/chaoss/wg-evolution/blob/master/metrics/contributors-new.md - operationId: Closed Issues Count (Repo) + url: https://github.com/chaoss/wg-evolution/blob/master/metrics/Code_Changes.md + operationId: Code Changes (Repo) parameters: - - description: Repository Group ID + - description: Repository Group ID. in: path name: repo_group_id schema: @@ -1648,31 +1669,49 @@ paths: schema: type: string type: string + - description: Periodicity specification. + in: path + name: period + schema: + type: string + type: string + - description: 'Beginning date specification. E.g. values: 2018, 2018-05, 2019-05-01' + in: path + name: begin_date + schema: + type: string + type: string + - description: 'Ending date specification. E.g. values: 2018, 2018-05, 2019-05-01' + in: path + name: end_date + schema: + type: string + type: string responses: '200': description: OK schema: items: properties: - closed_count: - description: 'Example: 26' + commit_count: + description: 'Example: 90' type: integer date: - description: 'Example: 2018-11-26T00:00:00.000Z' + description: 'Example: 2015-01-01T00:00:00.000Z' + type: string + repo_name: + description: 'Example: graphql' type: string - repo_id: - description: 'Example: 21681' - type: integer type: array tags: - evolution - /repo-groups/:repo_group_id/code-changes: + /repo-groups/:repo_group_id/code-changes-lines: get: - description: 'Time series of number of commits during a certain period. ' + description: 'Time series of lines added and removed during a certain period. ' externalDocs: description: CHAOSS Metric Definition - url: https://github.com/chaoss/wg-evolution/blob/master/metrics/Code_Changes.md - operationId: Code Changes (Repo Group) + url: https://github.com/chaoss/wg-evolution/blob/master/metrics/Code_Changes_Lines.md + operationId: Code Changes Lines (Repo Group) parameters: - description: Repository Group ID in: path @@ -1704,12 +1743,15 @@ paths: schema: items: properties: - commit_count: - description: 'Example: 173' + added: + description: 'Example: 1135' type: integer date: description: 'Example: 2018-01-01T00:00:00.000Z' type: string + removed: + description: 'Example: 101' + type: integer repo_id: description: 'Example: 21337' type: integer @@ -1719,20 +1761,26 @@ paths: type: array tags: - evolution - /repo-groups/:repo_group_id/code-changes-lines: + /repos/:repo_id/code-changes-lines: get: description: 'Time series of lines added and removed during a certain period. ' externalDocs: description: CHAOSS Metric Definition url: https://github.com/chaoss/wg-evolution/blob/master/metrics/Code_Changes_Lines.md - operationId: Code Changes Lines (Repo Group) + operationId: Code Changes Lines (Repo) parameters: - - description: Repository Group ID + - description: Repository Group ID. in: path name: repo_group_id schema: type: string type: string + - description: Repository ID. + in: path + name: repo_id + schema: + type: string + type: string - description: Periodicity specification. in: path name: period @@ -1758,19 +1806,16 @@ paths: items: properties: added: - description: 'Example: 1135' + description: 'Example: 17613' type: integer date: - description: 'Example: 2018-01-01T00:00:00.000Z' + description: 'Example: 2015-06-01T00:00:00.000Z' type: string removed: - description: 'Example: 101' - type: integer - repo_id: - description: 'Example: 21337' + description: 'Example: 106' type: integer repo_name: - description: 'Example: graphql-wg' + description: 'Example: graphql-js' type: string type: array tags: @@ -1840,6 +1885,71 @@ paths: type: array tags: - evolution + /repos/:repo_id/contributors: + get: + description: 'List of contributors and their contributions. ' + externalDocs: + description: CHAOSS Metric Definition + url: https://github.com/chaoss/wg-evolution/blob/master/metrics/contributors.md + operationId: Contributors (Repo) + parameters: + - description: Repository Group ID. + in: path + name: repo_group_id + schema: + type: string + type: string + - description: Repository ID. + in: path + name: repo_id + schema: + type: string + type: string + - description: 'Beginning date specification. E.g. values: 2018, 2018-05, 2019-05-01' + in: path + name: begin_date + schema: + type: string + type: string + - description: 'Ending date specification. E.g. values: 2018, 2018-05, 2019-05-01' + in: path + name: end_date + schema: + type: string + type: string + responses: + '200': + description: OK + schema: + items: + properties: + commit_comments: + description: 'Example: 0' + type: integer + commits: + description: 'Example: 0' + type: integer + issue_comments: + description: 'Example: 0' + type: integer + issues: + description: 'Example: 2' + type: integer + pull_request_comments: + description: 'Example: 0' + type: integer + pull_requests: + description: 'Example: 0' + type: integer + total: + description: 'Example: 2' + type: integer + user: + description: 'Example: 1' + type: integer + type: array + tags: + - evolution /repo-groups/:repo_group_id/contributors-new: get: description: 'Time series of number of new contributors during a certain period. ' @@ -1893,6 +2003,65 @@ paths: type: array tags: - evolution + /repos/:repo_id/contributors-new: + get: + description: 'Time series of number of new contributors during a certain period. ' + externalDocs: + description: CHAOSS Metric Definition + url: https://github.com/chaoss/wg-evolution/blob/master/metrics/contributors-new.md + operationId: New Contributors (Repo) + parameters: + - description: Repository Group ID. + in: path + name: repo_group_id + schema: + type: string + type: string + - description: Repository ID. + in: path + name: repo_id + schema: + type: string + type: string + - description: Periodicity specification. + in: path + name: period + schema: + type: string + type: string + - description: 'Beginning date specification. E.g. values: 2018, 2018-05, 2019-05-01' + in: path + name: begin_date + schema: + type: string + type: string + - description: 'Ending date specification. E.g. values: 2018, 2018-05, 2019-05-01' + in: path + name: end_date + schema: + type: string + type: string + responses: + '200': + description: OK + schema: + items: + properties: + date: + description: 'Example: 2018-05-20T00:00:00.000Z' + type: string + new_contributors: + description: 'Example: 3' + type: integer + repo_id: + description: 'Example: 21000' + type: integer + repo_name: + description: 'Example: rails' + type: string + type: array + tags: + - evolution /repo-groups/:repo_group_id/issue-backlog: get: description: 'Number of issues currently open. ' @@ -1925,20 +2094,26 @@ paths: type: array tags: - evolution - /repo-groups/:repo_group_id/issue-duration: + /repos/:repo_id/issue-backlog: get: description: 'Time since an issue is proposed until it is closed. ' externalDocs: description: CHAOSS Metric Definition url: https://github.com/chaoss/wg-evolution/blob/master/focus_areas/code_development.md - operationId: Issue Duration (Repo Group) + operationId: Issue Duration (Repo) parameters: - - description: Repository Group ID + - description: Repository Group ID. in: path name: repo_group_id schema: type: string type: string + - description: Repository ID. + in: path + name: repo_id + schema: + type: string + type: string - description: 'Beginning date specification. E.g. values: 2018, 2018-05, 2019-05-01' in: path name: begin_date @@ -1958,22 +2133,19 @@ paths: items: properties: closed_at: - description: 'Example: 2011-05-06T20:21:47.000Z' + description: 'Example: 2011-04-14T23:27:33.000Z' type: string created_at: - description: 'Example: 2011-05-06T20:20:05.000Z' + description: 'Example: 2011-02-13T03:46:06.000Z' type: string duration: - description: 'Example: 0 days 00:01:42.000000000' + description: 'Example: 60 days 19:41:27.000000000' type: string issue_id: - description: 'Example: 50320' - type: integer - repo_id: - description: 'Example: 21017' + description: 'Example: 50306' type: integer repo_name: - description: 'Example: ssl_requirement' + description: 'Example: exception_notification' type: string type: array tags: @@ -2028,56 +2200,23 @@ paths: type: array tags: - evolution - /repo-groups/:repo_group_id/issue-throughput: + /repos/:repo_id/issue-participants: get: - description: 'Ratio of issues closed to total issues. ' + description: 'How many persons participated in the discussion of issues. ' externalDocs: description: CHAOSS Metric Definition url: https://github.com/chaoss/wg-evolution/blob/master/focus_areas/code_development.md - operationId: Issue Throughput (Repo Group) - parameters: - - description: Repository Group ID - in: path - name: repo_group_id - schema: - type: string - type: string - responses: - '200': - description: OK - schema: - items: - properties: - repo_id: - description: 'Example: 21681' - type: integer - repo_name: - description: 'Example: incubator-zipkin' - type: string - throughput: - description: 'Example: 0.819125' - type: string - type: array - tags: - - evolution - /repo-groups/:repo_group_id/issues-active: - get: - description: 'Time series of number of issues that showed some activity during - a certain period. ' - externalDocs: - description: CHAOSS Metric Definition - url: https://github.com/chaoss/wg-evolution/blob/master/metrics/Issues_Active.md - operationId: Issues Active (Repo Group) + operationId: Issue Participants (Repo) parameters: - - description: Repository Group ID + - description: Repository Group ID. in: path name: repo_group_id schema: type: string type: string - - description: Periodicity specification. + - description: Repository ID. in: path - name: period + name: repo_id schema: type: string type: string @@ -2099,28 +2238,28 @@ paths: schema: items: properties: - date: - description: 'Example: 2019-01-01T00:00:00.000Z' + created_at: + description: 'Example: 2017-03-02T21:14:46.000Z' type: string - issues: - description: 'Example: 18' + issue_id: + description: 'Example: 50796' type: integer - repo_id: - description: 'Example: 21039' + participants: + description: 'Example: 1' type: integer repo_name: - description: 'Example: rails_xss' + description: 'Example: arel' type: string type: array tags: - evolution - /repo-groups/:repo_group_id/issues-closed: + /repo-groups/:repo_group_id/issue-throughput: get: - description: 'Time series of number of issues closed during a certain period. ' + description: 'Ratio of issues closed to total issues. ' externalDocs: description: CHAOSS Metric Definition - url: https://github.com/chaoss/wg-evolution/blob/master/metrics/Issues_Closed.md - operationId: Issues Closed (Repo Group) + url: https://github.com/chaoss/wg-evolution/blob/master/focus_areas/code_development.md + operationId: Issue Throughput (Repo Group) parameters: - description: Repository Group ID in: path @@ -2128,93 +2267,67 @@ paths: schema: type: string type: string - - description: Periodicity specification. - in: path - name: period - schema: - type: string - type: string - - description: 'Beginning date specification. E.g. values: 2018, 2018-05, 2019-05-01' - in: path - name: begin_date - schema: - type: string - type: string - - description: 'Ending date specification. E.g. values: 2018, 2018-05, 2019-05-01' - in: path - name: end_date - schema: - type: string - type: string responses: '200': description: OK schema: items: properties: - date: - description: 'Example: 2019-01-01T00:00:00.000Z' - type: string - issues: - description: 'Example: 425' - type: integer repo_id: description: 'Example: 21681' type: integer repo_name: description: 'Example: incubator-zipkin' type: string + throughput: + description: 'Example: 0.819125' + type: string type: array tags: - evolution - /repo-groups/:repo_group_id/issues-closed-resolution-duration: + /repos/:repo_id/issue-throughput: get: - description: 'Duration of time for issues to be resolved. ' + description: 'Ratio of issues closed to total issues. ' externalDocs: description: CHAOSS Metric Definition - url: https://github.com/chaoss/wg-evolution/blob/master/metrics/issues-closed-resolution-duration.md - operationId: Closed Issue Resolution Duration (Repo Group) + url: https://github.com/chaoss/wg-evolution/blob/master/focus_areas/code_development.md + operationId: Issue Throughput (Repo) parameters: - - description: Repository Group ID + - description: Repository Group ID. in: path name: repo_group_id schema: type: string type: string + - description: Repository ID. + in: path + name: repo_id + schema: + type: string + type: string responses: '200': description: OK schema: items: properties: - closed_at: - description: 'Example: 2019-05-22T05:27:29.000Z' - type: string - created_at: - description: 'Example: 2019-05-22T03:18:13.000Z' - type: string - diffdate: - description: 'Example: 0.0' - type: string - gh_issue_number: - description: 'Example: 4110' - type: integer - issue_title: - description: 'Example: rm incubating word' - type: string repo_name: - description: 'Example: incubator-dubbo' + description: 'Example: rails-contributors' + type: string + throughput: + description: 'Example: 0.997531' type: string type: array tags: - evolution - /repo-groups/:repo_group_id/issues-first-time-closed: + /repo-groups/:repo_group_id/issues-active: get: - description: 'Number of persons closing an issue for the first time. ' + description: 'Time series of number of issues that showed some activity during + a certain period. ' externalDocs: description: CHAOSS Metric Definition - url: https://github.com/chaoss/wg-evolution/blob/master/metrics/issues-first-time-closed.md - operationId: Closed Issues New Contributor (Repo Group) + url: https://github.com/chaoss/wg-evolution/blob/master/metrics/Issues_Active.md + operationId: Issues Active (Repo Group) parameters: - description: Repository Group ID in: path @@ -2246,35 +2359,42 @@ paths: schema: items: properties: - count: - description: 'Example: 3' - type: integer - issue_date: - description: 'Example: 2018-05-20T00:00:00.000Z' + date: + description: 'Example: 2019-01-01T00:00:00.000Z' type: string + issues: + description: 'Example: 18' + type: integer repo_id: - description: 'Example: 21000' + description: 'Example: 21039' type: integer repo_name: - description: 'Example: rails' + description: 'Example: rails_xss' type: string type: array tags: - evolution - /repo-groups/:repo_group_id/issues-first-time-opened: + /repos/:repo_id/issues-active: get: - description: 'Number of persons opening an issue for the first time. ' + description: 'Time series of number of issues that showed some activity during + a certain period. ' externalDocs: description: CHAOSS Metric Definition - url: https://github.com/chaoss/wg-evolution/blob/master/metrics/issues-first-time-opened.md - operationId: New Contributors of Issues (Repo Group) + url: https://github.com/chaoss/wg-evolution/blob/master/metrics/Issues_Active.md + operationId: Issues Active (Repo) parameters: - - description: Repository Group ID + - description: Repository Group ID. in: path name: repo_group_id schema: type: string type: string + - description: Repository ID. + in: path + name: repo_id + schema: + type: string + type: string - description: Periodicity specification. in: path name: period @@ -2299,14 +2419,11 @@ paths: schema: items: properties: - count: - description: 'Example: 3' - type: integer - issue_date: - description: 'Example: 2018-05-20T00:00:00.000Z' + date: + description: 'Example: 2011-01-01T00:00:00.000Z' type: string - repo_id: - description: 'Example: 21000' + issues: + description: 'Example: 30' type: integer repo_name: description: 'Example: rails' @@ -2314,13 +2431,13 @@ paths: type: array tags: - evolution - /repo-groups/:repo_group_id/issues-maintainer-response-duration: + /repo-groups/:repo_group_id/issues-closed: get: - description: 'Duration of time for issues to be resolved. ' + description: 'Time series of number of issues closed during a certain period. ' externalDocs: description: CHAOSS Metric Definition - url: https://github.com/chaoss/wg-evolution/blob/master/metrics/issues-maintainer-response-duration.md - operationId: Issue Response Time (Repo Group) + url: https://github.com/chaoss/wg-evolution/blob/master/metrics/Issues_Closed.md + operationId: Issues Closed (Repo Group) parameters: - description: Repository Group ID in: path @@ -2328,6 +2445,12 @@ paths: schema: type: string type: string + - description: Periodicity specification. + in: path + name: period + schema: + type: string + type: string - description: 'Beginning date specification. E.g. values: 2018, 2018-05, 2019-05-01' in: path name: begin_date @@ -2346,32 +2469,41 @@ paths: schema: items: properties: - average_days_comment: - description: 'Example: 27.1111111111' + date: + description: 'Example: 2019-01-01T00:00:00.000Z' type: string + issues: + description: 'Example: 425' + type: integer repo_id: - description: 'Example: 21987' + description: 'Example: 21681' type: integer repo_name: - description: 'Example: qpid-proton' + description: 'Example: incubator-zipkin' type: string type: array tags: - evolution - /repo-groups/:repo_group_id/issues-new: + /repos/:repo_id/issues-closed: get: - description: 'Time series of number of new issues opened during a certain period. ' + description: 'Time series of number of issues closed during a certain period. ' externalDocs: description: CHAOSS Metric Definition url: https://github.com/chaoss/wg-evolution/blob/master/metrics/Issues_New.md - operationId: Issues New (Repo Group) + operationId: Issues Closed (Repo) parameters: - - description: Repository Group ID + - description: Repository Group ID. in: path name: repo_group_id schema: type: string type: string + - description: Repository ID. + in: path + name: repo_id + schema: + type: string + type: string - description: Periodicity specification. in: path name: period @@ -2397,27 +2529,24 @@ paths: items: properties: date: - description: 'Example: 2019-01-01T00:00:00.000Z' + description: 'Example: 2012-01-01T00:00:00.000Z' type: string issues: - description: 'Example: 318' - type: integer - repo_id: - description: 'Example: 21000' + description: 'Example: 97' type: integer repo_name: - description: 'Example: rails' + description: 'Example: incubator-pagespeed-ngx' type: string type: array tags: - evolution - /repo-groups/:repo_group_id/issues-open-age: + /repo-groups/:repo_group_id/issues-closed-resolution-duration: get: - description: 'Age of open issues. ' + description: 'Duration of time for issues to be resolved. ' externalDocs: description: CHAOSS Metric Definition - url: https://github.com/chaoss/wg-evolution/blob/master/metrics/issues-open-age.md - operationId: Open Issue Age (Repo Group) + url: https://github.com/chaoss/wg-evolution/blob/master/metrics/issues-closed-resolution-duration.md + operationId: Closed Issue Resolution Duration (Repo Group) parameters: - description: Repository Group ID in: path @@ -2431,54 +2560,44 @@ paths: schema: items: properties: - date: - description: 'Example: 2009-05-15T19:48:43.000Z' + closed_at: + description: 'Example: 2019-05-22T05:27:29.000Z' type: string - issue_id: - description: 'Example: 38318' - type: integer - open_date: - description: 'Example: 3696' - type: integer - repo_id: - description: 'Example: 21000' + created_at: + description: 'Example: 2019-05-22T03:18:13.000Z' + type: string + diffdate: + description: 'Example: 0.0' + type: string + gh_issue_number: + description: 'Example: 4110' type: integer + issue_title: + description: 'Example: rm incubating word' + type: string repo_name: - description: 'Example: rails' + description: 'Example: incubator-dubbo' type: string type: array tags: - evolution - /repo-groups/:repo_group_id/pull-requests-merge-contributor-new: + /repos/:repo_id/issues-closed-resolution-duration: get: - description: 'Number of persons contributing with an accepted commit for the - first time. ' + description: 'Duration of time for issues to be resolved. ' externalDocs: description: CHAOSS Metric Definition - url: https://github.com/chaoss/wg-evolution/blob/master/metrics/pull-requests-merge-contributor-new.md - operationId: New Contributors of Commits (Repo Group) + url: https://github.com/chaoss/wg-evolution/blob/master/metrics/issues-closed-resolution-duration.md + operationId: Closed Issue Resolution Duration (Repo) parameters: - - description: Repository Group ID + - description: Repository Group ID. in: path name: repo_group_id schema: type: string type: string - - description: Periodicity specification. - in: path - name: period - schema: - type: string - type: string - - description: 'Beginning date specification. E.g. values: 2018, 2018-05, 2019-05-01' - in: path - name: begin_date - schema: - type: string - type: string - - description: 'Ending date specification. E.g. values: 2018, 2018-05, 2019-05-01' + - description: Repository ID. in: path - name: end_date + name: repo_id schema: type: string type: string @@ -2488,28 +2607,37 @@ paths: schema: items: properties: - commit_count: - description: 'Example: 711' + closed_at: + description: 'Example: 2019-06-17T03:12:48.000Z' + type: string + created_at: + description: 'Example: 2019-05-31T07:55:44.000Z' + type: string + diffdate: + description: 'Example: 16.0' + type: string + gh_issue_number: + description: 'Example: 4223' type: integer - commit_date: - description: 'Example: 2018-01-01T00:00:00.000Z' + issue_title: + description: 'Example: Cloud Native PR' type: string - count: - description: 'Example: 5140' + repo_id: + description: 'Example: 21682' type: integer repo_name: - description: 'Example: rails' + description: 'Example: incubator-dubbo' type: string type: array tags: - evolution - /repo-groups/:repo_group_id/review-duration: + /repo-groups/:repo_group_id/issues-first-time-closed: get: - description: 'Time since an review/pull request is proposed until it is accepted. ' + description: 'Number of persons closing an issue for the first time. ' externalDocs: description: CHAOSS Metric Definition - url: https://github.com/chaoss/wg-evolution/blob/master/metrics/Reviews_Duration.md - operationId: Review Duration (Repo Group) + url: https://github.com/chaoss/wg-evolution/blob/master/metrics/issues-first-time-closed.md + operationId: Closed Issues New Contributor (Repo Group) parameters: - description: Repository Group ID in: path @@ -2517,6 +2645,12 @@ paths: schema: type: string type: string + - description: Periodicity specification. + in: path + name: period + schema: + type: string + type: string - description: 'Beginning date specification. E.g. values: 2018, 2018-05, 2019-05-01' in: path name: begin_date @@ -2535,42 +2669,41 @@ paths: schema: items: properties: - created_at: - description: 'Example: 2010-09-28T19:07:15.000Z' - type: string - duration: - description: 'Example: 0 days 22:39:44.000000000' - type: string - merged_at: - description: 'Example: 2010-09-29T17:46:59.000Z' - type: string - pull_request_id: - description: 'Example: 25386' + count: + description: 'Example: 3' type: integer + issue_date: + description: 'Example: 2018-05-20T00:00:00.000Z' + type: string repo_id: - description: 'Example: 21035' + description: 'Example: 21000' type: integer repo_name: - description: 'Example: prototype-ujs' + description: 'Example: rails' type: string type: array tags: - evolution - /repo-groups/:repo_group_id/reviews: + /repos/:repo_id/issues-first-time-closed: get: - description: 'Time series of number of new reviews / pull requests opened within - a certain period. ' + description: 'Number of persons closing an issue for the first time. ' externalDocs: description: CHAOSS Metric Definition - url: https://github.com/chaoss/wg-evolution/blob/master/metrics/reviews.md - operationId: Reviews (Repo Group) + url: https://github.com/chaoss/wg-evolution/blob/master/metrics/issues-first-time-closed.md + operationId: Closed Issues New Contributors (Repo) parameters: - - description: Repository Group ID + - description: Repository Group ID. in: path name: repo_group_id schema: type: string type: string + - description: Repository ID. + in: path + name: repo_id + schema: + type: string + type: string - description: Periodicity specification. in: path name: period @@ -2595,29 +2728,25 @@ paths: schema: items: properties: - date: - description: 'Example: 2010-01-01T00:00:00.000Z' - type: string - pull_requests: - description: 'Example: 1' - type: integer - repo_id: - description: 'Example: 21035' + count: + description: 'Example: 3' type: integer + issue_date: + description: 'Example: 2018-05-20T00:00:00.000Z' + type: string repo_name: - description: 'Example: prototype-ujs' + description: 'Example: rails' type: string type: array tags: - evolution - /repo-groups/:repo_group_id/reviews-accepted: + /repo-groups/:repo_group_id/issues-first-time-opened: get: - description: 'Time series of number of accepted reviews / pull requests opened - within a certain period. ' + description: 'Number of persons opening an issue for the first time. ' externalDocs: description: CHAOSS Metric Definition - url: https://github.com/chaoss/wg-evolution/blob/master/metrics/Reviews_Accepted.md - operationId: Reviews Accepted (Repo Group) + url: https://github.com/chaoss/wg-evolution/blob/master/metrics/issues-first-time-opened.md + operationId: New Contributors of Issues (Repo Group) parameters: - description: Repository Group ID in: path @@ -2649,36 +2778,41 @@ paths: schema: items: properties: - date: - description: 'Example: 2010-01-01T00:00:00.000Z' - type: string - pull_requests: - description: 'Example: 1' + count: + description: 'Example: 3' type: integer + issue_date: + description: 'Example: 2018-05-20T00:00:00.000Z' + type: string repo_id: - description: 'Example: 21035' + description: 'Example: 21000' type: integer repo_name: - description: 'Example: prototype-ujs' + description: 'Example: rails' type: string type: array tags: - evolution - /repo-groups/:repo_group_id/reviews-declined: + /repos/:repo_id/issues-first-time-opened: get: - description: 'Time series of number of declined reviews / pull requests opened - within a certain period. ' + description: 'Number of persons opening an issue for the first time. ' externalDocs: description: CHAOSS Metric Definition - url: https://github.com/chaoss/wg-evolution/blob/master/metrics/Reviews_Accepted.md - operationId: Reviews Declined (Repo Group) + url: https://github.com/chaoss/wg-evolution/blob/master/metrics/issues-first-time-opened.md + operationId: New Contributors of Issues (Repo) parameters: - - description: Repository Group ID + - description: Repository Group ID. in: path name: repo_group_id schema: type: string type: string + - description: Repository ID. + in: path + name: repo_id + schema: + type: string + type: string - description: Periodicity specification. in: path name: period @@ -2703,28 +2837,25 @@ paths: schema: items: properties: - date: - description: 'Example: 2010-01-01T00:00:00.000Z' - type: string - pull_requests: - description: 'Example: 1' - type: integer - repo_id: - description: 'Example: 21035' + count: + description: 'Example: 3' type: integer + issue_date: + description: 'Example: 2018-05-20T00:00:00.000Z' + type: string repo_name: - description: 'Example: prototype-ujs' + description: 'Example: rails' type: string type: array tags: - evolution - /repo-groups/:repo_group_id/sub-projects: + /repo-groups/:repo_group_id/issues-maintainer-response-duration: get: - description: 'Number of sub-projects. ' + description: 'Duration of time for issues to be resolved. ' externalDocs: description: CHAOSS Metric Definition - url: https://github.com/chaoss/wg-evolution/blob/master/metrics/sub-projects.md - operationId: Sub-Projects (Repo Group) + url: https://github.com/chaoss/wg-evolution/blob/master/metrics/issues-maintainer-response-duration.md + operationId: Issue Response Time (Repo Group) parameters: - description: Repository Group ID in: path @@ -2750,53 +2881,27 @@ paths: schema: items: properties: - sub_protject_count: - description: 'Example: 2' - type: integer - type: array - tags: - - evolution - /repos/:repo_id/closed-issues-count: - get: - description: 'Count of closed issues. ' - externalDocs: - description: CHAOSS Metric Definition - url: https://github.com/chaoss/wg-evolution/blob/master/metrics/contributors-new.md - operationId: Closed Issues Count (Repo Group) - parameters: - - description: Repository Group ID - in: path - name: repo_group_id - schema: - type: string - type: string - responses: - '200': - description: OK - schema: - items: - properties: - closed_count: - description: 'Example: 4' - type: integer - date: - description: 'Example: 2014-06-02T00:00:00.000Z' + average_days_comment: + description: 'Example: 27.1111111111' type: string - rg_name: - description: 'Example: Apache' + repo_id: + description: 'Example: 21987' + type: integer + repo_name: + description: 'Example: qpid-proton' type: string type: array tags: - evolution - /repos/:repo_id/code-changes: + /repos/:repo_id/issues-maintainer-response-duration: get: - description: 'Time series number of commits during a certain period. ' + description: 'Duration of time for issues to be resolved. ' externalDocs: description: CHAOSS Metric Definition - url: https://github.com/chaoss/wg-evolution/blob/master/metrics/Code_Changes.md - operationId: Code Changes (Repo) + url: https://github.com/chaoss/wg-evolution/blob/master/metrics/issues-maintainer-response-duration.md + operationId: Issue Response Time (Repo) parameters: - - description: Repository Group ID. + - description: Repository Group ID in: path name: repo_group_id schema: @@ -2808,12 +2913,6 @@ paths: schema: type: string type: string - - description: Periodicity specification. - in: path - name: period - schema: - type: string - type: string - description: 'Beginning date specification. E.g. values: 2018, 2018-05, 2019-05-01' in: path name: begin_date @@ -2832,38 +2931,32 @@ paths: schema: items: properties: - commit_count: - description: 'Example: 90' - type: integer - date: - description: 'Example: 2015-01-01T00:00:00.000Z' + average_days_comment: + description: 'Example: 27.1111111111' type: string + repo_id: + description: 'Example: 21987' + type: integer repo_name: - description: 'Example: graphql' + description: 'Example: qpid-proton' type: string type: array tags: - evolution - /repos/:repo_id/code-changes-lines: + /repo-groups/:repo_group_id/issues-new: get: - description: 'Time series of lines added and removed during a certain period. ' + description: 'Time series of number of new issues opened during a certain period. ' externalDocs: description: CHAOSS Metric Definition - url: https://github.com/chaoss/wg-evolution/blob/master/metrics/Code_Changes_Lines.md - operationId: Code Changes Lines (Repo) + url: https://github.com/chaoss/wg-evolution/blob/master/metrics/Issues_New.md + operationId: Issues New (Repo Group) parameters: - - description: Repository Group ID. + - description: Repository Group ID in: path name: repo_group_id schema: type: string type: string - - description: Repository ID. - in: path - name: repo_id - schema: - type: string - type: string - description: Periodicity specification. in: path name: period @@ -2888,28 +2981,28 @@ paths: schema: items: properties: - added: - description: 'Example: 17613' - type: integer date: - description: 'Example: 2015-06-01T00:00:00.000Z' + description: 'Example: 2019-01-01T00:00:00.000Z' type: string - removed: - description: 'Example: 106' + issues: + description: 'Example: 318' + type: integer + repo_id: + description: 'Example: 21000' type: integer repo_name: - description: 'Example: graphql-js' + description: 'Example: rails' type: string type: array tags: - evolution - /repos/:repo_id/contributors: + /repos/:repo_id/issues-new: get: - description: 'List of contributors and their contributions. ' + description: 'Time series of number of new issues opened during a certain period. ' externalDocs: description: CHAOSS Metric Definition - url: https://github.com/chaoss/wg-evolution/blob/master/metrics/contributors.md - operationId: Contributors (Repo) + url: https://github.com/chaoss/wg-evolution/blob/master/metrics/Issues_New.md + operationId: Issues New (Repo) parameters: - description: Repository Group ID. in: path @@ -2923,6 +3016,12 @@ paths: schema: type: string type: string + - description: Periodicity specification. + in: path + name: period + schema: + type: string + type: string - description: 'Beginning date specification. E.g. values: 2018, 2018-05, 2019-05-01' in: path name: begin_date @@ -2941,71 +3040,32 @@ paths: schema: items: properties: - commit_comments: - description: 'Example: 0' - type: integer - commits: - description: 'Example: 0' - type: integer - issue_comments: - description: 'Example: 0' - type: integer + date: + description: 'Example: 2015-01-01T00:00:00.000Z' + type: string issues: - description: 'Example: 2' - type: integer - pull_request_comments: - description: 'Example: 0' - type: integer - pull_requests: - description: 'Example: 0' - type: integer - total: - description: 'Example: 2' - type: integer - user: - description: 'Example: 1' + description: 'Example: 116' type: integer + repo_name: + description: 'Example: rails' + type: string type: array tags: - evolution - /repos/:repo_id/contributors-new: + /repo-groups/:repo_group_id/issues-open-age: get: - description: 'Time series of number of new contributors during a certain period. ' + description: 'Age of open issues. ' externalDocs: description: CHAOSS Metric Definition - url: https://github.com/chaoss/wg-evolution/blob/master/metrics/contributors-new.md - operationId: New Contributors (Repo) + url: https://github.com/chaoss/wg-evolution/blob/master/metrics/issues-open-age.md + operationId: Open Issue Age (Repo Group) parameters: - - description: Repository Group ID. + - description: Repository Group ID in: path name: repo_group_id schema: type: string type: string - - description: Repository ID. - in: path - name: repo_id - schema: - type: string - type: string - - description: Periodicity specification. - in: path - name: period - schema: - type: string - type: string - - description: 'Beginning date specification. E.g. values: 2018, 2018-05, 2019-05-01' - in: path - name: begin_date - schema: - type: string - type: string - - description: 'Ending date specification. E.g. values: 2018, 2018-05, 2019-05-01' - in: path - name: end_date - schema: - type: string - type: string responses: '200': description: OK @@ -3013,10 +3073,13 @@ paths: items: properties: date: - description: 'Example: 2018-05-20T00:00:00.000Z' + description: 'Example: 2009-05-15T19:48:43.000Z' type: string - new_contributors: - description: 'Example: 3' + issue_id: + description: 'Example: 38318' + type: integer + open_date: + description: 'Example: 3696' type: integer repo_id: description: 'Example: 21000' @@ -3027,13 +3090,13 @@ paths: type: array tags: - evolution - /repos/:repo_id/issue-backlog: + /repos/:repo_id/issues-open-age: get: - description: 'Time since an issue is proposed until it is closed. ' + description: 'Age of open issues. ' externalDocs: description: CHAOSS Metric Definition - url: https://github.com/chaoss/wg-evolution/blob/master/focus_areas/code_development.md - operationId: Issue Duration (Repo) + url: https://github.com/chaoss/wg-evolution/blob/master/metrics/issues-open-age.md + operationId: Open Issue Age (Repo) parameters: - description: Repository Group ID. in: path @@ -3047,59 +3110,48 @@ paths: schema: type: string type: string - - description: 'Beginning date specification. E.g. values: 2018, 2018-05, 2019-05-01' - in: path - name: begin_date - schema: - type: string - type: string - - description: 'Ending date specification. E.g. values: 2018, 2018-05, 2019-05-01' - in: path - name: end_date - schema: - type: string - type: string responses: '200': description: OK schema: items: properties: - closed_at: - description: 'Example: 2011-04-14T23:27:33.000Z' - type: string - created_at: - description: 'Example: 2011-02-13T03:46:06.000Z' - type: string - duration: - description: 'Example: 60 days 19:41:27.000000000' + date: + description: 'Example: 2009-05-15T19:48:43.000Z' type: string issue_id: - description: 'Example: 50306' + description: 'Example: 38318' + type: integer + open_date: + description: 'Example: 3696' + type: integer + repo_id: + description: 'Example: 21000' type: integer repo_name: - description: 'Example: exception_notification' + description: 'Example: rails' type: string type: array tags: - evolution - /repos/:repo_id/issue-participants: + /repo-groups/:repo_group_id/pull-requests-merge-contributor-new: get: - description: 'How many persons participated in the discussion of issues. ' + description: 'Number of persons contributing with an accepted commit for the + first time. ' externalDocs: description: CHAOSS Metric Definition - url: https://github.com/chaoss/wg-evolution/blob/master/focus_areas/code_development.md - operationId: Issue Participants (Repo) + url: https://github.com/chaoss/wg-evolution/blob/master/metrics/pull-requests-merge-contributor-new.md + operationId: New Contributors of Commits (Repo Group) parameters: - - description: Repository Group ID. + - description: Repository Group ID in: path name: repo_group_id schema: type: string type: string - - description: Repository ID. + - description: Periodicity specification. in: path - name: repo_id + name: period schema: type: string type: string @@ -3121,28 +3173,29 @@ paths: schema: items: properties: - created_at: - description: 'Example: 2017-03-02T21:14:46.000Z' - type: string - issue_id: - description: 'Example: 50796' + commit_count: + description: 'Example: 711' type: integer - participants: - description: 'Example: 1' + commit_date: + description: 'Example: 2018-01-01T00:00:00.000Z' + type: string + count: + description: 'Example: 5140' type: integer repo_name: - description: 'Example: arel' + description: 'Example: rails' type: string type: array tags: - evolution - /repos/:repo_id/issue-throughput: + /repos/:repo_id/pull-requests-merge-contributor-new: get: - description: 'Ratio of issues closed to total issues. ' + description: 'Number of persons contributing with an accepted commit for the + first time. ' externalDocs: description: CHAOSS Metric Definition - url: https://github.com/chaoss/wg-evolution/blob/master/focus_areas/code_development.md - operationId: Issue Throughput (Repo) + url: https://github.com/chaoss/wg-evolution/blob/master/metrics/pull-requests-merge-contributor-new.md + operationId: New Contributors of Commits (Repo) parameters: - description: Repository Group ID. in: path @@ -3156,48 +3209,56 @@ paths: schema: type: string type: string + - description: Periodicity specification. + in: path + name: period + schema: + type: string + type: string + - description: 'Beginning date specification. E.g. values: 2018, 2018-05, 2019-05-01' + in: path + name: begin_date + schema: + type: string + type: string + - description: 'Ending date specification. E.g. values: 2018, 2018-05, 2019-05-01' + in: path + name: end_date + schema: + type: string + type: string responses: '200': description: OK schema: items: properties: - repo_name: - description: 'Example: rails-contributors' + commit_date: + description: 'Example: 2018-01-01T00:00:00.000Z' type: string - throughput: - description: 'Example: 0.997531' + count: + description: 'Example: 2287' + type: integer + repo_name: + description: 'Example: rails' type: string type: array tags: - evolution - /repos/:repo_id/issues-active: + /repo-groups/:repo_group_id/review-duration: get: - description: 'Time series of number of issues that showed some activity during - a certain period. ' + description: 'Time since an review/pull request is proposed until it is accepted. ' externalDocs: description: CHAOSS Metric Definition - url: https://github.com/chaoss/wg-evolution/blob/master/metrics/Issues_Active.md - operationId: Issues Active (Repo) + url: https://github.com/chaoss/wg-evolution/blob/master/metrics/Reviews_Duration.md + operationId: Review Duration (Repo Group) parameters: - - description: Repository Group ID. + - description: Repository Group ID in: path name: repo_group_id schema: type: string type: string - - description: Repository ID. - in: path - name: repo_id - schema: - type: string - type: string - - description: Periodicity specification. - in: path - name: period - schema: - type: string - type: string - description: 'Beginning date specification. E.g. values: 2018, 2018-05, 2019-05-01' in: path name: begin_date @@ -3216,25 +3277,34 @@ paths: schema: items: properties: - date: - description: 'Example: 2011-01-01T00:00:00.000Z' + created_at: + description: 'Example: 2010-09-28T19:07:15.000Z' type: string - issues: - description: 'Example: 30' + duration: + description: 'Example: 0 days 22:39:44.000000000' + type: string + merged_at: + description: 'Example: 2010-09-29T17:46:59.000Z' + type: string + pull_request_id: + description: 'Example: 25386' + type: integer + repo_id: + description: 'Example: 21035' type: integer repo_name: - description: 'Example: rails' + description: 'Example: prototype-ujs' type: string type: array tags: - evolution - /repos/:repo_id/issues-closed: + /repos/:repo_id/review-duration: get: - description: 'Time series of number of issues closed during a certain period. ' + description: 'Time since an review/pull request is proposed until it is accepted. ' externalDocs: description: CHAOSS Metric Definition - url: https://github.com/chaoss/wg-evolution/blob/master/metrics/Issues_New.md - operationId: Issues Closed (Repo) + url: https://github.com/chaoss/wg-evolution/blob/master/metrics/Reviews_Duration.md + operationId: Review Duration (Repo) parameters: - description: Repository Group ID. in: path @@ -3248,12 +3318,6 @@ paths: schema: type: string type: string - - description: Periodicity specification. - in: path - name: period - schema: - type: string - type: string - description: 'Beginning date specification. E.g. values: 2018, 2018-05, 2019-05-01' in: path name: begin_date @@ -3272,88 +3336,39 @@ paths: schema: items: properties: - date: - description: 'Example: 2012-01-01T00:00:00.000Z' - type: string - issues: - description: 'Example: 97' - type: integer - repo_name: - description: 'Example: incubator-pagespeed-ngx' - type: string - type: array - tags: - - evolution - /repos/:repo_id/issues-closed-resolution-duration: - get: - description: 'Duration of time for issues to be resolved. ' - externalDocs: - description: CHAOSS Metric Definition - url: https://github.com/chaoss/wg-evolution/blob/master/metrics/issues-closed-resolution-duration.md - operationId: Closed Issue Resolution Duration (Repo) - parameters: - - description: Repository Group ID. - in: path - name: repo_group_id - schema: - type: string - type: string - - description: Repository ID. - in: path - name: repo_id - schema: - type: string - type: string - responses: - '200': - description: OK - schema: - items: - properties: - closed_at: - description: 'Example: 2019-06-17T03:12:48.000Z' - type: string created_at: - description: 'Example: 2019-05-31T07:55:44.000Z' + description: 'Example: 2019-01-02T11:02:08.000Z' type: string - diffdate: - description: 'Example: 16.0' + duration: + description: 'Example: 183 days 22:08:37.000000000' type: string - gh_issue_number: - description: 'Example: 4223' - type: integer - issue_title: - description: 'Example: Cloud Native PR' + merged_at: + description: 'Example: 2019-07-05T09:10:45.000Z' type: string - repo_id: - description: 'Example: 21682' + pull_request_id: + description: 'Example: 25374' type: integer repo_name: - description: 'Example: incubator-dubbo' + description: 'Example: graphql-spec' type: string type: array tags: - evolution - /repos/:repo_id/issues-first-time-closed: + /repo-groups/:repo_group_id/reviews: get: - description: 'Number of persons closing an issue for the first time. ' + description: 'Time series of number of new reviews / pull requests opened within + a certain period. ' externalDocs: description: CHAOSS Metric Definition - url: https://github.com/chaoss/wg-evolution/blob/master/metrics/issues-first-time-closed.md - operationId: Closed Issues New Contributors (Repo) + url: https://github.com/chaoss/wg-evolution/blob/master/metrics/reviews.md + operationId: Reviews (Repo Group) parameters: - - description: Repository Group ID. + - description: Repository Group ID in: path name: repo_group_id schema: type: string type: string - - description: Repository ID. - in: path - name: repo_id - schema: - type: string - type: string - description: Periodicity specification. in: path name: period @@ -3378,25 +3393,29 @@ paths: schema: items: properties: - count: - description: 'Example: 3' - type: integer - issue_date: - description: 'Example: 2018-05-20T00:00:00.000Z' + date: + description: 'Example: 2010-01-01T00:00:00.000Z' type: string + pull_requests: + description: 'Example: 1' + type: integer + repo_id: + description: 'Example: 21035' + type: integer repo_name: - description: 'Example: rails' + description: 'Example: prototype-ujs' type: string type: array tags: - evolution - /repos/:repo_id/issues-first-time-opened: + /repos/:repo_id/reviews: get: - description: 'Number of persons opening an issue for the first time. ' + description: 'Time series of number of new reviews / pull requests opened within + a certain period. ' externalDocs: description: CHAOSS Metric Definition - url: https://github.com/chaoss/wg-evolution/blob/master/metrics/issues-first-time-opened.md - operationId: New Contributors of Issues (Repo) + url: https://github.com/chaoss/wg-evolution/blob/master/metrics/reviews.md + operationId: Reviews (Repo) parameters: - description: Repository Group ID. in: path @@ -3434,25 +3453,26 @@ paths: schema: items: properties: - count: - description: 'Example: 3' - type: integer - issue_date: - description: 'Example: 2018-05-20T00:00:00.000Z' + date: + description: 'Example: 2016-01-01T00:00:00.000Z' type: string + pull_requests: + description: 'Example: 37' + type: integer repo_name: - description: 'Example: rails' + description: 'Example: graphql-spec' type: string type: array tags: - evolution - /repos/:repo_id/issues-maintainer-response-duration: + /repo-groups/:repo_group_id/reviews-accepted: get: - description: 'Duration of time for issues to be resolved. ' + description: 'Time series of number of accepted reviews / pull requests opened + within a certain period. ' externalDocs: description: CHAOSS Metric Definition - url: https://github.com/chaoss/wg-evolution/blob/master/metrics/issues-maintainer-response-duration.md - operationId: Issue Response Time (Repo) + url: https://github.com/chaoss/wg-evolution/blob/master/metrics/Reviews_Accepted.md + operationId: Reviews Accepted (Repo Group) parameters: - description: Repository Group ID in: path @@ -3460,9 +3480,9 @@ paths: schema: type: string type: string - - description: Repository ID. + - description: Periodicity specification. in: path - name: repo_id + name: period schema: type: string type: string @@ -3484,25 +3504,29 @@ paths: schema: items: properties: - average_days_comment: - description: 'Example: 27.1111111111' + date: + description: 'Example: 2010-01-01T00:00:00.000Z' type: string + pull_requests: + description: 'Example: 1' + type: integer repo_id: - description: 'Example: 21987' + description: 'Example: 21035' type: integer repo_name: - description: 'Example: qpid-proton' + description: 'Example: prototype-ujs' type: string type: array tags: - evolution - /repos/:repo_id/issues-new: + /repos/:repo_id/reviews-accepted: get: - description: 'Time series of number of new issues opened during a certain period. ' + description: 'Time series of number of accepted reviews / pull requests opened + within a certain period. ' externalDocs: description: CHAOSS Metric Definition - url: https://github.com/chaoss/wg-evolution/blob/master/metrics/Issues_New.md - operationId: Issues New (Repo) + url: https://github.com/chaoss/wg-evolution/blob/master/metrics/Reviews_Accepted.md + operationId: Reviews Accepted (Repo) parameters: - description: Repository Group ID. in: path @@ -3541,34 +3565,47 @@ paths: items: properties: date: - description: 'Example: 2015-01-01T00:00:00.000Z' + description: 'Example: 2016-01-01T00:00:00.000Z' type: string - issues: - description: 'Example: 116' + pull_requests: + description: 'Example: 30' type: integer repo_name: - description: 'Example: rails' + description: 'Example: graphql-spec' type: string type: array tags: - evolution - /repos/:repo_id/issues-open-age: + /repo-groups/:repo_group_id/reviews-declined: get: - description: 'Age of open issues. ' + description: 'Time series of number of declined reviews / pull requests opened + within a certain period. ' externalDocs: description: CHAOSS Metric Definition - url: https://github.com/chaoss/wg-evolution/blob/master/metrics/issues-open-age.md - operationId: Open Issue Age (Repo) + url: https://github.com/chaoss/wg-evolution/blob/master/metrics/Reviews_Accepted.md + operationId: Reviews Declined (Repo Group) parameters: - - description: Repository Group ID. + - description: Repository Group ID in: path name: repo_group_id schema: type: string type: string - - description: Repository ID. + - description: Periodicity specification. in: path - name: repo_id + name: period + schema: + type: string + type: string + - description: 'Beginning date specification. E.g. values: 2018, 2018-05, 2019-05-01' + in: path + name: begin_date + schema: + type: string + type: string + - description: 'Ending date specification. E.g. values: 2018, 2018-05, 2019-05-01' + in: path + name: end_date schema: type: string type: string @@ -3579,31 +3616,28 @@ paths: items: properties: date: - description: 'Example: 2009-05-15T19:48:43.000Z' + description: 'Example: 2010-01-01T00:00:00.000Z' type: string - issue_id: - description: 'Example: 38318' - type: integer - open_date: - description: 'Example: 3696' + pull_requests: + description: 'Example: 1' type: integer repo_id: - description: 'Example: 21000' + description: 'Example: 21035' type: integer repo_name: - description: 'Example: rails' + description: 'Example: prototype-ujs' type: string type: array tags: - evolution - /repos/:repo_id/pull-requests-merge-contributor-new: + /repos/:repo_id/reviews-declined: get: - description: 'Number of persons contributing with an accepted commit for the - first time. ' + description: 'Time series of number of declined reviews / pull requests opened + within a certain period. ' externalDocs: description: CHAOSS Metric Definition - url: https://github.com/chaoss/wg-evolution/blob/master/metrics/pull-requests-merge-contributor-new.md - operationId: New Contributors of Commits (Repo) + url: https://github.com/chaoss/wg-evolution/blob/master/metrics/Reviews_Accepted.md + operationId: Reviews Declined (Repo) parameters: - description: Repository Group ID. in: path @@ -3641,35 +3675,41 @@ paths: schema: items: properties: - commit_date: - description: 'Example: 2018-01-01T00:00:00.000Z' + date: + description: 'Example: 2016-01-01T00:00:00.000Z' type: string - count: - description: 'Example: 2287' + pull_requests: + description: 'Example: 11' type: integer repo_name: - description: 'Example: rails' + description: 'Example: graphql-spec' type: string type: array tags: - evolution - /repos/:repo_id/releases: + /repo-groups/:repo_group_id/sub-projects: get: - description: 'Time since an review/pull request is proposed until it is accepted. ' + description: 'Number of sub-projects. ' externalDocs: description: CHAOSS Metric Definition - url: https://github.com/chaoss/wg-evolution/blob/master/metrics/Reviews_Duration.md - operationId: Number of releases (Repo) + url: https://github.com/chaoss/wg-evolution/blob/master/metrics/sub-projects.md + operationId: Sub-Projects (Repo Group) parameters: - - description: Repository Group ID. + - description: Repository Group ID in: path name: repo_group_id schema: type: string type: string - - description: Repository ID. + - description: 'Beginning date specification. E.g. values: 2018, 2018-05, 2019-05-01' in: path - name: repo_id + name: begin_date + schema: + type: string + type: string + - description: 'Ending date specification. E.g. values: 2018, 2018-05, 2019-05-01' + in: path + name: end_date schema: type: string type: string @@ -3679,28 +3719,19 @@ paths: schema: items: properties: - latest: - description: 'Example: 2019-11-02T11:02:08.000Z' - type: string - total_count: - description: 'Example: 35' - type: integer - latest_patch_release: - description: 'Example: 2019-01-02T15:20:07.000Z' - type: string - total_patch_count: - description: 'Example: 21' + sub_protject_count: + description: 'Example: 2' type: integer type: array tags: - evolution - /repos/:repo_id/review-duration: + /repos/:repo_id/sub-projects: get: - description: 'Time since an review/pull request is proposed until it is accepted. ' + description: 'Number of sub-projects. ' externalDocs: description: CHAOSS Metric Definition - url: https://github.com/chaoss/wg-evolution/blob/master/metrics/Reviews_Duration.md - operationId: Review Duration (Repo) + url: https://github.com/chaoss/wg-evolution/blob/master/metrics/sub-projects.md + operationId: Sub-Projects (Repo) parameters: - description: Repository Group ID. in: path @@ -3732,34 +3763,21 @@ paths: schema: items: properties: - created_at: - description: 'Example: 2019-01-02T11:02:08.000Z' - type: string - duration: - description: 'Example: 183 days 22:08:37.000000000' - type: string - merged_at: - description: 'Example: 2019-07-05T09:10:45.000Z' - type: string - pull_request_id: - description: 'Example: 25374' + sub_protject_count: + description: 'Example: 2' type: integer - repo_name: - description: 'Example: graphql-spec' - type: string type: array tags: - evolution - /repos/:repo_id/reviews: + /repo-groups/:repo_group_id/closed-issues-count: get: - description: 'Time series of number of new reviews / pull requests opened within - a certain period. ' + description: 'Count of closed issues. ' externalDocs: description: CHAOSS Metric Definition - url: https://github.com/chaoss/wg-evolution/blob/master/metrics/reviews.md - operationId: Reviews (Repo) + url: https://github.com/chaoss/wg-evolution/blob/master/metrics/contributors-new.md + operationId: Closed Issues Count (Repo Group) parameters: - - description: Repository Group ID. + - description: Repository Group ID in: path name: repo_group_id schema: @@ -3771,126 +3789,70 @@ paths: schema: type: string type: string - - description: Periodicity specification. - in: path - name: period - schema: - type: string - type: string - - description: 'Beginning date specification. E.g. values: 2018, 2018-05, 2019-05-01' - in: path - name: begin_date - schema: - type: string - type: string - - description: 'Ending date specification. E.g. values: 2018, 2018-05, 2019-05-01' - in: path - name: end_date - schema: - type: string - type: string responses: '200': description: OK schema: items: properties: + closed_count: + description: 'Example: 26' + type: integer date: - description: 'Example: 2016-01-01T00:00:00.000Z' + description: 'Example: 2018-11-26T00:00:00.000Z' type: string - pull_requests: - description: 'Example: 37' + repo_id: + description: 'Example: 21681' type: integer - repo_name: - description: 'Example: graphql-spec' - type: string type: array tags: - evolution - /repos/:repo_id/reviews-accepted: + /repos/:repo_id/closed-issues-count: get: - description: 'Time series of number of accepted reviews / pull requests opened - within a certain period. ' + description: 'Count of closed issues. ' externalDocs: description: CHAOSS Metric Definition - url: https://github.com/chaoss/wg-evolution/blob/master/metrics/Reviews_Accepted.md - operationId: Reviews Accepted (Repo) + url: https://github.com/chaoss/wg-evolution/blob/master/metrics/contributors-new.md + operationId: Closed Issues Count (Repo) parameters: - - description: Repository Group ID. + - description: Repository Group ID in: path name: repo_group_id schema: type: string type: string - - description: Repository ID. - in: path - name: repo_id - schema: - type: string - type: string - - description: Periodicity specification. - in: path - name: period - schema: - type: string - type: string - - description: 'Beginning date specification. E.g. values: 2018, 2018-05, 2019-05-01' - in: path - name: begin_date - schema: - type: string - type: string - - description: 'Ending date specification. E.g. values: 2018, 2018-05, 2019-05-01' - in: path - name: end_date - schema: - type: string - type: string responses: '200': description: OK schema: items: properties: + closed_count: + description: 'Example: 4' + type: integer date: - description: 'Example: 2016-01-01T00:00:00.000Z' + description: 'Example: 2014-06-02T00:00:00.000Z' type: string - pull_requests: - description: 'Example: 30' - type: integer - repo_name: - description: 'Example: graphql-spec' + rg_name: + description: 'Example: Apache' type: string type: array tags: - evolution - /repos/:repo_id/reviews-declined: + /repo-groups/:repo_group_id/issue-duration: get: - description: 'Time series of number of declined reviews / pull requests opened - within a certain period. ' + description: 'Time since an issue is proposed until it is closed. ' externalDocs: description: CHAOSS Metric Definition - url: https://github.com/chaoss/wg-evolution/blob/master/metrics/Reviews_Accepted.md - operationId: Reviews Declined (Repo) + url: https://github.com/chaoss/wg-evolution/blob/master/focus_areas/code_development.md + operationId: Issue Duration (Repo Group) parameters: - - description: Repository Group ID. + - description: Repository Group ID in: path name: repo_group_id schema: type: string type: string - - description: Repository ID. - in: path - name: repo_id - schema: - type: string - type: string - - description: Periodicity specification. - in: path - name: period - schema: - type: string - type: string - description: 'Beginning date specification. E.g. values: 2018, 2018-05, 2019-05-01' in: path name: begin_date @@ -3909,25 +3871,34 @@ paths: schema: items: properties: - date: - description: 'Example: 2016-01-01T00:00:00.000Z' + closed_at: + description: 'Example: 2011-05-06T20:21:47.000Z' type: string - pull_requests: - description: 'Example: 11' + created_at: + description: 'Example: 2011-05-06T20:20:05.000Z' + type: string + duration: + description: 'Example: 0 days 00:01:42.000000000' + type: string + issue_id: + description: 'Example: 50320' + type: integer + repo_id: + description: 'Example: 21017' type: integer repo_name: - description: 'Example: graphql-spec' + description: 'Example: ssl_requirement' type: string type: array tags: - evolution - /repos/:repo_id/sub-projects: + /repos/:repo_id/releases: get: - description: 'Number of sub-projects. ' + description: 'Time since an review/pull request is proposed until it is accepted. ' externalDocs: description: CHAOSS Metric Definition - url: https://github.com/chaoss/wg-evolution/blob/master/metrics/sub-projects.md - operationId: Sub-Projects (Repo) + url: https://github.com/chaoss/wg-evolution/blob/master/metrics/Reviews_Duration.md + operationId: Number of releases (Repo) parameters: - description: Repository Group ID. in: path @@ -3941,15 +3912,38 @@ paths: schema: type: string type: string - - description: 'Beginning date specification. E.g. values: 2018, 2018-05, 2019-05-01' - in: path - name: begin_date - schema: - type: string - type: string - - description: 'Ending date specification. E.g. values: 2018, 2018-05, 2019-05-01' + responses: + '200': + description: OK + schema: + items: + properties: + latest: + description: 'Example: 2019-11-02T11:02:08.000Z' + type: string + total_count: + description: 'Example: 35' + type: integer + latest_patch_release: + description: 'Example: 2019-01-02T15:20:07.000Z' + type: string + total_patch_count: + description: 'Example: 21' + type: integer + type: array + tags: + - evolution + /repo-groups/:repo_group_id/open-issues-count: + get: + description: 'Count of open issues. ' + externalDocs: + description: CHAOSS Metric Definition + url: https://github.com/chaoss/wg-evolution/blob/master/metrics/Issues_New.md + operationId: Open Issues Count (Repo Group) + parameters: + - description: Repository Group ID in: path - name: end_date + name: repo_group_id schema: type: string type: string @@ -3959,9 +3953,15 @@ paths: schema: items: properties: - sub_protject_count: - description: 'Example: 2' + date: + description: 'Example: 2017-09-11T00:00:00.000Z' + type: string + open_count: + description: 'Example: 1' type: integer + rg_name: + description: 'Example: Netflix' + type: string type: array tags: - evolution From 9955198cd5f6b6f9d5bd3feb56442294edb7b801 Mon Sep 17 00:00:00 2001 From: Andrew Brain <61482022+ABrain7710@users.noreply.github.com> Date: Thu, 19 Aug 2021 13:31:43 -0500 Subject: [PATCH 09/17] Reorder value endpoint docs Signed-off-by: Andrew Brain <61482022+ABrain7710@users.noreply.github.com> --- docs/source/rest-api/spec.yml | 134 +++++++++++++++++----------------- 1 file changed, 67 insertions(+), 67 deletions(-) diff --git a/docs/source/rest-api/spec.yml b/docs/source/rest-api/spec.yml index a505854a8a..91895959c7 100644 --- a/docs/source/rest-api/spec.yml +++ b/docs/source/rest-api/spec.yml @@ -3997,39 +3997,45 @@ paths: type: array tags: - value - /repo-groups/:repo_group_id/watchers-count: + /repos/:repo_id/watchers: get: - description: Watchers count. - operationId: Watchers Count (Repo Group) + description: A time series of watchers count. + operationId: Watchers (Repo) parameters: - - description: Repository Group ID + - description: Repository Group ID. in: path name: repo_group_id schema: type: string type: string + - description: Repository ID. + in: path + name: repo_id + schema: + type: string + type: string responses: '200': description: OK schema: items: properties: - repo_id: - description: 'Example: 21039' - type: integer + date: + description: 'Example: 2019-07-03T23:22:26.000Z' + type: string repo_name: - description: 'Example: rails_xss' + description: 'Example: airflow' type: string watchers: - description: 'Example: 20' + description: 'Example: 649' type: integer type: array tags: - value - /repo-groups/:repo_group_id/stars: + /repo-groups/:repo_group_id/watchers-count: get: - description: A time series of stars count. - operationId: Stars (Repo Group) + description: Watchers count. + operationId: Watchers Count (Repo Group) parameters: - description: Repository Group ID in: path @@ -4043,67 +4049,61 @@ paths: schema: items: properties: - date: - description: 'Example: 2019-07-03T23:23:36.000Z' - type: string repo_id: - description: 'Example: 21491' + description: 'Example: 21039' type: integer repo_name: - description: 'Example: commons-io' + description: 'Example: rails_xss' type: string - stars: - description: 'Example: 600' + watchers: + description: 'Example: 20' type: integer type: array tags: - value - /repo-groups/:repo_group_id/stars-count: + /repos/:repo_id/watchers-count: get: - description: Stars count. - operationId: Stars Count (Repo Group) + description: Watchers count. + operationId: Watchers Count (Repo) parameters: - - description: Repository Group ID + - description: Repository Group ID. in: path name: repo_group_id schema: type: string type: string + - description: Repository ID. + in: path + name: repo_id + schema: + type: string + type: string responses: '200': description: OK schema: items: properties: - repo_id: - description: 'Example: 21364' - type: integer repo_name: - description: 'Example: irs_process_scripts' + description: 'Example: airflow' type: string - stars: - description: 'Example: 20' + watchers: + description: 'Example: 649' type: integer type: array tags: - value - /repos/:repo_id/stars: + /repo-groups/:repo_group_id/stars: get: description: A time series of stars count. - operationId: Stars (Repo) + operationId: Stars (Repo Group) parameters: - - description: Repository Group ID. + - description: Repository Group ID in: path name: repo_group_id schema: type: string type: string - - description: Repository ID. - in: path - name: repo_id - schema: - type: string - type: string responses: '200': description: OK @@ -4111,21 +4111,24 @@ paths: items: properties: date: - description: 'Example: 2019-07-03T23:27:42.000Z' + description: 'Example: 2019-07-03T23:23:36.000Z' type: string + repo_id: + description: 'Example: 21491' + type: integer repo_name: - description: 'Example: graphiql' + description: 'Example: commons-io' type: string stars: - description: 'Example: 8652' + description: 'Example: 600' type: integer type: array tags: - value - /repos/:repo_id/stars-count: + /repos/:repo_id/stars: get: - description: Stars count. - operationId: Stars Count (Repo) + description: A time series of stars count. + operationId: Stars (Repo) parameters: - description: Repository Group ID. in: path @@ -4145,54 +4148,51 @@ paths: schema: items: properties: + date: + description: 'Example: 2019-07-03T23:27:42.000Z' + type: string repo_name: description: 'Example: graphiql' type: string stars: - description: 'Example: 8653' + description: 'Example: 8652' type: integer type: array tags: - value - /repos/:repo_id/watchers: + /repo-groups/:repo_group_id/stars-count: get: - description: A time series of watchers count. - operationId: Watchers (Repo) + description: Stars count. + operationId: Stars Count (Repo Group) parameters: - - description: Repository Group ID. + - description: Repository Group ID in: path name: repo_group_id schema: type: string type: string - - description: Repository ID. - in: path - name: repo_id - schema: - type: string - type: string responses: '200': description: OK schema: items: properties: - date: - description: 'Example: 2019-07-03T23:22:26.000Z' - type: string + repo_id: + description: 'Example: 21364' + type: integer repo_name: - description: 'Example: airflow' + description: 'Example: irs_process_scripts' type: string - watchers: - description: 'Example: 649' + stars: + description: 'Example: 20' type: integer type: array tags: - value - /repos/:repo_id/watchers-count: + /repos/:repo_id/stars-count: get: - description: Watchers count. - operationId: Watchers Count (Repo) + description: Stars count. + operationId: Stars Count (Repo) parameters: - description: Repository Group ID. in: path @@ -4213,10 +4213,10 @@ paths: items: properties: repo_name: - description: 'Example: airflow' + description: 'Example: graphiql' type: string - watchers: - description: 'Example: 649' + stars: + description: 'Example: 8653' type: integer type: array tags: From 2d6ba22a4ee2471c7656ceefeb7a6446b07f933a Mon Sep 17 00:00:00 2001 From: Andrew Brain <61482022+ABrain7710@users.noreply.github.com> Date: Fri, 20 Aug 2021 11:54:10 -0500 Subject: [PATCH 10/17] Seperate the code blocks for each Chaoss Working Group Signed-off-by: Andrew Brain <61482022+ABrain7710@users.noreply.github.com> --- docs/source/rest-api/spec.yml | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/docs/source/rest-api/spec.yml b/docs/source/rest-api/spec.yml index 91895959c7..a03581058d 100644 --- a/docs/source/rest-api/spec.yml +++ b/docs/source/rest-api/spec.yml @@ -9,6 +9,7 @@ info: version: 0.12.0 openapi: 3.0.0 paths: + #utility endpoints /repo-groups: get: description: Get all the downloaded repo groups. @@ -235,6 +236,10 @@ paths: type: array tags: - utility + + + + #risk endpoints /repo-groups/:repo_group_id/average-issue-resolution-time: get: description: 'The average issue resolution time. ' @@ -829,6 +834,10 @@ paths: type: array tags: - risk + + + + #experimental endpoints /repo-groups/:repo_group_id/aggregate-summary: get: description: Returns the current count of watchers, stars, and forks and the @@ -1596,6 +1605,10 @@ paths: type: array tags: - experimental + + + + #evolution endpoints /repo-groups/:repo_group_id/code-changes: get: description: 'Time series of number of commits during a certain period. ' @@ -3965,6 +3978,10 @@ paths: type: array tags: - evolution + + + + #value endpoints /repo-groups/:repo_group_id/watchers: get: description: A time series of watchers count. @@ -4221,6 +4238,10 @@ paths: type: array tags: - value + + + + #visualization endpoints /contributor_reports/new_contributors_bar/: get: description: Get bar chart of new contributor counts. From f1b8efd14b4849c5879be73add2c0f65e1639331 Mon Sep 17 00:00:00 2001 From: Andrew Brain <61482022+ABrain7710@users.noreply.github.com> Date: Fri, 20 Aug 2021 12:34:01 -0500 Subject: [PATCH 11/17] Add undocumented endpoint (licenses-declared by repo_id) Signed-off-by: Andrew Brain <61482022+ABrain7710@users.noreply.github.com> --- docs/source/rest-api/spec.yml | 43 +++++++++++++++++++++++++++++++++-- 1 file changed, 41 insertions(+), 2 deletions(-) diff --git a/docs/source/rest-api/spec.yml b/docs/source/rest-api/spec.yml index a03581058d..51b52d9fd6 100644 --- a/docs/source/rest-api/spec.yml +++ b/docs/source/rest-api/spec.yml @@ -99,7 +99,7 @@ paths: /owner/:owner/repo/:repo: get: description: Get the repo_group_id and repo_id of a particular repo. - operationId: Get Repo by Owner and Repo + operationId: Get Repo by Owner and Repo Name responses: '200': description: OK @@ -834,6 +834,45 @@ paths: type: array tags: - risk + /repo-groups/:repo_id/license-count: + get: + description: 'The declared software package license (fetched from CII Best Practices + badging data). ' + externalDocs: + description: CHAOSS Metric Definition + url: https://github.com/chaoss/wg-risk/blob/master/focus-areas/licensing.md + operationId: License Count (Repo) + parameters: + - description: Repository Group ID + in: path + name: repo_group_id + schema: + type: string + type: string + - description: Repository ID. + in: path + name: repo_id + schema: + type: string + type: string + responses: + '200': + description: OK + schema: + items: + properties: + file_without_licenses: + description: 'Example: True' + type: string + name: + description: 'Example: ActorServiceRegistry' + type: string + number_of_license: + description: 'Example: 2' + type: integer + type: array + tags: + - risk @@ -4240,7 +4279,7 @@ paths: - value - + #visualization endpoints /contributor_reports/new_contributors_bar/: get: From 2c874731001e6667c0feb01f2484c04b53162b95 Mon Sep 17 00:00:00 2001 From: Andrew Brain <61482022+ABrain7710@users.noreply.github.com> Date: Fri, 20 Aug 2021 12:36:42 -0500 Subject: [PATCH 12/17] Add undocumented endpoint (languages by repo_id) Signed-off-by: Andrew Brain <61482022+ABrain7710@users.noreply.github.com> --- docs/source/rest-api/spec.yml | 35 +++++++++++++++++++++++++++++++++++ 1 file changed, 35 insertions(+) diff --git a/docs/source/rest-api/spec.yml b/docs/source/rest-api/spec.yml index 51b52d9fd6..15b054ccff 100644 --- a/docs/source/rest-api/spec.yml +++ b/docs/source/rest-api/spec.yml @@ -801,6 +801,41 @@ paths: type: array tags: - risk + /repo-groups/:repo_id/languages: + get: + description: 'The primary language of the repository. ' + externalDocs: + description: CHAOSS Metric Definition + url: https://github.com/chaoss/wg-risk/blob/master/focus-areas/security.md + operationId: Languages (Repo) + parameters: + - description: Repository Group ID + in: path + name: repo_group_id + schema: + type: string + type: string + - description: Repository ID. + in: path + name: repo_id + schema: + type: string + type: string + responses: + '200': + description: OK + schema: + items: + properties: + primary_language: + description: 'Example: Go' + type: string + repo_id: + description: 'Example: 21277' + type: integer + type: array + tags: + - risk /repo-groups/:repo_group_id/license-count: get: description: 'The declared software package license (fetched from CII Best Practices From 1d491bdc217cc3e9d47c948fc031e22c9c1b0e64 Mon Sep 17 00:00:00 2001 From: Andrew Brain <61482022+ABrain7710@users.noreply.github.com> Date: Fri, 20 Aug 2021 13:54:32 -0500 Subject: [PATCH 13/17] Add more undocumented endpoints Signed-off-by: Andrew Brain <61482022+ABrain7710@users.noreply.github.com> --- docs/source/rest-api/spec.yml | 70 +++++++++++++++++++++++++++++++++++ 1 file changed, 70 insertions(+) diff --git a/docs/source/rest-api/spec.yml b/docs/source/rest-api/spec.yml index 15b054ccff..83997e6b88 100644 --- a/docs/source/rest-api/spec.yml +++ b/docs/source/rest-api/spec.yml @@ -1598,6 +1598,35 @@ paths: tags: - experimental /repo-groups/:repo_group_id/abandoned-issues: + get: + description: List of abandoned issues (last updated >= 1 year ago) + operationId: Abandoned Issues (Repo Group) + parameters: + - description: Repository Group ID + in: path + name: repo_group_id + schema: + type: string + type: string + responses: + '200': + description: OK + schema: + items: + properties: + issue_id: + description: 'Example: 125071' + type: integer + repo_id: + description: 'Example: 22004' + type: integer + updated_at: + description: 'Example: 2017-10-30T06:52:19.000Z' + type: string + type: array + tags: + - experimental + /repo-groups/:repo_id/abandoned-issues: get: description: List of abandoned issues (last updated >= 1 year ago) operationId: Abandoned Issues (Repo) @@ -1633,6 +1662,47 @@ paths: tags: - experimental /repo-groups/:repo_group_id/lines-changed-by-author: + get: + description: 'Count of closed issues. ' + externalDocs: + description: CHAOSS Metric Definition + url: https://github.com/chaoss/wg-evolution/blob/master/metrics/contributors-new.md + operationId: Lines Changed by Author (Repo Group) + parameters: + - description: Repository Group ID + in: path + name: repo_group_id + schema: + type: string + type: string + responses: + '200': + description: OK + schema: + items: + properties: + additions: + description: 'Example: 25611' + type: integer + affiliation: + description: 'Example: NULL' + type: string + cmt_author_date: + description: 'Example: 2004-11-24' + type: string + cmt_author_email: + description: 'Example: david@loudthinking.com' + type: string + deletions: + description: 'Example: 296' + type: integer + whitespace: + description: 'Example: 5279' + type: integer + type: array + tags: + - experimental + /repo-groups/:repo_id/lines-changed-by-author: get: description: 'Count of closed issues. ' externalDocs: From 8ed22adadb3ac5f0e7748970438dda50accd7cf9 Mon Sep 17 00:00:00 2001 From: Andrew Brain <61482022+ABrain7710@users.noreply.github.com> Date: Fri, 20 Aug 2021 15:57:02 -0500 Subject: [PATCH 14/17] Remove rg-id from repo_id endpoints in the value group Signed-off-by: Andrew Brain <61482022+ABrain7710@users.noreply.github.com> --- docs/source/rest-api/spec.yml | 24 ------------------------ 1 file changed, 24 deletions(-) diff --git a/docs/source/rest-api/spec.yml b/docs/source/rest-api/spec.yml index 83997e6b88..f40d4ff9a6 100644 --- a/docs/source/rest-api/spec.yml +++ b/docs/source/rest-api/spec.yml @@ -4163,12 +4163,6 @@ paths: description: A time series of watchers count. operationId: Watchers (Repo) parameters: - - description: Repository Group ID. - in: path - name: repo_group_id - schema: - type: string - type: string - description: Repository ID. in: path name: repo_id @@ -4227,12 +4221,6 @@ paths: description: Watchers count. operationId: Watchers Count (Repo) parameters: - - description: Repository Group ID. - in: path - name: repo_group_id - schema: - type: string - type: string - description: Repository ID. in: path name: repo_id @@ -4291,12 +4279,6 @@ paths: description: A time series of stars count. operationId: Stars (Repo) parameters: - - description: Repository Group ID. - in: path - name: repo_group_id - schema: - type: string - type: string - description: Repository ID. in: path name: repo_id @@ -4355,12 +4337,6 @@ paths: description: Stars count. operationId: Stars Count (Repo) parameters: - - description: Repository Group ID. - in: path - name: repo_group_id - schema: - type: string - type: string - description: Repository ID. in: path name: repo_id From 4fed9124e3c207c1ebc6c3180ed4f5817d120f22 Mon Sep 17 00:00:00 2001 From: Andrew Brain <61482022+ABrain7710@users.noreply.github.com> Date: Fri, 20 Aug 2021 16:04:37 -0500 Subject: [PATCH 15/17] Remove rg-id from repo_id endpoints in the risk group Signed-off-by: Andrew Brain <61482022+ABrain7710@users.noreply.github.com> --- docs/source/rest-api/spec.yml | 54 ----------------------------------- 1 file changed, 54 deletions(-) diff --git a/docs/source/rest-api/spec.yml b/docs/source/rest-api/spec.yml index f40d4ff9a6..04867021da 100644 --- a/docs/source/rest-api/spec.yml +++ b/docs/source/rest-api/spec.yml @@ -280,12 +280,6 @@ paths: url: https://github.com/chaoss/wg-risk/blob/master/focus-areas/business-risk.md operationId: Average Issue Resolution Time (Repo) parameters: - - description: Repository Group ID. - in: path - name: repo_group_id - schema: - type: string - type: string - description: Repository ID. in: path name: repo_id @@ -347,12 +341,6 @@ paths: url: https://github.com/chaoss/wg-risk/blob/master/focus-areas/security.md operationId: CII Best Practices Badge (Repo) parameters: - - description: Repository Group ID. - in: path - name: repo_group_id - schema: - type: string - type: string - description: Repository ID. in: path name: repo_id @@ -433,12 +421,6 @@ paths: url: https://github.com/chaoss/wg-risk/blob/master/metrics/Committers.md operationId: Committers (Repo) parameters: - - description: Repository Group ID. - in: path - name: repo_group_id - schema: - type: string - type: string - description: Repository ID. in: path name: repo_id @@ -524,12 +506,6 @@ paths: url: https://github.com/chaoss/wg-risk/blob/master/focus-areas/business-risk.md operationId: Fork Count (Repo) parameters: - - description: Repository Group ID. - in: path - name: repo_group_id - schema: - type: string - type: string - description: Repository ID. in: path name: repo_id @@ -594,12 +570,6 @@ paths: url: https://github.com/chaoss/wg-risk/blob/master/focus-areas/business-risk.md operationId: Forks (Repo) parameters: - - description: Repository Group ID. - in: path - name: repo_group_id - schema: - type: string - type: string - description: Repository ID. in: path name: repo_id @@ -668,12 +638,6 @@ paths: url: https://github.com/chaoss/wg-risk/blob/master/metrics/License_Coverage.md operationId: License Coverage (Repo) parameters: - - description: Repository Group ID. - in: path - name: repo_group_id - schema: - type: string - type: string - description: Repository ID. in: path name: repo_id @@ -742,12 +706,6 @@ paths: url: https://github.com/chaoss/wg-risk/blob/master/metrics/License_Coverage.md operationId: License Declared (Repo) parameters: - - description: Repository Group ID. - in: path - name: repo_group_id - schema: - type: string - type: string - description: Repository ID. in: path name: repo_id @@ -809,12 +767,6 @@ paths: url: https://github.com/chaoss/wg-risk/blob/master/focus-areas/security.md operationId: Languages (Repo) parameters: - - description: Repository Group ID - in: path - name: repo_group_id - schema: - type: string - type: string - description: Repository ID. in: path name: repo_id @@ -878,12 +830,6 @@ paths: url: https://github.com/chaoss/wg-risk/blob/master/focus-areas/licensing.md operationId: License Count (Repo) parameters: - - description: Repository Group ID - in: path - name: repo_group_id - schema: - type: string - type: string - description: Repository ID. in: path name: repo_id From c2395773f08bab54e80c268a6796dbb3cb344d3c Mon Sep 17 00:00:00 2001 From: Andrew Brain <61482022+ABrain7710@users.noreply.github.com> Date: Fri, 20 Aug 2021 16:11:40 -0500 Subject: [PATCH 16/17] Remove rg-id from repo_id endpoints in the experimental group Signed-off-by: Andrew Brain <61482022+ABrain7710@users.noreply.github.com> --- docs/source/rest-api/spec.yml | 52 ++++------------------------------- 1 file changed, 5 insertions(+), 47 deletions(-) diff --git a/docs/source/rest-api/spec.yml b/docs/source/rest-api/spec.yml index 04867021da..3fb8d45f0c 100644 --- a/docs/source/rest-api/spec.yml +++ b/docs/source/rest-api/spec.yml @@ -917,12 +917,6 @@ paths: beginning and end date (default between now and 365 days ago). operationId: Aggregate Summary (Repo) parameters: - - description: Repository Group ID. - in: path - name: repo_group_id - schema: - type: string - type: string - description: Repository ID. in: path name: repo_id @@ -972,7 +966,7 @@ paths: get: description: 'This is an Augur-specific metric. We are currently working to define these more formally. ' - operationId: Annual Commit Count Ranked by New Repo in Repo Group (Repo) + operationId: Annual Commit Count Ranked by New Repo in Repo Group (Repo Group) parameters: - description: Repository Group ID. in: path @@ -1032,7 +1026,7 @@ paths: get: description: 'This is an Augur-specific metric. We are currently working to define these more formally. ' - operationId: Annual Commit Count Ranked by Repo in Repo Group (Repo) + operationId: Annual Commit Count Ranked by Repo in Repo Group (Repo Group) parameters: - description: Base64 version of the URL of the GitHub repository as it appears in the Facade DB @@ -1066,7 +1060,7 @@ paths: get: description: 'This is an Augur-specific metric. We are currently working to define these more formally. ' - operationId: Annual Lines of Code Ranked by New Repo in Repo Group (Repo) + operationId: Annual Lines of Code Ranked by New Repo in Repo Group (Repo Group) parameters: - description: Base64 version of the URL of the GitHub repository as it appears in the Facade DB @@ -1100,7 +1094,7 @@ paths: get: description: 'This is an Augur-specific metric. We are currently working to define these more formally. ' - operationId: Annual Lines of Code Ranked by Repo in Repo Group (Repo) + operationId: Annual Lines of Code Ranked by Repo in Repo Group (Repo Group) parameters: - description: Base64 version of the URL of the GitHub repository as it appears in the Facade DB @@ -1171,12 +1165,6 @@ paths: description: Mean(Average) of issue comments per day. operationId: Issue Comments Mean (Repo) parameters: - - description: Repository Group ID. - in: path - name: repo_group_id - schema: - type: string - type: string - description: Repository ID. in: path name: repo_id @@ -1242,12 +1230,6 @@ paths: description: Mean(Average) and Standard Deviation of issue comments per day. operationId: Issue Comments Mean Std (Repo) parameters: - - description: Repository Group ID. - in: path - name: repo_group_id - schema: - type: string - type: string - description: Repository ID. in: path name: repo_id @@ -1329,12 +1311,6 @@ paths: a date) operationId: Pull Request Acceptance Rate (Repo) parameters: - - description: Repository Group ID. - in: path - name: repo_group_id - schema: - type: string - type: string - description: Repository ID. in: path name: repo_id @@ -1371,7 +1347,7 @@ paths: /repo-groups/:repo_group_id/pull-requests-closed-no-merge: get: description: Timeseries of pull request which were closed but not merged - operationId: Pull Request Closed but Not Merged (Repo) + operationId: Pull Request Closed but Not Merged (Repo Group) parameters: - description: Repository Group ID. in: path @@ -1496,12 +1472,6 @@ paths: description: Returns a list of contributors contributing N% of all commits. operationId: Top Committers (Repo) parameters: - - description: Repository Group ID. - in: path - name: repo_group_id - schema: - type: string - type: string - description: Repository ID. in: path name: repo_id @@ -1577,12 +1547,6 @@ paths: description: List of abandoned issues (last updated >= 1 year ago) operationId: Abandoned Issues (Repo) parameters: - - description: Repository Group ID - in: path - name: repo_group_id - schema: - type: string - type: string - description: Repository ID. in: path name: repo_id @@ -1656,12 +1620,6 @@ paths: url: https://github.com/chaoss/wg-evolution/blob/master/metrics/contributors-new.md operationId: Lines Changed by Author (Repo) parameters: - - description: Repository Group ID - in: path - name: repo_group_id - schema: - type: string - type: string - description: Repository ID. in: path name: repo_id From 6321e197326ec914734648d45cd536fc7aba8148 Mon Sep 17 00:00:00 2001 From: Andrew Brain <61482022+ABrain7710@users.noreply.github.com> Date: Fri, 20 Aug 2021 16:36:11 -0500 Subject: [PATCH 17/17] Remove rg-id from repo_id endpoints in the evolution group Signed-off-by: Andrew Brain <61482022+ABrain7710@users.noreply.github.com> --- docs/source/rest-api/spec.yml | 136 +--------------------------------- 1 file changed, 2 insertions(+), 134 deletions(-) diff --git a/docs/source/rest-api/spec.yml b/docs/source/rest-api/spec.yml index 3fb8d45f0c..3eef959f61 100644 --- a/docs/source/rest-api/spec.yml +++ b/docs/source/rest-api/spec.yml @@ -1718,12 +1718,6 @@ paths: url: https://github.com/chaoss/wg-evolution/blob/master/metrics/Code_Changes.md operationId: Code Changes (Repo) parameters: - - description: Repository Group ID. - in: path - name: repo_group_id - schema: - type: string - type: string - description: Repository ID. in: path name: repo_id @@ -1830,12 +1824,6 @@ paths: url: https://github.com/chaoss/wg-evolution/blob/master/metrics/Code_Changes_Lines.md operationId: Code Changes Lines (Repo) parameters: - - description: Repository Group ID. - in: path - name: repo_group_id - schema: - type: string - type: string - description: Repository ID. in: path name: repo_id @@ -1954,12 +1942,6 @@ paths: url: https://github.com/chaoss/wg-evolution/blob/master/metrics/contributors.md operationId: Contributors (Repo) parameters: - - description: Repository Group ID. - in: path - name: repo_group_id - schema: - type: string - type: string - description: Repository ID. in: path name: repo_id @@ -2072,12 +2054,6 @@ paths: url: https://github.com/chaoss/wg-evolution/blob/master/metrics/contributors-new.md operationId: New Contributors (Repo) parameters: - - description: Repository Group ID. - in: path - name: repo_group_id - schema: - type: string - type: string - description: Repository ID. in: path name: repo_id @@ -2163,12 +2139,6 @@ paths: url: https://github.com/chaoss/wg-evolution/blob/master/focus_areas/code_development.md operationId: Issue Duration (Repo) parameters: - - description: Repository Group ID. - in: path - name: repo_group_id - schema: - type: string - type: string - description: Repository ID. in: path name: repo_id @@ -2269,12 +2239,6 @@ paths: url: https://github.com/chaoss/wg-evolution/blob/master/focus_areas/code_development.md operationId: Issue Participants (Repo) parameters: - - description: Repository Group ID. - in: path - name: repo_group_id - schema: - type: string - type: string - description: Repository ID. in: path name: repo_id @@ -2354,12 +2318,6 @@ paths: url: https://github.com/chaoss/wg-evolution/blob/master/focus_areas/code_development.md operationId: Issue Throughput (Repo) parameters: - - description: Repository Group ID. - in: path - name: repo_group_id - schema: - type: string - type: string - description: Repository ID. in: path name: repo_id @@ -2444,12 +2402,6 @@ paths: url: https://github.com/chaoss/wg-evolution/blob/master/metrics/Issues_Active.md operationId: Issues Active (Repo) parameters: - - description: Repository Group ID. - in: path - name: repo_group_id - schema: - type: string - type: string - description: Repository ID. in: path name: repo_id @@ -2553,12 +2505,6 @@ paths: url: https://github.com/chaoss/wg-evolution/blob/master/metrics/Issues_New.md operationId: Issues Closed (Repo) parameters: - - description: Repository Group ID. - in: path - name: repo_group_id - schema: - type: string - type: string - description: Repository ID. in: path name: repo_id @@ -2650,12 +2596,6 @@ paths: url: https://github.com/chaoss/wg-evolution/blob/master/metrics/issues-closed-resolution-duration.md operationId: Closed Issue Resolution Duration (Repo) parameters: - - description: Repository Group ID. - in: path - name: repo_group_id - schema: - type: string - type: string - description: Repository ID. in: path name: repo_id @@ -2753,12 +2693,6 @@ paths: url: https://github.com/chaoss/wg-evolution/blob/master/metrics/issues-first-time-closed.md operationId: Closed Issues New Contributors (Repo) parameters: - - description: Repository Group ID. - in: path - name: repo_group_id - schema: - type: string - type: string - description: Repository ID. in: path name: repo_id @@ -2862,12 +2796,6 @@ paths: url: https://github.com/chaoss/wg-evolution/blob/master/metrics/issues-first-time-opened.md operationId: New Contributors of Issues (Repo) parameters: - - description: Repository Group ID. - in: path - name: repo_group_id - schema: - type: string - type: string - description: Repository ID. in: path name: repo_id @@ -2962,12 +2890,6 @@ paths: url: https://github.com/chaoss/wg-evolution/blob/master/metrics/issues-maintainer-response-duration.md operationId: Issue Response Time (Repo) parameters: - - description: Repository Group ID - in: path - name: repo_group_id - schema: - type: string - type: string - description: Repository ID. in: path name: repo_id @@ -3065,12 +2987,6 @@ paths: url: https://github.com/chaoss/wg-evolution/blob/master/metrics/Issues_New.md operationId: Issues New (Repo) parameters: - - description: Repository Group ID. - in: path - name: repo_group_id - schema: - type: string - type: string - description: Repository ID. in: path name: repo_id @@ -3159,12 +3075,6 @@ paths: url: https://github.com/chaoss/wg-evolution/blob/master/metrics/issues-open-age.md operationId: Open Issue Age (Repo) parameters: - - description: Repository Group ID. - in: path - name: repo_group_id - schema: - type: string - type: string - description: Repository ID. in: path name: repo_id @@ -3258,12 +3168,6 @@ paths: url: https://github.com/chaoss/wg-evolution/blob/master/metrics/pull-requests-merge-contributor-new.md operationId: New Contributors of Commits (Repo) parameters: - - description: Repository Group ID. - in: path - name: repo_group_id - schema: - type: string - type: string - description: Repository ID. in: path name: repo_id @@ -3367,12 +3271,6 @@ paths: url: https://github.com/chaoss/wg-evolution/blob/master/metrics/Reviews_Duration.md operationId: Review Duration (Repo) parameters: - - description: Repository Group ID. - in: path - name: repo_group_id - schema: - type: string - type: string - description: Repository ID. in: path name: repo_id @@ -3478,12 +3376,6 @@ paths: url: https://github.com/chaoss/wg-evolution/blob/master/metrics/reviews.md operationId: Reviews (Repo) parameters: - - description: Repository Group ID. - in: path - name: repo_group_id - schema: - type: string - type: string - description: Repository ID. in: path name: repo_id @@ -3589,12 +3481,6 @@ paths: url: https://github.com/chaoss/wg-evolution/blob/master/metrics/Reviews_Accepted.md operationId: Reviews Accepted (Repo) parameters: - - description: Repository Group ID. - in: path - name: repo_group_id - schema: - type: string - type: string - description: Repository ID. in: path name: repo_id @@ -3700,12 +3586,6 @@ paths: url: https://github.com/chaoss/wg-evolution/blob/master/metrics/Reviews_Accepted.md operationId: Reviews Declined (Repo) parameters: - - description: Repository Group ID. - in: path - name: repo_group_id - schema: - type: string - type: string - description: Repository ID. in: path name: repo_id @@ -3794,12 +3674,6 @@ paths: url: https://github.com/chaoss/wg-evolution/blob/master/metrics/sub-projects.md operationId: Sub-Projects (Repo) parameters: - - description: Repository Group ID. - in: path - name: repo_group_id - schema: - type: string - type: string - description: Repository ID. in: path name: repo_id @@ -3876,9 +3750,9 @@ paths: url: https://github.com/chaoss/wg-evolution/blob/master/metrics/contributors-new.md operationId: Closed Issues Count (Repo) parameters: - - description: Repository Group ID + - description: Repository ID in: path - name: repo_group_id + name: repo_id schema: type: string type: string @@ -3961,12 +3835,6 @@ paths: url: https://github.com/chaoss/wg-evolution/blob/master/metrics/Reviews_Duration.md operationId: Number of releases (Repo) parameters: - - description: Repository Group ID. - in: path - name: repo_group_id - schema: - type: string - type: string - description: Repository ID. in: path name: repo_id