Skip to content

Commit ce873a6

Browse files
pcrespovpcrespov
committed
updates OAS
1 parent 9699b93 commit ce873a6

File tree

2 files changed

+170
-166
lines changed

2 files changed

+170
-166
lines changed

‎api/specs/web-server/openapi.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,9 +42,9 @@
4242
"_nih_sparc",
4343
"_nih_sparc_redirections",
4444
"_projects",
45+
"_projects_access_rights",
4546
"_projects_comments",
4647
"_projects_folders",
47-
"_projects_groups",
4848
"_projects_metadata",
4949
"_projects_nodes",
5050
"_projects_nodes_pricing_unit", # after _projects_nodes

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

Lines changed: 169 additions & 165 deletions
Original file line numberDiff line numberDiff line change
@@ -4351,6 +4351,153 @@ paths:
43514351
schema:
43524352
$ref: '#/components/schemas/EnvelopedError'
43534353
description: Payment Required
4354+
/v0/projects/{project_id}:share:
4355+
post:
4356+
tags:
4357+
- projects
4358+
- groups
4359+
summary: Share Project
4360+
operationId: share_project
4361+
parameters:
4362+
- name: project_id
4363+
in: path
4364+
required: true
4365+
schema:
4366+
type: string
4367+
format: uuid
4368+
title: Project Id
4369+
requestBody:
4370+
required: true
4371+
content:
4372+
application/json:
4373+
schema:
4374+
$ref: '#/components/schemas/ProjectShare'
4375+
responses:
4376+
'202':
4377+
description: The request to share the project has been accepted, but the
4378+
actual sharing process has to be confirmd.
4379+
content:
4380+
application/json:
4381+
schema:
4382+
$ref: '#/components/schemas/Envelope_ProjectShareAccepted_'
4383+
/v0/projects/{project_id}/groups/{group_id}:
4384+
post:
4385+
tags:
4386+
- projects
4387+
- groups
4388+
summary: Create Project Group
4389+
operationId: create_project_group
4390+
parameters:
4391+
- name: project_id
4392+
in: path
4393+
required: true
4394+
schema:
4395+
type: string
4396+
format: uuid
4397+
title: Project Id
4398+
- name: group_id
4399+
in: path
4400+
required: true
4401+
schema:
4402+
type: integer
4403+
exclusiveMinimum: true
4404+
title: Group Id
4405+
minimum: 0
4406+
requestBody:
4407+
required: true
4408+
content:
4409+
application/json:
4410+
schema:
4411+
$ref: '#/components/schemas/ProjectsGroupsBodyParams'
4412+
responses:
4413+
'201':
4414+
description: Successful Response
4415+
content:
4416+
application/json:
4417+
schema:
4418+
$ref: '#/components/schemas/Envelope_ProjectGroupGet_'
4419+
put:
4420+
tags:
4421+
- projects
4422+
- groups
4423+
summary: Replace Project Group
4424+
operationId: replace_project_group
4425+
parameters:
4426+
- name: project_id
4427+
in: path
4428+
required: true
4429+
schema:
4430+
type: string
4431+
format: uuid
4432+
title: Project Id
4433+
- name: group_id
4434+
in: path
4435+
required: true
4436+
schema:
4437+
type: integer
4438+
exclusiveMinimum: true
4439+
title: Group Id
4440+
minimum: 0
4441+
requestBody:
4442+
required: true
4443+
content:
4444+
application/json:
4445+
schema:
4446+
$ref: '#/components/schemas/ProjectsGroupsBodyParams'
4447+
responses:
4448+
'200':
4449+
description: Successful Response
4450+
content:
4451+
application/json:
4452+
schema:
4453+
$ref: '#/components/schemas/Envelope_ProjectGroupGet_'
4454+
delete:
4455+
tags:
4456+
- projects
4457+
- groups
4458+
summary: Delete Project Group
4459+
operationId: delete_project_group
4460+
parameters:
4461+
- name: project_id
4462+
in: path
4463+
required: true
4464+
schema:
4465+
type: string
4466+
format: uuid
4467+
title: Project Id
4468+
- name: group_id
4469+
in: path
4470+
required: true
4471+
schema:
4472+
type: integer
4473+
exclusiveMinimum: true
4474+
title: Group Id
4475+
minimum: 0
4476+
responses:
4477+
'204':
4478+
description: Successful Response
4479+
/v0/projects/{project_id}/groups:
4480+
get:
4481+
tags:
4482+
- projects
4483+
- groups
4484+
summary: List Project Groups
4485+
operationId: list_project_groups
4486+
parameters:
4487+
- name: project_id
4488+
in: path
4489+
required: true
4490+
schema:
4491+
type: string
4492+
format: uuid
4493+
title: Project Id
4494+
responses:
4495+
'200':
4496+
description: Successful Response
4497+
content:
4498+
application/json:
4499+
schema:
4500+
$ref: '#/components/schemas/Envelope_list_ProjectGroupGet__'
43544501
/v0/projects/{project_uuid}/comments:
43554502
post:
43564503
tags:
@@ -4541,153 +4688,6 @@ paths:
45414688
responses:
45424689
'204':
45434690
description: Successful Response
4544-
/v0/projects/{project_id}:share:
4545-
post:
4546-
tags:
4547-
- projects
4548-
- groups
4549-
summary: Share Project
4550-
operationId: share_project
4551-
parameters:
4552-
- name: project_id
4553-
in: path
4554-
required: true
4555-
schema:
4556-
type: string
4557-
format: uuid
4558-
title: Project Id
4559-
requestBody:
4560-
required: true
4561-
content:
4562-
application/json:
4563-
schema:
4564-
$ref: '#/components/schemas/ProjectShare'
4565-
responses:
4566-
'202':
4567-
description: The request to share the project has been accepted, but the
4568-
actual sharing process has to be confirmd.
4569-
content:
4570-
application/json:
4571-
schema:
4572-
$ref: '#/components/schemas/Envelope_ProjectShareAccepted_'
4573-
/v0/projects/{project_id}/groups/{group_id}:
4574-
post:
4575-
tags:
4576-
- projects
4577-
- groups
4578-
summary: Create Project Group
4579-
operationId: create_project_group
4580-
parameters:
4581-
- name: project_id
4582-
in: path
4583-
required: true
4584-
schema:
4585-
type: string
4586-
format: uuid
4587-
title: Project Id
4588-
- name: group_id
4589-
in: path
4590-
required: true
4591-
schema:
4592-
type: integer
4593-
exclusiveMinimum: true
4594-
title: Group Id
4595-
minimum: 0
4596-
requestBody:
4597-
required: true
4598-
content:
4599-
application/json:
4600-
schema:
4601-
$ref: '#/components/schemas/_ProjectsGroupsBodyParams'
4602-
responses:
4603-
'201':
4604-
description: Successful Response
4605-
content:
4606-
application/json:
4607-
schema:
4608-
$ref: '#/components/schemas/Envelope_ProjectGroupGet_'
4609-
put:
4610-
tags:
4611-
- projects
4612-
- groups
4613-
summary: Replace Project Group
4614-
operationId: replace_project_group
4615-
parameters:
4616-
- name: project_id
4617-
in: path
4618-
required: true
4619-
schema:
4620-
type: string
4621-
format: uuid
4622-
title: Project Id
4623-
- name: group_id
4624-
in: path
4625-
required: true
4626-
schema:
4627-
type: integer
4628-
exclusiveMinimum: true
4629-
title: Group Id
4630-
minimum: 0
4631-
requestBody:
4632-
required: true
4633-
content:
4634-
application/json:
4635-
schema:
4636-
$ref: '#/components/schemas/_ProjectsGroupsBodyParams'
4637-
responses:
4638-
'200':
4639-
description: Successful Response
4640-
content:
4641-
application/json:
4642-
schema:
4643-
$ref: '#/components/schemas/Envelope_ProjectGroupGet_'
4644-
delete:
4645-
tags:
4646-
- projects
4647-
- groups
4648-
summary: Delete Project Group
4649-
operationId: delete_project_group
4650-
parameters:
4651-
- name: project_id
4652-
in: path
4653-
required: true
4654-
schema:
4655-
type: string
4656-
format: uuid
4657-
title: Project Id
4658-
- name: group_id
4659-
in: path
4660-
required: true
4661-
schema:
4662-
type: integer
4663-
exclusiveMinimum: true
4664-
title: Group Id
4665-
minimum: 0
4666-
responses:
4667-
'204':
4668-
description: Successful Response
4669-
/v0/projects/{project_id}/groups:
4670-
get:
4671-
tags:
4672-
- projects
4673-
- groups
4674-
summary: List Project Groups
4675-
operationId: list_project_groups
4676-
parameters:
4677-
- name: project_id
4678-
in: path
4679-
required: true
4680-
schema:
4681-
type: string
4682-
format: uuid
4683-
title: Project Id
4684-
responses:
4685-
'200':
4686-
description: Successful Response
4687-
content:
4688-
application/json:
4689-
schema:
4690-
$ref: '#/components/schemas/Envelope_list_ProjectGroupGet__'
46914691
/v0/projects/{project_id}/metadata:
46924692
get:
46934693
tags:
@@ -13975,6 +13975,10 @@ components:
1397513975
type: string
1397613976
format: email
1397713977
title: Shareeemail
13978+
sharerMessage:
13979+
type: string
13980+
maxLength: 500
13981+
title: Sharermessage
1397813982
read:
1397913983
type: boolean
1398013984
title: Read
@@ -13987,6 +13991,7 @@ components:
1398713991
type: object
1398813992
required:
1398913993
- shareeEmail
13994+
- sharerMessage
1399013995
- read
1399113996
- write
1399213997
- delete
@@ -14080,6 +14085,23 @@ components:
1408014085
- created
1408114086
- modified
1408214087
title: ProjectsCommentsAPI
14088+
ProjectsGroupsBodyParams:
14089+
properties:
14090+
read:
14091+
type: boolean
14092+
title: Read
14093+
write:
14094+
type: boolean
14095+
title: Write
14096+
delete:
14097+
type: boolean
14098+
title: Delete
14099+
type: object
14100+
required:
14101+
- read
14102+
- write
14103+
- delete
14104+
title: ProjectsGroupsBodyParams
1408314105
PutWalletBodyParams:
1408414106
properties:
1408514107
name:
@@ -16349,24 +16371,6 @@ components:
1634916371
- project_id
1635016372
- node_id
1635116373
title: _ProjectNodePreview
16352-
_ProjectsGroupsBodyParams:
16353-
properties:
16354-
read:
16355-
type: boolean
16356-
title: Read
16357-
write:
16358-
type: boolean
16359-
title: Write
16360-
delete:
16361-
type: boolean
16362-
title: Delete
16363-
additionalProperties: false
16364-
type: object
16365-
required:
16366-
- read
16367-
- write
16368-
- delete
16369-
title: _ProjectsGroupsBodyParams
1637016374
_WalletsGroupsBodyParams:
1637116375
properties:
1637216376
read:

0 commit comments

Comments
 (0)