Skip to content

Commit 4f18092

Browse files
robot-ci-heartexfern-api[bot]
robot-ci-heartex
and
fern-api[bot]
authored
manually regenerate schema (#578)
Co-authored-by: fern-api <115122769+fern-api[bot]@users.noreply.github.com>
1 parent aeb0636 commit 4f18092

34 files changed

+14513
-2681
lines changed

‎.mock/definition/exportStorage/azureSpi.yml

Lines changed: 346 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,346 @@
1+
imports:
2+
root: ../__package__.yml
3+
service:
4+
auth: false
5+
base-path: ''
6+
endpoints:
7+
list:
8+
path: /api/storages/export/azure_spi
9+
method: GET
10+
auth: true
11+
docs: >-
12+
Get a list of all Azure export storage connections that were set up with
13+
Service Principal authentication.
14+
source:
15+
openapi: openapi/openapi.yaml
16+
display-name: Get all Azure SPI export storage
17+
request:
18+
name: AzureSpiListRequest
19+
query-parameters:
20+
ordering:
21+
type: optional<string>
22+
docs: Which field to use when ordering the results.
23+
project:
24+
type: optional<integer>
25+
docs: Project ID
26+
response:
27+
docs: ''
28+
type: list<root.AzureServicePrincipalExportStorage>
29+
examples:
30+
- response:
31+
body:
32+
- account_name: account_name
33+
can_delete_objects: true
34+
client_id: client_id
35+
client_secret: client_secret
36+
container: container
37+
created_at: '2024-01-15T09:30:00Z'
38+
description: description
39+
id: 1
40+
last_sync: '2024-01-15T09:30:00Z'
41+
last_sync_count: 1
42+
last_sync_job: last_sync_job
43+
meta:
44+
key: value
45+
prefix: prefix
46+
project: 1
47+
regex_filter: regex_filter
48+
status: initialized
49+
synchronizable: true
50+
tenant_id: tenant_id
51+
title: title
52+
traceback: traceback
53+
type: type
54+
use_blob_urls: true
55+
user_delegation_key: user_delegation_key
56+
audiences:
57+
- public
58+
create:
59+
path: /api/storages/export/azure_spi
60+
method: POST
61+
auth: true
62+
docs: >-
63+
Create an Azure export storage connection with Service Principal
64+
authentication to store annotations.
65+
source:
66+
openapi: openapi/openapi.yaml
67+
display-name: Create Azure export storage with SPI authentication
68+
request:
69+
body: root.AzureServicePrincipalExportStorageRequest
70+
content-type: application/json
71+
response:
72+
docs: ''
73+
type: root.AzureServicePrincipalExportStorage
74+
examples:
75+
- request:
76+
project: 1
77+
response:
78+
body:
79+
account_name: account_name
80+
can_delete_objects: true
81+
client_id: client_id
82+
client_secret: client_secret
83+
container: container
84+
created_at: '2024-01-15T09:30:00Z'
85+
description: description
86+
id: 1
87+
last_sync: '2024-01-15T09:30:00Z'
88+
last_sync_count: 1
89+
last_sync_job: last_sync_job
90+
meta:
91+
key: value
92+
prefix: prefix
93+
project: 1
94+
regex_filter: regex_filter
95+
status: initialized
96+
synchronizable: true
97+
tenant_id: tenant_id
98+
title: title
99+
traceback: traceback
100+
type: type
101+
use_blob_urls: true
102+
user_delegation_key: user_delegation_key
103+
audiences:
104+
- public
105+
validate:
106+
path: /api/storages/export/azure_spi/validate
107+
method: POST
108+
auth: true
109+
docs: >-
110+
Validate a specific Azure export storage connection that was set up with
111+
Service Principal authentication.
112+
source:
113+
openapi: openapi/openapi.yaml
114+
display-name: Validate Azure SPI export storage
115+
request:
116+
body: root.AzureServicePrincipalExportStorageRequest
117+
content-type: application/json
118+
examples:
119+
- request:
120+
project: 1
121+
audiences:
122+
- public
123+
get:
124+
path: /api/storages/export/azure_spi/{id}
125+
method: GET
126+
auth: true
127+
docs: >-
128+
Get a specific Azure export storage connection that was set up with
129+
Service Principal authentication.
130+
source:
131+
openapi: openapi/openapi.yaml
132+
path-parameters:
133+
id: integer
134+
display-name: Get Azure SPI export storage
135+
response:
136+
docs: ''
137+
type: root.AzureServicePrincipalExportStorage
138+
examples:
139+
- path-parameters:
140+
id: 1
141+
response:
142+
body:
143+
account_name: account_name
144+
can_delete_objects: true
145+
client_id: client_id
146+
client_secret: client_secret
147+
container: container
148+
created_at: '2024-01-15T09:30:00Z'
149+
description: description
150+
id: 1
151+
last_sync: '2024-01-15T09:30:00Z'
152+
last_sync_count: 1
153+
last_sync_job: last_sync_job
154+
meta:
155+
key: value
156+
prefix: prefix
157+
project: 1
158+
regex_filter: regex_filter
159+
status: initialized
160+
synchronizable: true
161+
tenant_id: tenant_id
162+
title: title
163+
traceback: traceback
164+
type: type
165+
use_blob_urls: true
166+
user_delegation_key: user_delegation_key
167+
audiences:
168+
- public
169+
delete:
170+
path: /api/storages/export/azure_spi/{id}
171+
method: DELETE
172+
auth: true
173+
docs: >-
174+
Delete a specific Azure export storage connection that was set up with
175+
Service Principal authentication.
176+
source:
177+
openapi: openapi/openapi.yaml
178+
path-parameters:
179+
id: integer
180+
display-name: Delete Azure SPI export storage
181+
examples:
182+
- path-parameters:
183+
id: 1
184+
audiences:
185+
- public
186+
update:
187+
path: /api/storages/export/azure_spi/{id}
188+
method: PATCH
189+
auth: true
190+
docs: >-
191+
Update a specific Azure export storage connection that was set up with
192+
Service Principal authentication.
193+
source:
194+
openapi: openapi/openapi.yaml
195+
path-parameters:
196+
id: integer
197+
display-name: Update Azure SPI export storage
198+
request:
199+
name: PatchedAzureServicePrincipalExportStorageRequest
200+
body:
201+
properties:
202+
account_name:
203+
type: optional<string>
204+
docs: Azure Blob account name
205+
can_delete_objects:
206+
type: optional<boolean>
207+
docs: Deletion from storage enabled
208+
client_id:
209+
type: optional<string>
210+
docs: Azure Blob Service Principal Client ID
211+
client_secret:
212+
type: optional<string>
213+
docs: Azure Blob Service Principal Client Secret
214+
container:
215+
type: optional<string>
216+
docs: Azure blob container
217+
description:
218+
type: optional<string>
219+
docs: Cloud storage description
220+
last_sync:
221+
type: optional<datetime>
222+
docs: Last sync finished time
223+
last_sync_count:
224+
type: optional<integer>
225+
docs: Count of tasks synced last time
226+
validation:
227+
min: 0
228+
max: 2147483647
229+
last_sync_job:
230+
type: optional<string>
231+
docs: Last sync job ID
232+
validation:
233+
maxLength: 256
234+
meta: optional<unknown>
235+
prefix:
236+
type: optional<string>
237+
docs: Azure blob prefix name
238+
project:
239+
type: optional<integer>
240+
docs: A unique integer value identifying this project.
241+
regex_filter:
242+
type: optional<string>
243+
docs: Cloud storage regex for filtering objects
244+
status: optional<root.StatusC5AEnum>
245+
synchronizable:
246+
type: optional<boolean>
247+
default: true
248+
tenant_id:
249+
type: optional<string>
250+
docs: Azure Tenant ID
251+
title:
252+
type: optional<string>
253+
docs: Cloud storage title
254+
validation:
255+
maxLength: 256
256+
traceback:
257+
type: optional<string>
258+
docs: Traceback report for the last failed sync
259+
use_blob_urls:
260+
type: optional<boolean>
261+
docs: Interpret objects as BLOBs and generate URLs
262+
user_delegation_key:
263+
type: optional<string>
264+
docs: User Delegation Key (Backend)
265+
content-type: application/json
266+
response:
267+
docs: ''
268+
type: root.AzureServicePrincipalExportStorage
269+
examples:
270+
- path-parameters:
271+
id: 1
272+
request: {}
273+
response:
274+
body:
275+
account_name: account_name
276+
can_delete_objects: true
277+
client_id: client_id
278+
client_secret: client_secret
279+
container: container
280+
created_at: '2024-01-15T09:30:00Z'
281+
description: description
282+
id: 1
283+
last_sync: '2024-01-15T09:30:00Z'
284+
last_sync_count: 1
285+
last_sync_job: last_sync_job
286+
meta:
287+
key: value
288+
prefix: prefix
289+
project: 1
290+
regex_filter: regex_filter
291+
status: initialized
292+
synchronizable: true
293+
tenant_id: tenant_id
294+
title: title
295+
traceback: traceback
296+
type: type
297+
use_blob_urls: true
298+
user_delegation_key: user_delegation_key
299+
audiences:
300+
- public
301+
sync:
302+
path: /api/storages/export/azure_spi/{id}/sync
303+
method: POST
304+
auth: true
305+
docs: Sync tasks from an Azure SPI export storage.
306+
source:
307+
openapi: openapi/openapi.yaml
308+
path-parameters:
309+
id: integer
310+
display-name: Sync Azure SPI export storage
311+
response:
312+
docs: ''
313+
type: root.AzureServicePrincipalExportStorage
314+
examples:
315+
- path-parameters:
316+
id: 1
317+
response:
318+
body:
319+
account_name: account_name
320+
can_delete_objects: true
321+
client_id: client_id
322+
client_secret: client_secret
323+
container: container
324+
created_at: '2024-01-15T09:30:00Z'
325+
description: description
326+
id: 1
327+
last_sync: '2024-01-15T09:30:00Z'
328+
last_sync_count: 1
329+
last_sync_job: last_sync_job
330+
meta:
331+
key: value
332+
prefix: prefix
333+
project: 1
334+
regex_filter: regex_filter
335+
status: initialized
336+
synchronizable: true
337+
tenant_id: tenant_id
338+
title: title
339+
traceback: traceback
340+
type: type
341+
use_blob_urls: true
342+
user_delegation_key: user_delegation_key
343+
audiences:
344+
- public
345+
source:
346+
openapi: openapi/openapi.yaml

0 commit comments

Comments
 (0)