-
Notifications
You must be signed in to change notification settings - Fork 2.3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #16362 from opf/bug/40942-openapi-specs-wrong-for-…
…creating-work-package-relations [#40942] documented API behaviour for relation creation
- Loading branch information
Showing
12 changed files
with
160 additions
and
148 deletions.
There are no files selected for viewing
4 changes: 2 additions & 2 deletions
4
docs/api/apiv3/components/examples/relation_collection_response.yml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
9 changes: 9 additions & 0 deletions
9
docs/api/apiv3/components/examples/relation_create_request.yml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
description: |- | ||
Example request to create a relation between two work packages. | ||
value: | ||
type: follows | ||
lag: 2 | ||
description: Build hangar AFTER improving external skeleton of Death Star. | ||
_links: | ||
to: | ||
href: /api/v3/work_packages/1337 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
4 changes: 4 additions & 0 deletions
4
docs/api/apiv3/components/examples/relation_update_request.yml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
description: |- | ||
Example request to update the relation's description. | ||
value: | ||
description: This is the new description. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -27,4 +27,4 @@ allOf: | |
elements: | ||
type: array | ||
items: | ||
$ref: './relation_model.yml' | ||
$ref: './relation_read_model.yml' |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
47 changes: 47 additions & 0 deletions
47
docs/api/apiv3/components/schemas/relation_write_model.yml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,47 @@ | ||
# Schema: RelationWriteModel | ||
--- | ||
type: object | ||
required: | ||
- _links | ||
- type | ||
properties: | ||
type: | ||
type: string | ||
description: The relation type. | ||
enum: | ||
- relates | ||
- duplicates | ||
- duplicated | ||
- blocks | ||
- blocked | ||
- precedes | ||
- follows | ||
- includes | ||
- partof | ||
- requires | ||
- required | ||
description: | ||
type: | ||
- 'string' | ||
- 'null' | ||
description: A descriptive text for the relation. | ||
lag: | ||
type: | ||
- 'integer' | ||
- 'null' | ||
description: The lag in days between closing of `from` and start of `to` | ||
minimum: 0 | ||
_links: | ||
type: object | ||
properties: | ||
to: | ||
allOf: | ||
- $ref: './link.yml' | ||
- description: |- | ||
The work package the relation ends in. Only available on relation creation, not on update. | ||
**Resource**: WorkPackage | ||
# Conditions | ||
**Permission**: view work packages |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.