CPUB-374 Remove documentation of endpoints that are going away (#15590)

This commit is contained in:
Chris Ainsworth-Patrick 2022-09-07 15:57:52 +01:00 committed by GitHub
parent cbbb9f1fac
commit 28d93655c8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 22 additions and 203 deletions

View File

@ -49,10 +49,6 @@ tags:
x-displayName: Authentication Endpoints x-displayName: Authentication Endpoints
- name: namespaces - name: namespaces
x-displayName: Namespace data x-displayName: Namespace data
- name: repos
x-displayName: Repository data
description: |
Repository data is only available for specific additional repositories.
- name: discovery - name: discovery
x-displayName: Discovery x-displayName: Discovery
- name: responseDataFile - name: responseDataFile
@ -78,7 +74,6 @@ x-tagGroups:
- authentication - authentication
- discovery - discovery
- namespaces - namespaces
- repos
- name: Models - name: Models
tags: tags:
- responseDataFile - responseDataFile
@ -366,204 +361,6 @@ paths:
application/json: application/json:
schema: schema:
$ref: '#/components/schemas/ResponseData' $ref: '#/components/schemas/ResponseData'
/repos/{namespace}/{repo}/pulls/exports/years:
get:
tags: [repos]
summary: Get years with data
description: Gets a list of years that have data for the given repository
operationId: getRepoYears
parameters:
- in: path
name: namespace
schema:
type: string
required: true
description: Namespace to fetch data for
- in: path
name: repo
schema:
type: string
required: true
description: Repo to fetch data for
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/YearData'
/repos/{namespace}/{repo}/pulls/exports/years/{year}/{timespantype}:
get:
tags: [repos]
summary: Get timespans with data
description: Gets a list of timespans of the given type that have data for the given repository and year
operationId: getRepoTimespans
parameters:
- in: path
name: namespace
schema:
type: string
required: true
description: Namespace to fetch data for
- in: path
name: repo
schema:
type: string
required: true
description: Repo to fetch data for
- in: path
name: year
schema:
type: integer
required: true
description: Year to fetch data for
- in: path
name: timespantype
schema:
$ref: '#/components/schemas/TimespanType'
required: true
description: Type of timespan to fetch data for
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/TimespanData'
/repos/{namespace}/{repo}/pulls/exports/years/{year}/{timespantype}/{timespan}:
get:
tags: [repos]
summary: Get repository metadata for timespan
description: Gets info about data for the given repository and timespan
operationId: getRepoTimespanMetadata
parameters:
- in: path
name: namespace
schema:
type: string
required: true
description: Namespace to fetch data for
- in: path
name: repo
schema:
type: string
required: true
description: Repo to fetch data for
- in: path
name: year
schema:
type: integer
required: true
description: Year to fetch data for
- in: path
name: timespantype
schema:
$ref: '#/components/schemas/TimespanType'
required: true
description: Type of timespan to fetch data for
- in: path
name: timespan
schema:
type: integer
required: true
description: Timespan to fetch data for
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/TimespanModel'
'404':
description: Not Found
/repos/{namespace}/{repo}/pulls/exports/years/{year}/{timespantype}/{timespan}/raw:
get:
tags: [repos]
summary: Get repository data for timespan
description: Gets a list of URLs that can be used to download the raw pull data for the given repository and timespan
operationId: getRepoDataByTimespan
parameters:
- in: path
name: namespace
schema:
type: string
required: true
description: Namespace to fetch data for
- in: path
name: repo
schema:
type: string
required: true
description: Repo to fetch data for
- in: path
name: year
schema:
type: integer
required: true
description: Year to fetch data for
- in: path
name: timespantype
schema:
$ref: '#/components/schemas/TimespanType'
required: true
description: Type of timespan to fetch data for
- in: path
name: timespan
schema:
type: integer
required: true
description: Timespan to fetch data for
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseData'
/repos/{namespace}/{repo}/pulls/exports/years/{year}/{timespantype}/{timespan}/summary:
get:
tags: [repos]
summary: Get repository summary data for timespan
description: Gets a list of URLs that can be used to download the summary pull data for the given repository and timespan
operationId: getRepoSummaryByTimespan
parameters:
- in: path
name: namespace
schema:
type: string
required: true
description: Namespace to fetch data for
- in: path
name: repo
schema:
type: string
required: true
description: Repo to fetch data for
- in: path
name: year
schema:
type: integer
required: true
description: Year to fetch data for
- in: path
name: timespantype
schema:
$ref: '#/components/schemas/TimespanType'
required: true
description: Type of timespan to fetch data for
- in: path
name: timespan
schema:
type: integer
required: true
description: Timespan to fetch data for
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseData'
components: components:
schemas: schemas:
@ -673,6 +470,22 @@ components:
type: array type: array
items: items:
type: string type: string
datasets:
type: array
items:
$ref: '#/components/schemas/DatasetModel'
DatasetModel:
properties:
name:
$ref: '#/components/schemas/DatasetType'
views:
type: array
items:
$ref: '#/components/schemas/DataviewType'
timespans:
type: array
items:
$ref: '#/components/schemas/TimespanType'
YearData: YearData:
properties: properties:
years: years:
@ -706,6 +519,12 @@ components:
TimespanType: TimespanType:
type: string type: string
enum: [months,weeks] enum: [months,weeks]
DataviewType:
type: string
enum: [raw,summary]
DatasetType:
type: string
enum: [pulls]
TimespanModel: TimespanModel:
oneOf: oneOf:
- $ref: '#/components/schemas/MonthModel' - $ref: '#/components/schemas/MonthModel'