-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathmedia-purge-cache.raml
executable file
·170 lines (167 loc) · 7.55 KB
/
media-purge-cache.raml
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
#%RAML 0.8
title: Purge HD content
version: "1"
baseUri: /config-media-live/v1/vod/purge/
schemas:
- getPurgeFormatsListListSchema: !include ./schemas/getPurgeFormatsList.json
- getCCUCpcodesListSchema: !include ./schemas/getCCUCpcodesList.json
- postHDUrlPurgeRequestSchema: !include ./schemas/postHDUrlPurgeRequest.json
- postHDCpcodePurgeRequestSchema: !include ./schemas/postHDCpcodePurgeRequest.json
- postRtmpUrlPurgeRequestSchema: !include ./schemas/postRtmpUrlPurgeRequest.json
- postRtmpCpcodePurgeRequestSchema: !include ./schemas/postRtmpCpcodePurgeRequest.json
- postPurgeResponseSchema: !include ./schemas/HDPurgeStatusInfo.json
/HD_FLASH:
displayName: Purge HD_FLASH content
description: |
Purges the HD content of format `HD_FLASH` on the production network by URL or CP codes.
post:
description: |
Purge Flash content: Purges the HD content of format `HD_FLASH` on the
production network by URL or CP codes. See [Purge Flash
content by URL or CP code](#flashmodes) for options.
body:
application/json:
schema: postHDUrlPurgeRequestSchema
example: !include ./examples/post-hd-flash-url-purge-request.json
responses:
200:
description: Successful Response
body:
application/json:
schema: postPurgeResponseSchema
example: !include ./examples/post-purge-successful-response.json
/HLS:
displayName: Purge HLS content
description: |
Purges the HD content of format `HLS` on the production network by URL, ARL, or CP codes.
post:
description: |
Purge HLS content: Purges the HD content of format `HLS` on the production
network by URL, ARL, or CP codes.
See [Purge HLS content by URL or CP code](#hlsmodes) for options.
body:
application/json:
schema: postHDUrlPurgeRequestSchema
example: !include ./examples/post-hls-url-purge-request.json
responses:
200:
description: Successful Response
body:
application/json:
schema: postPurgeResponseSchema
example: !include ./examples/post-purge-successful-response.json
/HDS:
displayName: Purge HDS content
description: |
Purges the HD content of format `HDS` on the production network by URL, ARL, or CP codes.
post:
description: |
Purge HDS content: Purges the HD content of format `HDS` on the production
network by URL, ARL, or CP codes.
See [Purge HDS content by URL or CP code](#hdsmodes) for
options.
body:
application/json:
schema: postHDUrlPurgeRequestSchema
example: !include ./examples/post-hds-url-purge-request.json
responses:
200:
description: Successful Response
body:
application/json:
schema: postPurgeResponseSchema
example: !include ./examples/post-purge-successful-response.json
/HD_SILVERLIGHT:
displayName: Purge HD_SILVERLIGHT content
description: |
Purges the HD content of format `HD_SILVERLIGHT` on the production network by URL, ARL, or CP codes.
post:
description: |
Purge Silverlight content: Purges the HD content of format
`HD_SILVERLIGHT` on the production network by URL, ARL, or CP
codes.
See [Purge Silverlight content by URL or CP code](#silverlightmodes)
for options.
body:
application/json:
schema: postHDUrlPurgeRequestSchema
example: !include ./examples/post-hd-silverlight-url-purge-request.json
responses:
200:
description: Successful Response
body:
application/json:
schema: postPurgeResponseSchema
example: !include ./examples/post-purge-successful-response.json
/rtmp/purge:
displayName: Purge RTMP content
description: |
Purges the RTMP content on the production network by URL, ARLs, or CP codes.
post:
description: |
Purge RTMP content: Purges the RTMP content on the production network
by URL, ARLs, or CP codes.
See [Purge RTMP content by URL or CP code](#rtmpmodes)
for options.
body:
application/json:
schema: postRtmpUrlPurgeRequestSchema
example: !include ./examples/post-rtmp-url-purge-request.json
responses:
200:
description: Successful Response
body:
application/json:
schema: postPurgeResponseSchema
example: !include ./examples/post-purge-successful-response.json
/formats:
displayName: Get all HD purge formats
description: |
Fetches all possible formats based on the API client permissions.
This operation lists the content of all the formats that can be purged in
the current managed account for which the API client has been created.
get:
description: |
List purge formats: Obtains all HD purge formats for the
corresponding scope tied to the current account. Fetches
all possible formats based on the API client
permissions. This operation lists the content of
all formats that can be purged in the current managed account
for which API client has been created.
See [Purge format parameters](#fmtparams) for details on
how this operation's response values correspond to
parameter values.
responses:
200:
description: Obtains all available formats.
body:
application/json:
schema: getPurgeFormatsListListSchema
example: !include ./examples/get-all-formats.json
/cpcodes:
displayName: Get CP codes available for purging.
description: |
Fetches all HD purge CP codes for corresponding CP code services in the current account.
This operation can also fetch the CP codes for specific account based on the given format.
get:
queryParameters:
format:
displayName: format
description: |
Format of the corresponding CP code to be filtered. It can have one of these values: `HD_FLASH`, `HLS`, `HDS`, `HD_SILVERLIGHT`, or `RTMP`.
type: string
example: HD_FLASH
enum: [HD_FLASH, HLS, HDS, HD_SILVERLIGHT, RTMP]
required: false
repeat: false
description: |
List CP codes available for purge: Fetches all HD purge CP codes for corresponding CP code
services in the current account. This operation can also fetch the CP codes for a specific account based
on the given format.
responses:
200:
description: Successful Response
body:
application/json:
schema: getCCUCpcodesListSchema
example: !include ./examples/get-ccu-cpcodes.json