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