forked from ossf/scorecard-webapp
-
Notifications
You must be signed in to change notification settings - Fork 0
/
openapi.yaml
245 lines (233 loc) · 5.97 KB
/
openapi.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
# Copyright 2022 OpenSSF Scorecard Authors
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
swagger: '2.0'
info:
title: OpenSSF Scorecard API
description: API to interact with a project's published Scorecard result
version: 1.0.0
host: api.securityscorecards.dev
schemes:
- http
consumes:
- application/json
produces:
- application/json
x-google-backend:
address: https://scorecard-api-prod-x3pmld2cbq-uc.a.run.app
protocol: h2
x-google-allow: all
paths:
/projects/{platform}/{org}/{repo}/badge:
get:
parameters:
- in: query
name: style
type: string
required: false
default: flat
enum: [
"plastic",
"flat",
"flat-square",
"for-the-badge",
"social"
]
description: Style to render the badge
- in: path
name: platform
type: string
required: true
description: VCS platform. eg. github.com
- in: path
name: org
type: string
required: true
description: Name of the owner/organization of the repository
- in: path
name: repo
type: string
required: true
description: Name of the repository
summary: Get a repository's Scorecard badge
operationId: getBadge
tags:
- badge
responses:
302:
description: Scorecard badge for the repository
default:
$ref: '#/responses/InternalServerError'
/projects/{platform}/{org}/{repo}:
parameters:
- in: path
name: platform
type: string
required: true
description: VCS platform. eg. github.com
- in: path
name: org
type: string
required: true
description: Name of the owner/organization of the repository
- in: path
name: repo
type: string
required: true
description: Name of the repository
get:
summary: Get a repository's ScorecardResult
operationId: getResult
tags:
- results
parameters:
- in: query
name: commit
type: string
description: SHA1 commit hash expressed in hexadecimal format
pattern: '^[0-9a-fA-F]{40}$'
responses:
200:
description: A JSON object of the repository's ScorecardResult
schema:
$ref: '#/definitions/ScorecardResult'
400:
$ref: '#/responses/BadRequest'
404:
$ref: '#/responses/NotFound'
default:
$ref: '#/responses/InternalServerError'
post:
summary: Publish a repository's OIDC verified ScorecardResult
operationId: postResult
tags:
- results
parameters:
- in: body
name: publish
required: true
schema:
$ref: '#/definitions/VerifiedScorecardResult'
responses:
201:
description: Successfully updated ScorecardResult
schema:
type: string
400:
$ref: '#/responses/BadRequest'
default:
$ref: '#/responses/InternalServerError'
definitions:
Error:
type: object
properties:
code:
type: integer
message:
type: string
ScorecardResult:
type: object
properties:
date:
type: string
x-order: 0
repo:
$ref: '#/definitions/Repo'
x-order: 1
scorecard:
type: object
x-order: 2
$ref: '#/definitions/ScorecardVersion'
score:
type: number
x-omitempty: false
x-order: 3
description: Aggregate score of the repository
checks:
type: array
x-order: 4
items:
$ref: '#/definitions/ScorecardCheck'
metadata:
type: string
x-order: 5
Repo:
type: object
properties:
name:
type: string
x-order: 0
description: respository that was analyzed
commit:
type: string
x-order: 1
pattern: '^[0-9a-fA-F]{40}$'
description: SHA1 value of the analyzed commit expressed as hexadecimal
ScorecardVersion:
type: object
properties:
version:
type: string
x-order: 0
description: Scorecard version used for this analysis
commit:
type: string
x-order: 1
pattern: '^[0-9a-fA-F]{40}$'
description: SHA1 value of the Scorecard commit used for analysis
ScorecardCheck:
type: object
properties:
name:
type: string
x-order: 0
score:
type: integer
x-omitempty: false
x-order: 1
reason:
type: string
x-order: 2
documentation:
type: object
x-order: 3
properties:
url:
type: string
short:
type: string
details:
type: array
x-order: 4
items:
type: string
VerifiedScorecardResult:
type: object
properties:
result:
type: string
branch:
type: string
accessToken:
type: string
responses:
NotFound:
description: The content requested could not be found
BadRequest:
description: The request provided to the server was invalid
schema:
$ref: "#/definitions/Error"
InternalServerError:
description: There was an internal error in the server while processing the request
schema:
$ref: "#/definitions/Error"