mirror of
https://github.com/opf/openproject.git
synced 2026-06-13 19:20:00 +00:00
[chore] fixed integer examples
This commit is contained in:
@@ -14,7 +14,7 @@ allOf:
|
||||
properties:
|
||||
self:
|
||||
allOf:
|
||||
- $ref: './link.yml'
|
||||
- $ref: './link.yml'
|
||||
- description: |-
|
||||
This group collection
|
||||
|
||||
|
||||
@@ -42,6 +42,13 @@ allOf:
|
||||
- user has permission `manage_members` in any project
|
||||
|
||||
**Resource**: User
|
||||
memberships:
|
||||
allOf:
|
||||
- $ref: './link.yml'
|
||||
- description: |-
|
||||
An collection of all memberships of the group.
|
||||
|
||||
**Resource**: MembershipCollection
|
||||
delete:
|
||||
allOf:
|
||||
- $ref: './link.yml'
|
||||
|
||||
@@ -13,7 +13,7 @@ get:
|
||||
required: true
|
||||
schema:
|
||||
type: integer
|
||||
example: '1'
|
||||
example: 1
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
@@ -38,7 +38,7 @@ patch:
|
||||
required: true
|
||||
schema:
|
||||
type: integer
|
||||
example: '1'
|
||||
example: 1
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
|
||||
@@ -14,7 +14,7 @@ get:
|
||||
required: true
|
||||
schema:
|
||||
type: integer
|
||||
example: '1'
|
||||
example: 1
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
@@ -58,7 +58,7 @@ post:
|
||||
required: true
|
||||
schema:
|
||||
type: integer
|
||||
example: '1'
|
||||
example: 1
|
||||
requestBody:
|
||||
content:
|
||||
multipart/form-data:
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
delete:
|
||||
parameters:
|
||||
- description: Attachment id
|
||||
example: '1'
|
||||
example: 1
|
||||
in: path
|
||||
name: id
|
||||
required: true
|
||||
@@ -60,7 +60,7 @@ delete:
|
||||
get:
|
||||
parameters:
|
||||
- description: Attachment id
|
||||
example: '1'
|
||||
example: 1
|
||||
in: path
|
||||
name: id
|
||||
required: true
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
get:
|
||||
parameters:
|
||||
- description: Budget id
|
||||
example: '1'
|
||||
example: 1
|
||||
in: path
|
||||
name: id
|
||||
required: true
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
post:
|
||||
parameters:
|
||||
- description: The id of the custom action to execute
|
||||
example: '1'
|
||||
example: 1
|
||||
in: path
|
||||
name: id
|
||||
required: true
|
||||
|
||||
@@ -9,7 +9,7 @@ get:
|
||||
- name: id
|
||||
description: The custom field item's unique identifier
|
||||
in: path
|
||||
example: '42'
|
||||
example: 42
|
||||
required: true
|
||||
schema:
|
||||
type: integer
|
||||
|
||||
@@ -11,7 +11,7 @@ get:
|
||||
- name: id
|
||||
description: The custom field item's unique identifier
|
||||
in: path
|
||||
example: '42'
|
||||
example: 42
|
||||
required: true
|
||||
schema:
|
||||
type: integer
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
post:
|
||||
parameters:
|
||||
- description: ID of the grid being modified
|
||||
example: '1'
|
||||
example: 1
|
||||
in: path
|
||||
name: id
|
||||
required: true
|
||||
|
||||
@@ -16,7 +16,7 @@ get:
|
||||
description: Page number inside the requested collection.
|
||||
in: query
|
||||
required: false
|
||||
example: '25'
|
||||
example: 25
|
||||
- name: pageSize
|
||||
schema:
|
||||
type: integer
|
||||
@@ -24,7 +24,7 @@ get:
|
||||
description: Number of elements to display per page.
|
||||
in: query
|
||||
required: false
|
||||
example: '25'
|
||||
example: 25
|
||||
- name: filters
|
||||
schema:
|
||||
type: string
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
get:
|
||||
parameters:
|
||||
- description: Page number inside the requested collection.
|
||||
example: '25'
|
||||
example: 25
|
||||
in: query
|
||||
name: offset
|
||||
required: false
|
||||
@@ -11,7 +11,7 @@ get:
|
||||
default: 1
|
||||
type: integer
|
||||
- description: Number of elements to display per page.
|
||||
example: '25'
|
||||
example: 25
|
||||
in: query
|
||||
name: pageSize
|
||||
required: false
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
get:
|
||||
parameters:
|
||||
- description: news id
|
||||
example: '1'
|
||||
example: 1
|
||||
in: path
|
||||
name: id
|
||||
required: true
|
||||
@@ -86,7 +86,7 @@ patch:
|
||||
When calling this endpoint the client provides a single object, containing the properties and links to be updated, in the body.
|
||||
parameters:
|
||||
- description: News id
|
||||
example: '1'
|
||||
example: 1
|
||||
in: path
|
||||
name: id
|
||||
required: true
|
||||
@@ -162,7 +162,7 @@ delete:
|
||||
- News
|
||||
parameters:
|
||||
- description: News id
|
||||
example: '1'
|
||||
example: 1
|
||||
in: path
|
||||
name: id
|
||||
required: true
|
||||
|
||||
@@ -10,7 +10,7 @@ get:
|
||||
- name: id
|
||||
in: path
|
||||
description: notification id
|
||||
example: '1'
|
||||
example: 1
|
||||
required: true
|
||||
schema:
|
||||
type: integer
|
||||
|
||||
@@ -11,14 +11,14 @@ get:
|
||||
- name: notification_id
|
||||
in: path
|
||||
description: notification id
|
||||
example: '1'
|
||||
example: 1
|
||||
required: true
|
||||
schema:
|
||||
type: integer
|
||||
- name: id
|
||||
in: path
|
||||
description: detail id
|
||||
example: '0'
|
||||
example: 0
|
||||
required: true
|
||||
schema:
|
||||
type: integer
|
||||
|
||||
@@ -11,7 +11,7 @@ post:
|
||||
- name: id
|
||||
in: path
|
||||
description: notification id
|
||||
example: '1'
|
||||
example: 1
|
||||
required: true
|
||||
schema:
|
||||
type: integer
|
||||
|
||||
@@ -8,7 +8,7 @@ delete:
|
||||
- Principals
|
||||
parameters:
|
||||
- description: Placeholder user id
|
||||
example: '1'
|
||||
example: 1
|
||||
in: path
|
||||
name: id
|
||||
required: true
|
||||
@@ -53,7 +53,7 @@ get:
|
||||
- Principals
|
||||
parameters:
|
||||
- description: The placeholder user id
|
||||
example: '1'
|
||||
example: 1
|
||||
in: path
|
||||
name: id
|
||||
required: true
|
||||
@@ -94,7 +94,7 @@ patch:
|
||||
that are required, in the body.
|
||||
parameters:
|
||||
- description: Placeholder user id
|
||||
example: '1'
|
||||
example: 1
|
||||
in: path
|
||||
name: id
|
||||
required: true
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
get:
|
||||
parameters:
|
||||
- description: Post's identifier
|
||||
example: '1'
|
||||
example: 1
|
||||
in: path
|
||||
name: id
|
||||
required: true
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
get:
|
||||
parameters:
|
||||
- description: Priority id
|
||||
example: '1'
|
||||
example: 1
|
||||
in: path
|
||||
name: id
|
||||
required: true
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
get:
|
||||
parameters:
|
||||
- description: Program id
|
||||
example: '1'
|
||||
example: 1
|
||||
in: path
|
||||
name: id
|
||||
required: true
|
||||
@@ -45,7 +45,7 @@ get:
|
||||
patch:
|
||||
parameters:
|
||||
- description: Program id
|
||||
example: '1'
|
||||
example: 1
|
||||
in: path
|
||||
name: id
|
||||
required: true
|
||||
@@ -140,7 +140,7 @@ patch:
|
||||
delete:
|
||||
parameters:
|
||||
- description: Program id
|
||||
example: '1'
|
||||
example: 1
|
||||
in: path
|
||||
name: id
|
||||
required: true
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
post:
|
||||
parameters:
|
||||
- description: Program id
|
||||
example: '1'
|
||||
example: 1
|
||||
in: path
|
||||
name: id
|
||||
required: true
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
delete:
|
||||
parameters:
|
||||
- description: Project id
|
||||
example: '1'
|
||||
example: 1
|
||||
in: path
|
||||
name: id
|
||||
required: true
|
||||
@@ -85,7 +85,7 @@ delete:
|
||||
get:
|
||||
parameters:
|
||||
- description: Project id
|
||||
example: '1'
|
||||
example: 1
|
||||
in: path
|
||||
name: id
|
||||
required: true
|
||||
@@ -130,7 +130,7 @@ get:
|
||||
patch:
|
||||
parameters:
|
||||
- description: Project id
|
||||
example: '1'
|
||||
example: 1
|
||||
in: path
|
||||
name: id
|
||||
required: true
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
get:
|
||||
parameters:
|
||||
- description: Project id
|
||||
example: '1'
|
||||
example: 1
|
||||
in: path
|
||||
name: id
|
||||
required: true
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
get:
|
||||
parameters:
|
||||
- description: ID of the project whose categories will be listed
|
||||
example: '1'
|
||||
example: 1
|
||||
in: path
|
||||
name: id
|
||||
required: true
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
post:
|
||||
parameters:
|
||||
- description: Project id
|
||||
example: '1'
|
||||
example: 1
|
||||
in: path
|
||||
name: id
|
||||
required: true
|
||||
|
||||
@@ -15,7 +15,7 @@ get:
|
||||
This endpoint is deprecated and replaced by [`/api/v3/workspaces/{id}/queries/default`](https://www.openproject.org/docs/api/endpoints/queries/#view-default-query-for-workspace)
|
||||
parameters:
|
||||
- description: Id of the project the default query is requested for
|
||||
example: '1'
|
||||
example: 1
|
||||
in: path
|
||||
name: id
|
||||
required: true
|
||||
@@ -34,7 +34,7 @@ get:
|
||||
type: string
|
||||
- name: offset
|
||||
description: Page number inside the queries' result collection of work packages.
|
||||
example: '25'
|
||||
example: 25
|
||||
in: query
|
||||
required: false
|
||||
schema:
|
||||
@@ -43,7 +43,7 @@ get:
|
||||
- name: pageSize
|
||||
description: Number of elements to display per page for the queries' result collection
|
||||
of work packages.
|
||||
example: '25'
|
||||
example: 25
|
||||
in: query
|
||||
required: false
|
||||
schema:
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
get:
|
||||
parameters:
|
||||
- description: Project id
|
||||
example: '1'
|
||||
example: 1
|
||||
in: path
|
||||
name: id
|
||||
required: true
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
get:
|
||||
parameters:
|
||||
- description: Project id
|
||||
example: '1'
|
||||
example: 1
|
||||
in: path
|
||||
name: id
|
||||
required: true
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
get:
|
||||
parameters:
|
||||
- description: ID of the project whose types will be listed
|
||||
example: '1'
|
||||
example: 1
|
||||
in: path
|
||||
name: id
|
||||
required: true
|
||||
|
||||
@@ -10,14 +10,14 @@ get:
|
||||
This endpoint is deprecated and replaced by [`/api/v3/workspaces/{id}/work_packages`](https://www.openproject.org/docs/api/endpoints/work-packages/#get-work-packages-of-workspace)
|
||||
parameters:
|
||||
- description: Project id
|
||||
example: '1'
|
||||
example: 1
|
||||
in: path
|
||||
name: id
|
||||
required: true
|
||||
schema:
|
||||
type: integer
|
||||
- description: Page number inside the requested collection.
|
||||
example: '25'
|
||||
example: 25
|
||||
in: query
|
||||
name: offset
|
||||
required: false
|
||||
@@ -25,7 +25,7 @@ get:
|
||||
default: 1
|
||||
type: integer
|
||||
- description: Number of elements to display per page.
|
||||
example: '25'
|
||||
example: 25
|
||||
in: query
|
||||
name: pageSize
|
||||
required: false
|
||||
@@ -131,7 +131,7 @@ post:
|
||||
$ref: '../components/schemas/work_package_model.yml'
|
||||
parameters:
|
||||
- description: Project id
|
||||
example: '1'
|
||||
example: 1
|
||||
in: path
|
||||
name: id
|
||||
required: true
|
||||
|
||||
@@ -18,7 +18,7 @@ post:
|
||||
required: true
|
||||
schema:
|
||||
type: integer
|
||||
example: '1'
|
||||
example: 1
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
|
||||
@@ -23,7 +23,7 @@ get:
|
||||
type: string
|
||||
- name: offset
|
||||
description: Page number inside the queries' result collection of work packages.
|
||||
example: '25'
|
||||
example: 25
|
||||
in: query
|
||||
required: false
|
||||
schema:
|
||||
@@ -32,7 +32,7 @@ get:
|
||||
- name: pageSize
|
||||
description: Number of elements to display per page for the queries' result collection
|
||||
of work packages.
|
||||
example: '25'
|
||||
example: 25
|
||||
in: query
|
||||
required: false
|
||||
schema:
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
patch:
|
||||
parameters:
|
||||
- description: Query id
|
||||
example: '1'
|
||||
example: 1
|
||||
in: path
|
||||
name: id
|
||||
required: true
|
||||
|
||||
@@ -8,7 +8,7 @@ get:
|
||||
description: Get a single relation specified by its unique identifier.
|
||||
parameters:
|
||||
- description: Relation id
|
||||
example: '1'
|
||||
example: 1
|
||||
in: path
|
||||
name: id
|
||||
required: true
|
||||
@@ -48,7 +48,7 @@ delete:
|
||||
description: Deletes the relation.
|
||||
parameters:
|
||||
- description: The unique identifier of the relation resource
|
||||
example: '1'
|
||||
example: 1
|
||||
in: path
|
||||
name: id
|
||||
required: true
|
||||
@@ -108,7 +108,7 @@ patch:
|
||||
It is not allowed to change a relation's involved work packages.
|
||||
parameters:
|
||||
- description: Relation ID
|
||||
example: '1'
|
||||
example: 1
|
||||
in: path
|
||||
name: id
|
||||
required: true
|
||||
|
||||
@@ -15,7 +15,7 @@ patch:
|
||||
- name: id
|
||||
in: path
|
||||
description: Reminder ID
|
||||
example: '1'
|
||||
example: 1
|
||||
required: true
|
||||
schema:
|
||||
type: integer
|
||||
@@ -63,7 +63,7 @@ delete:
|
||||
- name: id
|
||||
in: path
|
||||
description: Reminder ID
|
||||
example: '1'
|
||||
example: 1
|
||||
required: true
|
||||
schema:
|
||||
type: integer
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
get:
|
||||
parameters:
|
||||
- description: Revision id
|
||||
example: '1'
|
||||
example: 1
|
||||
in: path
|
||||
name: id
|
||||
required: true
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
get:
|
||||
parameters:
|
||||
- description: Role id
|
||||
example: '1'
|
||||
example: 1
|
||||
in: path
|
||||
name: id
|
||||
required: true
|
||||
|
||||
@@ -14,7 +14,7 @@ get:
|
||||
required: true
|
||||
schema:
|
||||
type: integer
|
||||
example: '1'
|
||||
example: 1
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
post:
|
||||
parameters:
|
||||
- description: Time entries activity id
|
||||
example: '1'
|
||||
example: 1
|
||||
in: path
|
||||
name: id
|
||||
required: true
|
||||
|
||||
@@ -9,7 +9,7 @@ delete:
|
||||
- Principals
|
||||
parameters:
|
||||
- description: User id
|
||||
example: '1'
|
||||
example: 1
|
||||
in: path
|
||||
name: id
|
||||
required: true
|
||||
@@ -55,7 +55,7 @@ get:
|
||||
- Principals
|
||||
parameters:
|
||||
- description: User id. Use `me` to reference current user, if any.
|
||||
example: '1'
|
||||
example: 1
|
||||
in: path
|
||||
name: id
|
||||
required: true
|
||||
@@ -96,7 +96,7 @@ patch:
|
||||
When calling this endpoint the client provides a single object, containing at least the properties and links that are required, in the body.
|
||||
parameters:
|
||||
- description: User id
|
||||
example: '1'
|
||||
example: 1
|
||||
in: path
|
||||
name: id
|
||||
required: true
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
post:
|
||||
parameters:
|
||||
- description: User id
|
||||
example: '1'
|
||||
example: 1
|
||||
in: path
|
||||
name: id
|
||||
required: true
|
||||
|
||||
@@ -7,7 +7,7 @@ delete:
|
||||
- Users
|
||||
parameters:
|
||||
- description: User id
|
||||
example: '1'
|
||||
example: 1
|
||||
in: path
|
||||
name: id
|
||||
required: true
|
||||
@@ -68,7 +68,7 @@ post:
|
||||
- Users
|
||||
parameters:
|
||||
- description: User id
|
||||
example: '1'
|
||||
example: 1
|
||||
in: path
|
||||
name: id
|
||||
required: true
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
get:
|
||||
parameters:
|
||||
- description: Version id
|
||||
example: '1'
|
||||
example: 1
|
||||
in: path
|
||||
name: id
|
||||
required: true
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
get:
|
||||
parameters:
|
||||
- description: Version id
|
||||
example: '1'
|
||||
example: 1
|
||||
in: path
|
||||
name: id
|
||||
required: true
|
||||
|
||||
@@ -66,7 +66,7 @@ post:
|
||||
name: id
|
||||
in: path
|
||||
required: true
|
||||
example: '1'
|
||||
example: 1
|
||||
schema:
|
||||
type: string
|
||||
requestBody:
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
get:
|
||||
parameters:
|
||||
- description: Wiki page identifier
|
||||
example: '1'
|
||||
example: 1
|
||||
in: path
|
||||
name: id
|
||||
required: true
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
get:
|
||||
parameters:
|
||||
- description: Work package id
|
||||
example: '1'
|
||||
example: 1
|
||||
in: path
|
||||
name: id
|
||||
required: true
|
||||
@@ -86,7 +86,7 @@ get:
|
||||
post:
|
||||
parameters:
|
||||
- description: Work package id
|
||||
example: '1'
|
||||
example: 1
|
||||
in: path
|
||||
name: id
|
||||
required: true
|
||||
|
||||
@@ -15,7 +15,7 @@ get:
|
||||
required: true
|
||||
schema:
|
||||
type: integer
|
||||
example: '1'
|
||||
example: 1
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
get:
|
||||
parameters:
|
||||
- description: ID of the work package whose attachments will be listed
|
||||
example: '1'
|
||||
example: 1
|
||||
in: path
|
||||
name: id
|
||||
required: true
|
||||
@@ -41,7 +41,7 @@ get:
|
||||
post:
|
||||
parameters:
|
||||
- description: ID of the work package to receive the attachment
|
||||
example: '1'
|
||||
example: 1
|
||||
in: path
|
||||
name: id
|
||||
required: true
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
get:
|
||||
parameters:
|
||||
- description: Work package id
|
||||
example: '1'
|
||||
example: 1
|
||||
in: path
|
||||
name: id
|
||||
required: true
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
get:
|
||||
parameters:
|
||||
- description: work package id
|
||||
example: '1'
|
||||
example: 1
|
||||
in: path
|
||||
name: id
|
||||
required: true
|
||||
|
||||
@@ -8,14 +8,14 @@ get:
|
||||
description: ''
|
||||
parameters:
|
||||
- description: Project id
|
||||
example: '1'
|
||||
example: 1
|
||||
in: path
|
||||
name: id
|
||||
required: true
|
||||
schema:
|
||||
type: integer
|
||||
- description: Maximum number of candidates to list (default 10)
|
||||
example: '25'
|
||||
example: 25
|
||||
in: query
|
||||
name: pageSize
|
||||
required: false
|
||||
|
||||
@@ -43,7 +43,7 @@ post:
|
||||
required: true
|
||||
schema:
|
||||
type: integer
|
||||
example: '1'
|
||||
example: 1
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
|
||||
@@ -11,7 +11,7 @@ post:
|
||||
parameters:
|
||||
- name: id
|
||||
description: Work package id
|
||||
example: '1'
|
||||
example: 1
|
||||
in: path
|
||||
required: true
|
||||
schema:
|
||||
|
||||
@@ -3,14 +3,14 @@
|
||||
delete:
|
||||
parameters:
|
||||
- description: Work package id
|
||||
example: '1'
|
||||
example: 1
|
||||
in: path
|
||||
name: id
|
||||
required: true
|
||||
schema:
|
||||
type: integer
|
||||
- description: User id
|
||||
example: '1'
|
||||
example: 1
|
||||
in: path
|
||||
name: user_id
|
||||
required: true
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
get:
|
||||
parameters:
|
||||
- description: ID of the workspace whose categories will be listed
|
||||
example: '1'
|
||||
example: 1
|
||||
in: path
|
||||
name: id
|
||||
required: true
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
get:
|
||||
parameters:
|
||||
- description: Workspace id
|
||||
example: '1'
|
||||
example: 1
|
||||
in: path
|
||||
name: id
|
||||
required: true
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
get:
|
||||
parameters:
|
||||
- description: Project id
|
||||
example: '1'
|
||||
example: 1
|
||||
in: path
|
||||
name: id
|
||||
required: true
|
||||
|
||||
@@ -8,14 +8,14 @@ get:
|
||||
description: Returns the collection of work packages that are related to the given workspace.
|
||||
parameters:
|
||||
- description: Workspace id
|
||||
example: '1'
|
||||
example: 1
|
||||
in: path
|
||||
name: id
|
||||
required: true
|
||||
schema:
|
||||
type: integer
|
||||
- description: Page number inside the requested collection.
|
||||
example: '25'
|
||||
example: 25
|
||||
in: query
|
||||
name: offset
|
||||
required: false
|
||||
@@ -23,7 +23,7 @@ get:
|
||||
default: 1
|
||||
type: integer
|
||||
- description: Number of elements to display per page.
|
||||
example: '25'
|
||||
example: 25
|
||||
in: query
|
||||
name: pageSize
|
||||
required: false
|
||||
|
||||
Reference in New Issue
Block a user