-
Notifications
You must be signed in to change notification settings - Fork 0
/
openapi.yaml
125 lines (125 loc) · 3.1 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
openapi: "3.0.3"
info:
title: Orchestrator APIs
description: REST API for Orchestrator
version: "1.0.0"
contact:
name: Chandra
email: epuru.chandra@gmail.com
servers:
- url: http://localhost:8181
description: local
tags:
- name: Info
description: General information of Orchestrator Service
paths:
/v3/version:
get:
operationId: GetVersion
tags:
- Info
summary: Get Version
description: Get Version of Orchestrator Service
parameters:
- $ref: '#/components/parameters/Authorization'
responses:
'200':
description: success
content:
application/json:
schema:
$ref: '#/components/schemas/Version'
'401':
description: unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/AuthenticationError'
'500':
description: internal error
content:
application/json:
schema:
$ref: '#/components/schemas/InternalError'
/v3/spec:
get:
operationId: GetOpenAPISpec
tags:
- Info
summary: Get OpenAPI spec
description: Get OpensAPI spec of the deployed Orchestrator Service
parameters:
- $ref: '#/components/parameters/Authorization'
responses:
'200':
description: OpensAPI Spec file
'401':
description: unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/AuthenticationError'
'500':
description: internal error
content:
application/json:
schema:
$ref: '#/components/schemas/InternalError'
components:
parameters:
Authorization:
name: Authorization
in: header
description: Authorization Token
schema:
type: string
required: true
schemas:
AuthenticationError:
type: object
properties:
httpStatusCode:
type: integer
example: 401
message:
type: string
example: Unable to read user authentication information.
debugId:
type: string
example: 1234-1234
errorCode:
type: string
example: UNAUTHORIZED
InternalError:
type: object
properties:
httpStatusCode:
type: integer
example: 500
message:
type: string
example: Internal Error
debugId:
type: string
example: 1234-1234
errorCode:
type: string
example: INTERNAL_ERROR
errorDetails:
type: object
example:
type: hpe.greenlake.retry_info
retryAfterSeconds: 30
Version:
type: object
description: Orchestrator Service Version
required:
- build
- version
properties:
build:
type: string
example: "010622192045"
version:
type: string
example: v1.0.0