From 4a3d5950fa44e01a5e07e72dc80e61d7ade7da88 Mon Sep 17 00:00:00 2001 From: Eric Schubert Date: Tue, 18 Jan 2022 09:22:18 +0100 Subject: [PATCH] [#40397] fixed linter errors - added model for notification settings - reverted --yes option in nx call --- .../components/schemas/activity_model.yml | 2 +- .../components/schemas/attachment_model.yml | 2 +- .../schemas/configuration_model.yml | 10 +- .../apiv3/components/schemas/grid_model.yml | 106 +++++++++--------- .../query_filter_instance_schema_model.yml | 4 +- .../apiv3/components/schemas/query_model.yml | 6 +- .../apiv3/components/schemas/schema_model.yml | 4 +- .../components/schemas/time_entry_model.yml | 3 +- .../apiv3/components/schemas/type_model.yml | 2 +- .../schemas/user_preferences_model.yml | 36 +++--- docs/api/apiv3/openapi-spec.yml | 10 +- 11 files changed, 100 insertions(+), 85 deletions(-) diff --git a/docs/api/apiv3/components/schemas/activity_model.yml b/docs/api/apiv3/components/schemas/activity_model.yml index e9b4cbcb12..1990dc1d90 100644 --- a/docs/api/apiv3/components/schemas/activity_model.yml +++ b/docs/api/apiv3/components/schemas/activity_model.yml @@ -19,7 +19,7 @@ properties: - "$ref": "./formattable.yml" - {} details: - type: array of formattable + type: array readOnly: true createdAt: type: string diff --git a/docs/api/apiv3/components/schemas/attachment_model.yml b/docs/api/apiv3/components/schemas/attachment_model.yml index a89eb57c9c..cba22afb75 100644 --- a/docs/api/apiv3/components/schemas/attachment_model.yml +++ b/docs/api/apiv3/components/schemas/attachment_model.yml @@ -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: diff --git a/docs/api/apiv3/components/schemas/configuration_model.yml b/docs/api/apiv3/components/schemas/configuration_model.yml index 94e02424a8..d7d93af592 100644 --- a/docs/api/apiv3/components/schemas/configuration_model.yml +++ b/docs/api/apiv3/components/schemas/configuration_model.yml @@ -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 diff --git a/docs/api/apiv3/components/schemas/grid_model.yml b/docs/api/apiv3/components/schemas/grid_model.yml index 69f1092744..5a674d319e 100644 --- a/docs/api/apiv3/components/schemas/grid_model.yml +++ b/docs/api/apiv3/components/schemas/grid_model.yml @@ -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: diff --git a/docs/api/apiv3/components/schemas/query_filter_instance_schema_model.yml b/docs/api/apiv3/components/schemas/query_filter_instance_schema_model.yml index c7d8a6f828..69f5b9e3d5 100644 --- a/docs/api/apiv3/components/schemas/query_filter_instance_schema_model.yml +++ b/docs/api/apiv3/components/schemas/query_filter_instance_schema_model.yml @@ -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 diff --git a/docs/api/apiv3/components/schemas/query_model.yml b/docs/api/apiv3/components/schemas/query_model.yml index 47c4942912..565bf2e831 100644 --- a/docs/api/apiv3/components/schemas/query_model.yml +++ b/docs/api/apiv3/components/schemas/query_model.yml @@ -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 diff --git a/docs/api/apiv3/components/schemas/schema_model.yml b/docs/api/apiv3/components/schemas/schema_model.yml index 2972bcc829..4c2e1d18cb 100644 --- a/docs/api/apiv3/components/schemas/schema_model.yml +++ b/docs/api/apiv3/components/schemas/schema_model.yml @@ -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: diff --git a/docs/api/apiv3/components/schemas/time_entry_model.yml b/docs/api/apiv3/components/schemas/time_entry_model.yml index b59ca5efd1..7b8c41a53f 100644 --- a/docs/api/apiv3/components/schemas/time_entry_model.yml +++ b/docs/api/apiv3/components/schemas/time_entry_model.yml @@ -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 diff --git a/docs/api/apiv3/components/schemas/type_model.yml b/docs/api/apiv3/components/schemas/type_model.yml index 5b16d99bd3..019f5b932a 100644 --- a/docs/api/apiv3/components/schemas/type_model.yml +++ b/docs/api/apiv3/components/schemas/type_model.yml @@ -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: diff --git a/docs/api/apiv3/components/schemas/user_preferences_model.yml b/docs/api/apiv3/components/schemas/user_preferences_model.yml index d698737481..c1abfc6fbd 100644 --- a/docs/api/apiv3/components/schemas/user_preferences_model.yml +++ b/docs/api/apiv3/components/schemas/user_preferences_model.yml @@ -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 diff --git a/docs/api/apiv3/openapi-spec.yml b/docs/api/apiv3/openapi-spec.yml index ee53f8f3e6..ec5e4ae424 100644 --- a/docs/api/apiv3/openapi-spec.yml +++ b/docs/api/apiv3/openapi-spec.yml @@ -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"