Merge pull request #10179 from gohrner/oit/go/improve_work_package_and_watchers_model

Improve `watchers_model.yml` and `work_packages_model.yml`
pull/10376/head
Eric Schubert 3 years ago committed by GitHub
commit 1f662ed803
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
  1. 31
      docs/api/apiv3/components/schemas/watchers_model.yml
  2. 24
      docs/api/apiv3/components/schemas/work_packages_by_project_model.yml
  3. 2
      docs/api/apiv3/openapi-spec.yml
  4. 2
      docs/api/apiv3/paths/project_work_packages.yml

@ -1,6 +1,35 @@
# Schema: WatchersModel
---
type: object
allOf:
- "$ref": "./collection_model.yml"
- type: object
required:
- _links
- _embedded
properties:
_links:
type: object
required:
- self
properties:
self:
allOf:
- "$ref": "./link.yml"
- description: |-
The watcher list
**Resource**: WatchersModel
readOnly: true
_embedded:
type: object
properties:
elements:
type: array
readOnly: true
items:
allOf:
- "$ref": "./user_model.yml"
- description: Collection of Users
example:
_links:
self:

@ -1,24 +0,0 @@
# Schema: Work_Packages_by_ProjectModel
---
type: object
example:
_links:
self:
href: "/api/v3/projects/14/work_packages"
total: 2
count: 2
_type: Collection
_embedded:
elements:
- _type: WorkPackage
_links:
self:
href: "/api/v3/work_packages/1"
id: 1
subject: Skipped other properties for brevity
- _type: WorkPackage
_links:
self:
href: "/api/v3/work_packages/2"
id: 2
subject: Skipped other properties for brevity

@ -749,8 +749,6 @@ components:
"$ref": "./components/schemas/work_package_activities_model.yml"
Work_PackagesModel:
"$ref": "./components/schemas/work_packages_model.yml"
Work_Packages_by_ProjectModel:
"$ref": "./components/schemas/work_packages_by_project_model.yml"
securitySchemes:
BasicAuth:
type: http

@ -96,7 +96,7 @@ get:
count: 2
total: 2
schema:
"$ref": "../components/schemas/work_packages_by_project_model.yml"
"$ref": "../components/schemas/work_packages_model.yml"
description: OK
headers: {}
'400':

Loading…
Cancel
Save