Skip to content

Commit f70cf78

Browse files
committed
updates OAS
1 parent 8cb0e44 commit f70cf78

File tree

1 file changed

+10
-60
lines changed
  • services/web/server/src/simcore_service_webserver/api/v0

1 file changed

+10
-60
lines changed

services/web/server/src/simcore_service_webserver/api/v0/openapi.yaml

Lines changed: 10 additions & 60 deletions
Original file line numberDiff line numberDiff line change
@@ -3605,7 +3605,9 @@ paths:
36053605
tags:
36063606
- projects
36073607
summary: Create Project
3608-
description: Creates a new project or copies an existing one
3608+
description: 'Creates a new project or copies an existing one. NOTE: implemented
3609+
as a long running task, i.e. requires polling `status_href` (HTTP_200_OK)
3610+
to get status and `result_href` (HTTP_201_CREATED) to get created project'
36093611
operationId: create_project
36103612
parameters:
36113613
- name: x_simcore_user_agent
@@ -3675,7 +3677,7 @@ paths:
36753677
- $ref: '#/components/schemas/ProjectCopyOverride'
36763678
title: ' Body'
36773679
responses:
3678-
'201':
3680+
'202':
36793681
description: Successful Response
36803682
content:
36813683
application/json:
@@ -5658,15 +5660,9 @@ paths:
56585660
get:
56595661
tags:
56605662
- storage
5661-
<<<<<<< HEAD
5662-
summary: Get available storage locations
5663-
description: Returns the list of available storage locations
5664-
operationId: list_storage_locations
5665-
=======
5666-
summary: Get Storage Locations
5663+
summary: List Storage Locations
56675664
description: Get available storage locations
5668-
operationId: get_storage_locations
5669-
>>>>>>> 1b28d5f99 (improves oas)
5665+
operationId: list_storage_locations
56705666
responses:
56715667
'200':
56725668
description: Successful Response
@@ -5676,60 +5672,14 @@ paths:
56765672
items:
56775673
$ref: '#/components/schemas/DatasetMetaData'
56785674
type: array
5679-
<<<<<<< HEAD
56805675
title: Response List Storage Locations
5681-
=======
5682-
title: Response Get Storage Locations
5683-
/v0/storage/locations/{location_id}:sync:
5684-
post:
5685-
tags:
5686-
- storage
5687-
summary: Synchronise Meta Data Table
5688-
description: Manually triggers the synchronisation of the file meta data table
5689-
in the database
5690-
operationId: synchronise_meta_data_table
5691-
parameters:
5692-
- name: location_id
5693-
in: path
5694-
required: true
5695-
schema:
5696-
type: integer
5697-
title: Location Id
5698-
- name: dry_run
5699-
in: query
5700-
required: false
5701-
schema:
5702-
type: boolean
5703-
default: false
5704-
title: Dry Run
5705-
- name: fire_and_forget
5706-
in: query
5707-
required: false
5708-
schema:
5709-
type: boolean
5710-
default: false
5711-
title: Fire And Forget
5712-
responses:
5713-
'200':
5714-
description: Successful Response
5715-
content:
5716-
application/json:
5717-
schema:
5718-
$ref: '#/components/schemas/Envelope_TableSynchronisation_'
5719-
>>>>>>> 1b28d5f99 (improves oas)
57205676
/v0/storage/locations/{location_id}/datasets:
57215677
get:
57225678
tags:
57235679
- storage
5724-
<<<<<<< HEAD
5725-
summary: Get datasets metadata
5726-
description: returns all the top level datasets a user has access to
5727-
operationId: list_datasets_metadata
5728-
=======
5729-
summary: Get Datasets Metadata
5680+
summary: List Datasets Metadata
57305681
description: Get datasets metadata
5731-
operationId: get_datasets_metadata
5732-
>>>>>>> 1b28d5f99 (improves oas)
5682+
operationId: list_datasets_metadata
57335683
parameters:
57345684
- name: location_id
57355685
in: path
@@ -5787,8 +5737,8 @@ paths:
57875737
get:
57885738
tags:
57895739
- storage
5790-
summary: Get Files Metadata
5791-
description: returns all the file meta data inside dataset with dataset_id
5740+
summary: List Dataset Files Metadata
5741+
description: Get Files Metadata
57925742
operationId: list_dataset_files_metadata
57935743
parameters:
57945744
- name: location_id

0 commit comments

Comments
 (0)