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] 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