Skip to content

Commit 4f63a17

Browse files
authored
Merge pull request mendix#8860 from Trkyyy/development
Update Projects-v2 docs
2 parents ab923e5 + 16118a0 commit 4f63a17

1 file changed

Lines changed: 36 additions & 8 deletions

File tree

static/openapi-spec/projects-v2.yaml

Lines changed: 36 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,8 @@ paths:
1616
tags:
1717
- Projects
1818
summary: 'Get a list of company-owned projects'
19-
description: 'Returns a list of projects owned by the company of the requesting user. Inactive projects are only returned if the requesting user is a Mendix Administrator.</br>Every request must be authenticated by a Personal Access Token containing the scope `mx:app:metadata:read`.'
19+
deprecated: true
20+
description: 'This operation has been deprecated. Clients are redirected to `GET /accounts/{account-id}/projects`.'
2021
operationId: get-projects
2122
parameters:
2223
- name: createdSince
@@ -27,14 +28,10 @@ paths:
2728
- $ref: '#components/parameters/limit'
2829
- $ref: '#components/parameters/offset'
2930
responses:
30-
'200':
31-
$ref: '#/components/responses/ProjectsResponse'
32-
'400':
33-
$ref: '#/components/responses/Http400'
31+
'308':
32+
$ref: '#/components/responses/Http308'
3433
'401':
3534
$ref: '#/components/responses/Http401'
36-
'500':
37-
$ref: '#/components/responses/Http500'
3835
post:
3936
tags:
4037
- Projects
@@ -268,6 +265,30 @@ paths:
268265
$ref: '#/components/responses/Http404'
269266
'500':
270267
$ref: '#/components/responses/Http500'
268+
'/accounts/{account-id}/projects':
269+
get:
270+
tags:
271+
- Accounts
272+
summary: 'Get a list of company-owned projects'
273+
description: 'Returns a list of projects owned by the company of the requesting user. Inactive projects are only returned if the requesting user is a Mendix Administrator.</br>Every request must be authenticated by a Personal Access Token containing the scope `mx:app:metadata:read`.'
274+
operationId: get-account-projects
275+
parameters:
276+
- name: createdSince
277+
in: query
278+
description: 'Retrieve all projects created after this date. Time is in UTC and must be provided in this format: 2020-01-16T05:53:28Z'
279+
schema:
280+
type: string
281+
- $ref: '#components/parameters/limit'
282+
- $ref: '#components/parameters/offset'
283+
responses:
284+
'200':
285+
$ref: '#/components/responses/AccountProjectsResponse'
286+
'400':
287+
$ref: '#/components/responses/Http400'
288+
'401':
289+
$ref: '#/components/responses/Http401'
290+
'500':
291+
$ref: '#/components/responses/Http500'
271292
'/roles/{role-id}':
272293
get:
273294
tags:
@@ -536,7 +557,7 @@ components:
536557
name: Authorization
537558
in: header
538559
responses:
539-
ProjectsResponse:
560+
AccountProjectsResponse:
540561
description: List of projects
541562
content:
542563
application/json:
@@ -841,6 +862,13 @@ components:
841862
hasApiRights: false
842863
Http204:
843864
description: 'No Content'
865+
Http308:
866+
description: 'Permanent Redirect'
867+
headers:
868+
Location:
869+
description: 'The URL to which the client is redirected'
870+
schema:
871+
type: string
844872
Http400:
845873
description: 'Bad Request'
846874
content:

0 commit comments

Comments
 (0)