Skip to content

Commit cb3a8e0

Browse files
NicoletaComanNicoletaComan
authored
Merge pull request mendix#10901 from NammNguyen/Epics-API
updated epics api specs
2 parents 09f8cf0 + e0299ce commit cb3a8e0

1 file changed

Lines changed: 226 additions & 0 deletions

File tree

‎static/openapi-spec/epics.yaml‎

Lines changed: 226 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -552,6 +552,220 @@ paths:
552552
status: 404
553553
title: Not Found
554554
detail: The app does not exist or you do not have access to it.
555+
post:
556+
tags:
557+
- epics
558+
summary: Create a single epic for an app
559+
description: Returns the created epic.
560+
operationId: postProjectEpics
561+
parameters:
562+
- in: path
563+
name: appId
564+
description: The ID of the app
565+
required: true
566+
schema:
567+
type: string
568+
format: uuid
569+
requestBody:
570+
description: Successful operation
571+
content:
572+
application/json:
573+
schema:
574+
type: object
575+
properties:
576+
name:
577+
type: string
578+
example: My first epic
579+
objective:
580+
type: string
581+
example: Objective of the whole epic is...
582+
labels:
583+
type: array
584+
items:
585+
type:
586+
string
587+
example: ["Security", "Phase-2"]
588+
assigneeId:
589+
type: string
590+
example: f97dde36-9fa2-4f7c-8c3d-93efb61fbc79
591+
required: [name]
592+
responses:
593+
'200':
594+
description: Successful operation
595+
content:
596+
application/json:
597+
schema:
598+
$ref: '#/components/schemas/epic'
599+
'400':
600+
description: |-
601+
The request likely contains invalid data or is missing data.
602+
The error response includes additional feedback.
603+
content:
604+
application/json:
605+
schema:
606+
$ref: '#/components/schemas/error'
607+
example:
608+
status: 400
609+
title: Bad Request
610+
detail: The request is malformed and could not be read.
611+
'401':
612+
description: |-
613+
The required item could not be found.
614+
The error response includes additional feedback.
615+
content:
616+
application/json:
617+
schema:
618+
$ref: '#/components/schemas/error'
619+
example:
620+
status: 401
621+
title: Unauthorized
622+
detail: Credentials could not be authenticated.
623+
'404':
624+
description: |-
625+
The required item could not be found.
626+
The error response includes additional feedback.
627+
content:
628+
application/json:
629+
schema:
630+
$ref: '#/components/schemas/error'
631+
example:
632+
status: 404
633+
title: Not Found
634+
detail: The app does not exist or you do not have access to it.
635+
/projects/{appId}/epics/{epicUUID}:
636+
patch:
637+
tags:
638+
- epics
639+
summary: Patch an epic by the epic UUID
640+
description: Returns the status code 204.
641+
operationId: patchProjectEpics
642+
parameters:
643+
- in: path
644+
name: appId
645+
description: The ID of the app
646+
required: true
647+
schema:
648+
type: string
649+
format: uuid
650+
- in: path
651+
name: epicUUID
652+
description: The UUID of the epic
653+
required: true
654+
schema:
655+
type: string
656+
format: uuid
657+
requestBody:
658+
description: Successful operation
659+
content:
660+
application/json:
661+
schema:
662+
type: object
663+
properties:
664+
name:
665+
type: string
666+
example: My first epic
667+
objective:
668+
type: string
669+
example: Objective of the whole epic is...
670+
labels:
671+
type: array
672+
items:
673+
type:
674+
string
675+
example: ["Security", "Phase-2"]
676+
assigneeId:
677+
type: string
678+
example: f97dde36-9fa2-4f7c-8c3d-93efb61fbc79
679+
responses:
680+
'204':
681+
description: Successful operation
682+
'400':
683+
description: |-
684+
The request likely contains invalid data or is missing data.
685+
686+
The error response gives additional feedback.
687+
content:
688+
application/json:
689+
schema:
690+
$ref: '#/components/schemas/error'
691+
examples:
692+
Example 1:
693+
value:
694+
status: 400
695+
title: Bad Request
696+
detail: The request is malformed and could not be read.
697+
'401':
698+
description: |-
699+
The required item could not be found.
700+
The error response includes additional feedback.
701+
content:
702+
application/json:
703+
schema:
704+
$ref: '#/components/schemas/error'
705+
example:
706+
status: 401
707+
title: Unauthorized
708+
detail: Credentials could not be authenticated.
709+
'404':
710+
description: |-
711+
The required item could not be found.
712+
The error response includes additional feedback.
713+
content:
714+
application/json:
715+
schema:
716+
$ref: '#/components/schemas/error'
717+
example:
718+
status: 404
719+
title: Not Found
720+
detail: The app does not exist or you do not have access to it.
721+
delete:
722+
tags:
723+
- epics
724+
summary: Delete epic by the epic UUID
725+
description: Returns the status code 204.
726+
operationId: deleteProjectEpics
727+
parameters:
728+
- in: path
729+
name: appId
730+
description: The ID of the app
731+
required: true
732+
schema:
733+
type: string
734+
format: uuid
735+
- in: path
736+
name: epicUUID
737+
description: The ID of the epic
738+
required: true
739+
schema:
740+
type: string
741+
format: uuid
742+
responses:
743+
'204':
744+
description: Successful operation
745+
'401':
746+
description: |-
747+
The required item could not be found.
748+
The error response includes additional feedback.
749+
content:
750+
application/json:
751+
schema:
752+
$ref: '#/components/schemas/error'
753+
example:
754+
status: 401
755+
title: Unauthorized
756+
detail: Credentials could not be authenticated.
757+
'404':
758+
description: |-
759+
The required item could not be found.
760+
The error response includes additional feedback.
761+
content:
762+
application/json:
763+
schema:
764+
$ref: '#/components/schemas/error'
765+
example:
766+
status: 404
767+
title: Not Found
768+
detail: The app does not exist or you do not have access to it.
555769
/projects/{appId}/stories/{storyId}/tasks:
556770
get:
557771
tags:
@@ -1008,6 +1222,18 @@ components:
10081222
format: int64
10091223
minimum: 0
10101224
example: 0
1225+
epic:
1226+
type: object
1227+
properties:
1228+
epicId:
1229+
type: string
1230+
example: 'd9c57d74-f06b-4e1b-91c7-c79375e23927'
1231+
readableEpicId:
1232+
type: string
1233+
example: 'EPI-TEST-1'
1234+
epicUrl:
1235+
type: string
1236+
example: 'https://epics.mendix.com/link/epic/TES-EP-1--d9c57d74-f06b-4e1b-91c7-c79375e23927'
10111237
epics:
10121238
type: object
10131239
properties:

0 commit comments

Comments
 (0)