Skip to content

Commit 8f3e7b2

Browse files
author
cibot
committed
Definitions Update album
1 parent 23c5042 commit 8f3e7b2

File tree

6 files changed

+2689
-0
lines changed

6 files changed

+2689
-0
lines changed

‎alsdkdefs/apis/album/album.v1.yaml‎

Lines changed: 212 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,212 @@
1+
openapi: 3.0.2
2+
info:
3+
title: Album API
4+
contact:
5+
email: [email protected]
6+
name: Alert Logic Support
7+
url: https://support.alertlogic.com
8+
x-alertlogic-iws-service:
9+
type: public
10+
description: |-
11+
AMI sharing service
12+
version: 1.0.0
13+
servers:
14+
- url: https://api.global.alertlogic.com
15+
x-alertlogic-session-endpoint: true
16+
description: production (US)
17+
- url: https://api.global.alertlogic.com
18+
description: production (UK)
19+
x-alertlogic-session-endpoint: true
20+
- url: https://api.global-integration.product.dev.alertlogic.com
21+
description: integration
22+
paths:
23+
/album/v1/images:
24+
get:
25+
operationId: get_current_images
26+
tags:
27+
- GET
28+
summary: Get current images
29+
description: |-
30+
Returns a list of current images.
31+
parameters:
32+
- $ref: 'parameters.yaml#/query_product_type'
33+
- $ref: 'parameters.yaml#/query_platform_type'
34+
responses:
35+
'200':
36+
$ref: 'responses.yaml#/get_current_images'
37+
38+
/album/v1/all/images:
39+
get:
40+
operationId: get_all_images
41+
tags:
42+
- GET
43+
summary: Get all images
44+
description: |-
45+
Returns a list of all image records, including their ami name and description.
46+
responses:
47+
'200':
48+
$ref: 'responses.yaml#/get_all_images'
49+
50+
/album/v1/all/images/{image_id}:
51+
get:
52+
operationId: get_image
53+
tags:
54+
- GET
55+
summary: Get specified image
56+
description: |-
57+
Returns single image record, including their ami name and description.
58+
parameters:
59+
- $ref: 'parameters.yaml#/path_image_id'
60+
responses:
61+
'200':
62+
$ref: 'responses.yaml#/get_image'
63+
'404':
64+
$ref: 'responses.yaml#/not_found'
65+
66+
/album/v1/all/images/{image_id}/product_type:
67+
get:
68+
operationId: get_image_product_type
69+
tags:
70+
- GET
71+
summary: Get specified images' product type
72+
description: |-
73+
Returns product type for specified image id.
74+
parameters:
75+
- $ref: 'parameters.yaml#/path_image_id'
76+
responses:
77+
'200':
78+
$ref: 'responses.yaml#/get_image_product_type'
79+
'404':
80+
$ref: 'responses.yaml#/not_found'
81+
82+
/album/v1/shares/{platform_type}/{platform_id}:
83+
put:
84+
operationId: add_launch_permission
85+
tags:
86+
- PUT
87+
summary: Add launch permission
88+
description: |-
89+
Adds launch permission for the current images the the specified platform account.
90+
parameters:
91+
- $ref: 'parameters.yaml#/path_platform_type'
92+
- $ref: 'parameters.yaml#/path_platform_id'
93+
responses:
94+
'204':
95+
$ref: 'responses.yaml#/no_content'
96+
'404':
97+
$ref: 'responses.yaml#/not_found'
98+
99+
/album/v2/images/{product_type}/{platform_type}/{version}:
100+
get:
101+
operationId: get_version_image_set
102+
tags:
103+
- GET
104+
summary: Get a specific version set of images
105+
description: |-
106+
Get a specific version set of images.
107+
parameters:
108+
- $ref: 'parameters.yaml#/path_platform_type'
109+
- $ref: 'parameters.yaml#/path_product_type'
110+
- $ref: 'parameters.yaml#/path_version'
111+
responses:
112+
'200':
113+
$ref: 'responses.yaml#/get_version_image_set'
114+
'404':
115+
$ref: 'responses.yaml#/not_found'
116+
post:
117+
operationId: add_new_images_and_create_version_set
118+
tags:
119+
- POST
120+
summary: Add new images
121+
description: |-
122+
Add a new version of images.
123+
parameters:
124+
- $ref: 'parameters.yaml#/path_platform_type'
125+
- $ref: 'parameters.yaml#/path_product_type'
126+
- $ref: 'parameters.yaml#/path_version'
127+
requestBody:
128+
content:
129+
application/json:
130+
schema:
131+
$ref: 'schemas.yaml#/ami_record_ref'
132+
examples:
133+
ami_record:
134+
summary: Request for adding ami records
135+
description: |-
136+
An array of records that will be added to the db,
137+
this will also put all ami in the request under a single version.
138+
value:
139+
{
140+
"ami_name": "Example-AMI-Name",
141+
"description": "Example-AMI-Description",
142+
"image_array": [
143+
{
144+
"image_id": "ami-11111111111111111",
145+
"region": "us-east-1"
146+
},
147+
{
148+
"image_id": "ami-22222222222222222",
149+
"region": "us-east-2"
150+
},
151+
{
152+
"image_id": "ami-33333333333333333",
153+
"region": "us-west-1"
154+
},
155+
{
156+
"image_id": "ami-44444444444444444",
157+
"region": "us-west-2"
158+
}
159+
]
160+
}
161+
responses:
162+
'202':
163+
$ref: 'responses.yaml#/accepted'
164+
'400':
165+
$ref: 'responses.yaml#/bad_request'
166+
167+
/album/v2/images/enabled:
168+
get:
169+
operationId: get_enabled_image_set
170+
tags:
171+
- GET
172+
summary: Get enabled sets of images
173+
description: |-
174+
Get enabled sets of images per product type.
175+
responses:
176+
'200':
177+
$ref: 'responses.yaml#/accepted'
178+
'404':
179+
$ref: 'responses.yaml#/not_found'
180+
181+
/album/v2/images/all:
182+
get:
183+
operationId: get_all_image_set
184+
tags:
185+
- GET
186+
summary: Get all sets of images
187+
description: |-
188+
Get all sets of images.
189+
responses:
190+
'200':
191+
$ref: 'responses.yaml#/accepted'
192+
'404':
193+
$ref: 'responses.yaml#/not_found'
194+
195+
/album/v2/images/{product_type}/{platform_type}/{version}/enable:
196+
put:
197+
operationId: enable_image_records_version_set
198+
tags:
199+
- PUT
200+
summary: Enable a specific version set of images
201+
description: |-
202+
Enable a specific version set of images.
203+
parameters:
204+
- $ref: 'parameters.yaml#/path_platform_type'
205+
- $ref: 'parameters.yaml#/path_product_type'
206+
- $ref: 'parameters.yaml#/path_version'
207+
responses:
208+
'200':
209+
$ref: 'responses.yaml#/accepted'
210+
'404':
211+
$ref: 'responses.yaml#/not_found'
212+

