[#40397] fixed linter errors

- added model for notification settings
- reverted --yes option in nx call
pull/10025/head
Eric Schubert 3 years ago
parent b83c9b97dd
commit 4a3d5950fa
No known key found for this signature in database
GPG Key ID: 1D346C019BD4BAA2
  1. 2
      docs/api/apiv3/components/schemas/activity_model.yml
  2. 2
      docs/api/apiv3/components/schemas/attachment_model.yml
  3. 10
      docs/api/apiv3/components/schemas/configuration_model.yml
  4. 106
      docs/api/apiv3/components/schemas/grid_model.yml
  5. 4
      docs/api/apiv3/components/schemas/query_filter_instance_schema_model.yml
  6. 6
      docs/api/apiv3/components/schemas/query_model.yml
  7. 4
      docs/api/apiv3/components/schemas/schema_model.yml
  8. 3
      docs/api/apiv3/components/schemas/time_entry_model.yml
  9. 2
      docs/api/apiv3/components/schemas/type_model.yml
  10. 36
      docs/api/apiv3/components/schemas/user_preferences_model.yml
  11. 10
      docs/api/apiv3/openapi-spec.yml

@ -19,7 +19,7 @@ properties:
- "$ref": "./formattable.yml"
- {}
details:
type: array of formattable
type: array
readOnly: true
createdAt:
type: string

@ -38,7 +38,7 @@ properties:
description: The files MIME-Type as determined by the server
readOnly: true
digest:
type: digest
type: string
description: A checksum for the files content
readOnly: true
createdAt:

@ -7,8 +7,10 @@ properties:
description: The maximum allowed size of an attachment in Bytes
readOnly: true
perPageOptions:
type: integer[]
type: array
description: Page size steps to be offered in paginated list UI
items:
type: integer
example:
_type: Configuration
_links:
@ -18,6 +20,6 @@ example:
href: "/api/v3/my_preferences"
maximumAttachmentFileSize: 5242880
perPageOptions:
- 1
- 10
- 100
- 1
- 10
- 100

@ -19,13 +19,15 @@ properties:
minimum: 0
exclusiveMinimum: true
widgets:
type: "[]gridwidget"
type: array
description: |-
The set of `GridWidget`s selected for the grid
# Conditions
The widgets cannot overlap
items:
type: object
createdAt:
type: string
format: date-time
@ -39,72 +41,72 @@ properties:
_links:
type: object
required:
- self
- page
- self
- page
properties:
updateImmediately:
allOf:
- "$ref": "./link.yml"
- description: |-
Directly perform edits on this grid
# Conditions
**Permission**: depends on the page the grid is defined for
readOnly: true
- "$ref": "./link.yml"
- description: |-
Directly perform edits on this grid
# Conditions
**Permission**: depends on the page the grid is defined for
readOnly: true
update:
allOf:
- "$ref": "./link.yml"
- description: |-
Validate edits on the grid via a form resource before committing
# Conditions
**Permission**: depends on the page the grid is defined for
readOnly: true
- "$ref": "./link.yml"
- description: |-
Validate edits on the grid via a form resource before committing
# Conditions
**Permission**: depends on the page the grid is defined for
readOnly: true
self:
allOf:
- "$ref": "./link.yml"
- description: |-
This grid
**Resource**: Grid
readOnly: true
- "$ref": "./link.yml"
- description: |-
This grid
**Resource**: Grid
readOnly: true
page:
allOf:
- "$ref": "./link.yml"
- description: |-
The url of the page the grid is defined for
**Resource**: url
# Conditions
The page cannot be changed after the creation
- "$ref": "./link.yml"
- description: |-
The url of the page the grid is defined for
**Resource**: url
# Conditions
The page cannot be changed after the creation
example:
_type: Grid
id: 2
rowCount: 8
columnCount: 5
widgets:
- _type: GridWidget
identifier: time_entries_current_user
startRow: 1
endRow: 8
startColumn: 1
endColumn: 3
- _type: GridWidget
identifier: news
startRow: 3
endRow: 8
startColumn: 4
endColumn: 5
- _type: GridWidget
identifier: documents
startRow: 1
endRow: 3
startColumn: 3
endColumn: 6
- _type: GridWidget
identifier: time_entries_current_user
startRow: 1
endRow: 8
startColumn: 1
endColumn: 3
- _type: GridWidget
identifier: news
startRow: 3
endRow: 8
startColumn: 4
endColumn: 5
- _type: GridWidget
identifier: documents
startRow: 1
endRow: 3
startColumn: 3
endColumn: 6
createdAt: '2018-12-03T16:58:30Z'
updatedAt: '2018-12-13T19:36:40Z'
_links:

@ -6,11 +6,11 @@ required:
- filter
properties:
name:
type: field schema
type: string
description: Describes the name attribute
readOnly: true
filter:
type: field schema
type: string
description: QuerySortBy name
_links:
type: object

@ -16,10 +16,12 @@ properties:
description: Query name
readOnly: true
filters:
type: "[]QueryFilterInstance"
type: array
description: A set of QueryFilters which will be applied to the work packages
to determine the resulting work packages
readOnly: false
items:
$ref: "#/components/schemas/Query_Filter_Instance_SchemaModel"
sums:
type: boolean
description: Should sums (of supported properties) be shown?
@ -30,7 +32,7 @@ properties:
readOnly: true
deprecated: true
timelineLabels:
type: QueryTimelineLabels
type: array
description: Which labels are shown in the timeline, empty when default
readOnly: true
deprecated: true

@ -3,8 +3,10 @@
type: object
properties:
_dependencies:
type: schemadependency
type: array
description: A list of dependencies between one property's value and another property
items:
type: string
_links:
type: object
properties:

@ -16,7 +16,8 @@ properties:
format: date
description: The date the expenditure is booked for
hours:
type: time
type: string
format: date
description: The time quantifying the expenditure
createdAt:
type: string

@ -13,7 +13,7 @@ properties:
description: Type name
readOnly: true
color:
type: color
type: string
description: The color used to represent this type
readOnly: true
position:

@ -17,21 +17,21 @@ example:
timeZone: "Europe/Berlin"
warnOnLeavingUnsaved: true
notifications:
watched: false
involved: true
mentioned: false
newsAdded: false,
newsCommented: false
documentAdded: false
forumMessages: false
wikiPageAdded: false
wikiPageUpdated: false
membershipAdded: false
membershipUpdated: false
workPackageCommented: false
workPackageProcessed: false
workPackagePrioritized: false
workPackageScheduled: false
_links:
project:
href: null
- watched: false
involved: true
mentioned: false
newsAdded: false,
newsCommented: false
documentAdded: false
forumMessages: false
wikiPageAdded: false
wikiPageUpdated: false
membershipAdded: false
membershipUpdated: false
workPackageCommented: false
workPackageProcessed: false
workPackagePrioritized: false
workPackageScheduled: false
_links:
project:
href: null

@ -134,7 +134,13 @@ info:
If no `Accept-Encoding` header is send, `Accept-Encoding: identity` is assumed which will result in the API responding uncompressed.
title: OpenProject API V3 (Stable)
version: '3'
servers: []
servers:
- url: https://qa.openproject-edge.com
description: Edge QA instance
- url: https://qa.openproject-stage.com
description: Staging instance
- url: https://community.openproject.org
description: Community instance
paths:
"/api/v3":
"$ref": "./paths/root.yml"
@ -370,7 +376,7 @@ paths:
"$ref": "./paths/work_packages.yml"
"/api/v3/work_packages/form":
"$ref": "./paths/work_packages_form.yml"
"/api/v3/work_packages/schemas/":
"/api/v3/work_packages/schemas":
"$ref": "./paths/work_packages_schemas.yml"
"/api/v3/work_packages/schemas/{identifier}":
"$ref": "./paths/work_packages_schemas_{identifier}.yml"

Loading…
Cancel
Save