-
Notifications
You must be signed in to change notification settings - Fork 2.4k
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 #15470 from wbt-solutions/openapi/List_available_p…
…arent_project_candidatesModel [chore] Add proper api spec schema for List_available_parent_project_…
- Loading branch information
Showing
1 changed file
with
29 additions
and
77 deletions.
There are no files selected for viewing
106 changes: 29 additions & 77 deletions
106
docs/api/apiv3/components/schemas/list_available_parent_project_candidates_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 |
---|---|---|
@@ -1,80 +1,32 @@ | ||
# Schema: List_available_parent_project_candidatesModel | ||
--- | ||
type: object | ||
example: | ||
_links: | ||
self: | ||
href: "/api/v3/projects/available_parent_projects?of=123" | ||
_type: Collection | ||
total: 2 | ||
count: 2 | ||
_embedded: | ||
elements: | ||
- _type: Project | ||
allOf: | ||
- $ref: ./collection_model.yml | ||
- type: object | ||
required: | ||
- _links | ||
- _embedded | ||
properties: | ||
_links: | ||
self: | ||
href: "/api/v3/projects/6" | ||
title: A project | ||
createWorkPackage: | ||
href: "/api/v3/projects/6/work_packages/form" | ||
method: post | ||
createWorkPackageImmediate: | ||
href: "/api/v3/projects/6/work_packages" | ||
method: post | ||
categories: | ||
href: "/api/v3/projects/6/categories" | ||
versions: | ||
href: "/api/v3/projects/6/versions" | ||
status: | ||
href: "/api/v3/project_statuses/on_track" | ||
title: On track | ||
id: 6 | ||
identifier: a_project | ||
name: A project | ||
active: true | ||
statusExplanation: | ||
format: markdown | ||
raw: Everything **fine** | ||
html: "<p>Everything <strong>fine</strong></p>" | ||
public: false | ||
description: | ||
format: markdown | ||
raw: Lorem **ipsum** dolor sit amet | ||
html: "<p>Lorem <strong>ipsum</strong> dolor sit amet</p>" | ||
createdAt: '2015-07-06T13:28:14+00:00' | ||
updatedAt: '2015-10-01T09:55:02+00:00' | ||
type: Customer Project | ||
- _type: Project | ||
_links: | ||
self: | ||
href: "/api/v3/projects/14" | ||
title: Another project | ||
createWorkPackage: | ||
href: "/api/v3/projects/14/work_packages/form" | ||
method: post | ||
createWorkPackageImmediate: | ||
href: "/api/v3/projects/14/work_packages" | ||
method: post | ||
categories: | ||
href: "/api/v3/projects/14/categories" | ||
versions: | ||
href: "/api/v3/projects/14/versions" | ||
status: | ||
href: "/api/v3/project_statuses/on_track" | ||
title: On track | ||
id: 14 | ||
identifier: another_project | ||
name: Another project | ||
active: true | ||
statusExplanation: | ||
format: markdown | ||
raw: Everything super **fine** | ||
html: "<p>Everything super <strong>fine</strong></p>" | ||
public: true | ||
description: | ||
format: markdown | ||
raw: '' | ||
html: '' | ||
createdAt: '2016-02-29T12:50:20+00:00' | ||
updatedAt: '2016-02-29T12:50:20+00:00' | ||
type: | ||
type: object | ||
required: | ||
- self | ||
properties: | ||
self: | ||
allOf: | ||
- "$ref": ./link.yml | ||
- description: |- | ||
The project collection | ||
**Resource**: ProjectCollection | ||
readOnly: true | ||
_embedded: | ||
type: object | ||
properties: | ||
elements: | ||
type: array | ||
readOnly: true | ||
items: | ||
allOf: | ||
- "$ref": ./project_model.yml | ||
- description: Collection of projects |