‎alsdkdefs/apis/album/api/album.v1.html‎

Lines changed: 2275 additions & 0 deletions
Large diffs are not rendered by default.

‎alsdkdefs/apis/album/example.yaml‎

Whitespace-only changes.

‎alsdkdefs/apis/album/parameters.yaml‎

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
2+
query_product_type:
3+
name: product_type
4+
required: false
5+
description: Product Type
6+
in: query
7+
schema:
8+
$ref: 'schemas.yaml#/product_type'
9+
10+
query_platform_type:
11+
name: platform_type
12+
required: false
13+
description: Platform Type
14+
in: query
15+
schema:
16+
$ref: 'schemas.yaml#/platform_type'
17+
18+
path_image_id:
19+
name: image_id
20+
required: true
21+
in: path
22+
schema:
23+
$ref: 'schemas.yaml#/image_id'
24+
25+
path_platform_id:
26+
name: platform_id
27+
required: true
28+
in: path
29+
schema:
30+
$ref: 'schemas.yaml#/platform_id'
31+
32+
path_product_type:
33+
name: product_type
34+
required: true
35+
in: path
36+
schema:
37+
$ref: 'schemas.yaml#/product_type'
38+
39+
path_platform_type:
40+
name: platform_type
41+
required: true
42+
in: path
43+
schema:
44+
$ref: 'schemas.yaml#/platform_type'
45+
46+
path_version:
47+
name: version
48+
required: true
49+
in: path
50+
schema:
51+
$ref: 'schemas.yaml#/version'

‎alsdkdefs/apis/album/responses.yaml‎

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
2+
get_current_images:
3+
description: 'OK'
4+
content:
5+
application/json:
6+
schema:
7+
$ref: 'schemas.yaml#/v1_current_images'
8+
9+
get_all_images:
10+
description: 'OK'
11+
content:
12+
application/json:
13+
schema:
14+
$ref: 'schemas.yaml#/v1_all_images'
15+
16+
get_image:
17+
description: 'OK'
18+
content:
19+
application/json:
20+
schema:
21+
$ref: 'schemas.yaml#/image'
22+
23+
get_image_product_type:
24+
description: 'OK'
25+
content:
26+
application/json:
27+
schema:
28+
$ref: 'schemas.yaml#/product_type'
29+
30+
get_version_image_set:
31+
description: 'OK'
32+
content:
33+
application/json:
34+
schema:
35+
$ref: 'schemas.yaml#/v2_current_images'
36+
37+
add_new_images_and_create_version_set:
38+
description: 'OK'
39+
content:
40+
application/json:
41+
schema:
42+
$ref: 'schemas.yaml#/version'
43+
44+
no_content:
45+
description: 'Successful No Content'
46+
47+
not_found:
48+
description: 'Not Found'
49+
50+
accepted:
51+
description: 'Post Successful'
52+
53+
bad_request:
54+
description: 'Bad Request'

0 commit comments

Comments
 (0)