Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
346 changes: 346 additions & 0 deletions .mock/definition/exportStorage/azureSpi.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,346 @@
imports:
root: ../__package__.yml
service:
auth: false
base-path: ''
endpoints:
list:
path: /api/storages/export/azure_spi
method: GET
auth: true
docs: >-
Get a list of all Azure export storage connections that were set up with
Service Principal authentication.
source:
openapi: openapi/openapi.yaml
display-name: Get all Azure SPI export storage
request:
name: AzureSpiListRequest
query-parameters:
ordering:
type: optional<string>
docs: Which field to use when ordering the results.
project:
type: optional<integer>
docs: Project ID
response:
docs: ''
type: list<root.AzureServicePrincipalExportStorage>
examples:
- response:
body:
- account_name: account_name
can_delete_objects: true
client_id: client_id
client_secret: client_secret
container: container
created_at: '2024-01-15T09:30:00Z'
description: description
id: 1
last_sync: '2024-01-15T09:30:00Z'
last_sync_count: 1
last_sync_job: last_sync_job
meta:
key: value
prefix: prefix
project: 1
regex_filter: regex_filter
status: initialized
synchronizable: true
tenant_id: tenant_id
title: title
traceback: traceback
type: type
use_blob_urls: true
user_delegation_key: user_delegation_key
audiences:
- public
create:
path: /api/storages/export/azure_spi
method: POST
auth: true
docs: >-
Create an Azure export storage connection with Service Principal
authentication to store annotations.
source:
openapi: openapi/openapi.yaml
display-name: Create Azure export storage with SPI authentication
request:
body: root.AzureServicePrincipalExportStorageRequest
content-type: application/json
response:
docs: ''
type: root.AzureServicePrincipalExportStorage
examples:
- request:
project: 1
response:
body:
account_name: account_name
can_delete_objects: true
client_id: client_id
client_secret: client_secret
container: container
created_at: '2024-01-15T09:30:00Z'
description: description
id: 1
last_sync: '2024-01-15T09:30:00Z'
last_sync_count: 1
last_sync_job: last_sync_job
meta:
key: value
prefix: prefix
project: 1
regex_filter: regex_filter
status: initialized
synchronizable: true
tenant_id: tenant_id
title: title
traceback: traceback
type: type
use_blob_urls: true
user_delegation_key: user_delegation_key
audiences:
- public
validate:
path: /api/storages/export/azure_spi/validate
method: POST
auth: true
docs: >-
Validate a specific Azure export storage connection that was set up with
Service Principal authentication.
source:
openapi: openapi/openapi.yaml
display-name: Validate Azure SPI export storage
request:
body: root.AzureServicePrincipalExportStorageRequest
content-type: application/json
examples:
- request:
project: 1
audiences:
- public
get:
path: /api/storages/export/azure_spi/{id}
method: GET
auth: true
docs: >-
Get a specific Azure export storage connection that was set up with
Service Principal authentication.
source:
openapi: openapi/openapi.yaml
path-parameters:
id: integer
display-name: Get Azure SPI export storage
response:
docs: ''
type: root.AzureServicePrincipalExportStorage
examples:
- path-parameters:
id: 1
response:
body:
account_name: account_name
can_delete_objects: true
client_id: client_id
client_secret: client_secret
container: container
created_at: '2024-01-15T09:30:00Z'
description: description
id: 1
last_sync: '2024-01-15T09:30:00Z'
last_sync_count: 1
last_sync_job: last_sync_job
meta:
key: value
prefix: prefix
project: 1
regex_filter: regex_filter
status: initialized
synchronizable: true
tenant_id: tenant_id
title: title
traceback: traceback
type: type
use_blob_urls: true
user_delegation_key: user_delegation_key
audiences:
- public
delete:
path: /api/storages/export/azure_spi/{id}
method: DELETE
auth: true
docs: >-
Delete a specific Azure export storage connection that was set up with
Service Principal authentication.
source:
openapi: openapi/openapi.yaml
path-parameters:
id: integer
display-name: Delete Azure SPI export storage
examples:
- path-parameters:
id: 1
audiences:
- public
update:
path: /api/storages/export/azure_spi/{id}
method: PATCH
auth: true
docs: >-
Update a specific Azure export storage connection that was set up with
Service Principal authentication.
source:
openapi: openapi/openapi.yaml
path-parameters:
id: integer
display-name: Update Azure SPI export storage
request:
name: PatchedAzureServicePrincipalExportStorageRequest
body:
properties:
account_name:
type: optional<string>
docs: Azure Blob account name
can_delete_objects:
type: optional<boolean>
docs: Deletion from storage enabled
client_id:
type: optional<string>
docs: Azure Blob Service Principal Client ID
client_secret:
type: optional<string>
docs: Azure Blob Service Principal Client Secret
container:
type: optional<string>
docs: Azure blob container
description:
type: optional<string>
docs: Cloud storage description
last_sync:
type: optional<datetime>
docs: Last sync finished time
last_sync_count:
type: optional<integer>
docs: Count of tasks synced last time
validation:
min: 0
max: 2147483647
last_sync_job:
type: optional<string>
docs: Last sync job ID
validation:
maxLength: 256
meta: optional<unknown>
prefix:
type: optional<string>
docs: Azure blob prefix name
project:
type: optional<integer>
docs: A unique integer value identifying this project.
regex_filter:
type: optional<string>
docs: Cloud storage regex for filtering objects
status: optional<root.StatusC5AEnum>
synchronizable:
type: optional<boolean>
default: true
tenant_id:
type: optional<string>
docs: Azure Tenant ID
title:
type: optional<string>
docs: Cloud storage title
validation:
maxLength: 256
traceback:
type: optional<string>
docs: Traceback report for the last failed sync
use_blob_urls:
type: optional<boolean>
docs: Interpret objects as BLOBs and generate URLs
user_delegation_key:
type: optional<string>
docs: User Delegation Key (Backend)
content-type: application/json
response:
docs: ''
type: root.AzureServicePrincipalExportStorage
examples:
- path-parameters:
id: 1
request: {}
response:
body:
account_name: account_name
can_delete_objects: true
client_id: client_id
client_secret: client_secret
container: container
created_at: '2024-01-15T09:30:00Z'
description: description
id: 1
last_sync: '2024-01-15T09:30:00Z'
last_sync_count: 1
last_sync_job: last_sync_job
meta:
key: value
prefix: prefix
project: 1
regex_filter: regex_filter
status: initialized
synchronizable: true
tenant_id: tenant_id
title: title
traceback: traceback
type: type
use_blob_urls: true
user_delegation_key: user_delegation_key
audiences:
- public
sync:
path: /api/storages/export/azure_spi/{id}/sync
method: POST
auth: true
docs: Sync tasks from an Azure SPI export storage.
source:
openapi: openapi/openapi.yaml
path-parameters:
id: integer
display-name: Sync Azure SPI export storage
response:
docs: ''
type: root.AzureServicePrincipalExportStorage
examples:
- path-parameters:
id: 1
response:
body:
account_name: account_name
can_delete_objects: true
client_id: client_id
client_secret: client_secret
container: container
created_at: '2024-01-15T09:30:00Z'
description: description
id: 1
last_sync: '2024-01-15T09:30:00Z'
last_sync_count: 1
last_sync_job: last_sync_job
meta:
key: value
prefix: prefix
project: 1
regex_filter: regex_filter
status: initialized
synchronizable: true
tenant_id: tenant_id
title: title
traceback: traceback
type: type
use_blob_urls: true
user_delegation_key: user_delegation_key
audiences:
- public
source:
openapi: openapi/openapi.yaml
Loading
Loading