-
Notifications
You must be signed in to change notification settings - Fork 0
/
spec.yaml
194 lines (194 loc) · 4.19 KB
/
spec.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
swagger: '2.0'
info:
title: ngc-registry-api
version: 1.0.0
description: |
NVIDIA GPU Cloud Registry API
consumes:
- application/json
produces:
- application/json
schemes:
- http
host: 'localhost:9000'
basePath: /api/v1
securityDefinitions:
jwt-authorizer:
name: Authorization
type: apiKey
in: header
paths:
/signin:
post:
description: |
Signin to NGC web console
operationId: signin
tags:
- auth
parameters:
- name: body
in: body
required: true
schema:
title: AccountInfo
type: object
required:
- email
- password
properties:
email:
description: E-mail address
type: string
format: email
password:
description: Password
type: string
format: password
responses:
'201':
description: OK
schema:
$ref: '#/definitions/Session'
default:
description: Unexpected error
schema:
$ref: '#/definitions/Error'
/me:
get:
description: |
returns user information
operationId: getMyInfo
tags:
- auth
security:
- jwt-authorizer: []
responses:
'200':
description: OK
schema:
$ref: '#/definitions/User'
default:
description: Unexpected error
schema:
$ref: '#/definitions/Error'
/repositories:
get:
description: |
returns NGC repositories
operationId: getRepositories
tags:
- repository
security:
- jwt-authorizer: []
responses:
'200':
description: OK
schema:
type: array
items:
$ref: '#/definitions/Repository'
default:
description: Unexpected error
schema:
$ref: '#/definitions/Error'
/repositories/{namespace}/{id}/images:
get:
description: |
returns NGC images
operationId: getImages
tags:
- image
security:
- jwt-authorizer: []
parameters:
- name: namespace
in: path
description: Docker repositry namespace
type: string
required: true
- name: id
in: path
description: Docker image name
type: string
required: true
responses:
'200':
description: OK
schema:
type: array
items:
$ref: '#/definitions/Image'
default:
description: Unexpected error
schema:
$ref: '#/definitions/Error'
definitions:
Session:
description: session information
required:
- jwt
properties:
jwt:
description: JSON Web Token
type: string
User:
description: user information
required:
- id
properties:
id:
description: User ID
type: integer
format: int64
name:
description: User name
type: string
email:
description: User e-mail address
type: string
format: email
org:
description: Organization name
type: string
created:
description: created datetime
type: string
format: date-time
lastLogin:
description: last logined datetime
type: string
format: date-time
Repository:
description: docker repositry information
required:
- namespace
- name
properties:
namespace:
description: the repositry's namespace
type: string
name:
description: the image name
type: string
Image:
description: docker image information
required:
- tag
- size
properties:
tag:
description: the image tag
type: string
size:
description: the image size
type: integer
format: int64
Error:
required:
- code
- message
properties:
code:
type: string
message:
type: string