From c6ce7ca50a04ef18d9ef6a11c0003af27ceba7e3 Mon Sep 17 00:00:00 2001 From: Jon Anders Sollien Date: Mon, 12 Aug 2024 11:53:36 +0200 Subject: [PATCH 01/15] Paginated response --- swagger.yaml | 42 +++++++++++++++++++++++++++++++++--------- 1 file changed, 33 insertions(+), 9 deletions(-) diff --git a/swagger.yaml b/swagger.yaml index 18e03d1..e713434 100644 --- a/swagger.yaml +++ b/swagger.yaml @@ -26,9 +26,14 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/projects' + $ref: '#/components/schemas/projects_GET' example: - [{ + { + "skip": 0, + "top": 1000, + "totalCount": 2, + "nextLink": null, + "data": [{ "project_id": "F445F4F2-4D02-4B2A-B612-5E456BEF9137", "name": "Example project 1", "authorization": { @@ -37,13 +42,14 @@ paths: "createDocument" ] } - }, { - "project_id": "A233FBB2-3A3B-EFF4-C123-DE22ABC8414", - "name": "Example project 2", - "authorization": { - "project_actions": [] - } - }] + }, { + "project_id": "A233FBB2-3A3B-EFF4-C123-DE22ABC8414", + "name": "Example project 2", + "authorization": { + "project_actions": [] + } + }] + } /bcf/{version}/projects/{project_id}: parameters: - $ref: "#/components/parameters/version" @@ -1916,6 +1922,24 @@ components: properties: name: type: string + projects_GET: + type: object + required: + - skip + - top + - totalCount + - data + properties: + skip: + type: integer + top: + type: integer + totalCount: + type: integer + nextLink: + type: string + data: + $ref: '#/components/schemas/projects' projects: type: array items: From ab5f45b584cfd8a029a4d8e0b366957fc2ecce62 Mon Sep 17 00:00:00 2001 From: Jon Anders Sollien Date: Mon, 12 Aug 2024 12:01:06 +0200 Subject: [PATCH 02/15] Topics --- swagger.yaml | 36 +++++++++++++++++++++++++++++------- 1 file changed, 29 insertions(+), 7 deletions(-) diff --git a/swagger.yaml b/swagger.yaml index e713434..94d5f2e 100644 --- a/swagger.yaml +++ b/swagger.yaml @@ -222,11 +222,32 @@ paths: content: application/json: schema: - type: array - items: - $ref: '#/components/schemas/topic_GET' + type: object + required: + skip + top + totalCount + data + properties: + skip: + type: integer + top: + type: integer + totalCount: + type: integer + nextLink: + type: string + data: + type: array + items: + $ref: '#/components/schemas/topic_GET' example: - [{ + { + "skip": 0, + "top": 1000, + "totalCount": 2, + "nextLink": null, + "data": [{ "guid": "A245F4F2-2C01-B43B-B612-5E456BEF8116", "server_assigned_id": "ISSUE-00001", "creation_author": "Architect@example.com", @@ -236,7 +257,7 @@ paths: "Structural" ], "creation_date": "2013-10-21T17:34:22.409Z" - }, { + }, { "guid": "A211FCC2-3A3B-EAA4-C321-DE22ABC8414", "server_assigned_id": "ISSUE-00078", "creation_author": "Architect@example.com", @@ -247,12 +268,13 @@ paths: "Electrical" ], "creation_date": "2014-11-19T14:24:11.316Z" - }] + }] + } post: summary: Create Topic description: Add a new topic. This operation is only possible when the server returns the createTopic flag in the Project authorization, see section 3.1.5 tags: - - Topics + - Topics requestBody: required: true content: From b5292c6fb72e9a0c2687ca151ebe05b02c238dd5 Mon Sep 17 00:00:00 2001 From: Jon Anders Sollien Date: Mon, 12 Aug 2024 12:05:20 +0200 Subject: [PATCH 03/15] Project files information --- swagger.yaml | 48 ++++++++++++++++++++++++++++++++++++------------ 1 file changed, 36 insertions(+), 12 deletions(-) diff --git a/swagger.yaml b/swagger.yaml index 94d5f2e..f26159e 100644 --- a/swagger.yaml +++ b/swagger.yaml @@ -430,35 +430,59 @@ paths: content: application/json: schema: - $ref: "#/components/schemas/project_files_information_GET" + type: object + required: + skip + top + totalCount + data + properties: + skip: + type: integer + top: + type: integer + totalCount: + type: integer + nextLink: + type: string + data: + type: array + items: + $ref: "#/components/schemas/project_files_information_GET" example: - [{ + { + "skip": 0, + "top": 1000, + "totalCount": 2, + "nextLink": null, + "data": [{ "display_information": [{ - "field_display_name": "Model Name", - "field_value": "ARCH-Z100-051" + "field_display_name": "Model Name", + "field_value": "ARCH-Z100-051" }, { - "field_display_name": "Revision Date", - "field_value": "May 3 2020" + "field_display_name": "Revision Date", + "field_value": "May 3 2020" }], "file": { "ifc_project": "0J$yPqHBD12v72y4qF6XcD", "file_name": "OfficeBuilding_Architecture_0001.ifc", "reference": "https://example.com/files/0J$yPqHBD12v72y4qF6XcD_0001.ifc" } - }, { + }, { "display_information": [{ - "field_display_name": "Model Name", - "field_value": "MEP-Z100-015" + "field_display_name": "Model Name", + "field_value": "MEP-Z100-015" }, { - "field_display_name": "Revision Date", - "field_value": "Apr 30 2020" + "field_display_name": "Revision Date", + "field_value": "Apr 30 2020" }], "file": { "ifc_project": "3hwBHP91jBRwPsmyf$3Hea", "file_name": "OfficeBuilding_Heating_0003.ifc", "reference": "cf37bae6-0900-46be-b37f-b34754fe0b4a" } - }] + }] + } /bcf/{version}/projects/{project_id}/topics/{topic_guid}/files: parameters: - $ref: "#/components/parameters/version" From ad47719f6b9e4f6b304f9060dcfd2c49488ec585 Mon Sep 17 00:00:00 2001 From: Jon Anders Sollien Date: Mon, 12 Aug 2024 12:07:38 +0200 Subject: [PATCH 04/15] Topic files --- swagger.yaml | 36 +++++++++++++++++++++++++++++------- 1 file changed, 29 insertions(+), 7 deletions(-) diff --git a/swagger.yaml b/swagger.yaml index f26159e..72db9bd 100644 --- a/swagger.yaml +++ b/swagger.yaml @@ -503,19 +503,41 @@ paths: content: application/json: schema: - type: array - items: - $ref: '#/components/schemas/file_GET' - example: - [{ + type: object + required: + skip + top + totalCount + data + properties: + skip: + type: integer + top: + type: integer + totalCount: + type: integer + nextLink: + type: string + data: + type: array + items: + $ref: "#/components/schemas/file_GET" + example: + { + "skip": 0, + "top": 1000, + "totalCount": 2, + "nextLink": null, + "data": [{ "ifc_project": "0J$yPqHBD12v72y4qF6XcD", "file_name": "OfficeBuilding_Architecture_0001.ifc", "reference": "https://example.com/files/0J$yPqHBD12v72y4qF6XcD_0001.ifc" - }, { + }, { "ifc_project": "3hwBHP91jBRwPsmyf$3Hea", "file_name": "OfficeBuilding_Heating_0003.ifc", "reference": "cf37bae6-0900-46be-b37f-b34754fe0b4a" - }] + }] + } put: summary: Update File description: | From bec330dea05cdeaffbce4453521fec44aee79b75 Mon Sep 17 00:00:00 2001 From: Jon Anders Sollien Date: Mon, 12 Aug 2024 12:10:54 +0200 Subject: [PATCH 05/15] comments --- swagger.yaml | 47 +++++++++++++++++++++++++++++++++++++---------- 1 file changed, 37 insertions(+), 10 deletions(-) diff --git a/swagger.yaml b/swagger.yaml index 72db9bd..5c448cb 100644 --- a/swagger.yaml +++ b/swagger.yaml @@ -622,28 +622,55 @@ paths: content: application/json: schema: - type: array - items: - $ref: '#/components/schemas/comment_GET' + type: object + required: + skip + top + totalCount + data + properties: + skip: + type: integer + top: + type: integer + totalCount: + type: integer + nextLink: + type: string + data: + type: array + items: + $ref: "#/components/schemas/comment_GET" example: - [{ + { + "skip": 0, + "top": 1000, + "totalCount": 2, + "nextLink": null, + "data": [{ "guid": "C4215F4D-AC45-A43A-D615-AA456BEF832B", "date": "2016-08-01T12:34:22.409Z", "author": "max.muster@example.com", "comment": "Clash found", "topic_guid": "B345F4F2-3A04-B43B-A713-5E456BEF8228", "authorization": { - "comment_actions": [ - "update" - ] + "comment_actions": [ + "update" + ] } - }, { + }, { "guid": "A333FCA8-1A31-CAAC-A321-BB33ABC8414", "date": "2016-08-01T14:24:11.316Z", "author": "bob.heater@example.com", "comment": "will rework the heating model", - "topic_guid": "B345F4F2-3A04-B43B-A713-5E456BEF8228" - }] + "topic_guid": "B345F4F2-3A04-B43B-A713-5E456BEF8228", + "authorization": { + "comment_actions": [ + "update" + ] + } + }] + } post: summary: Create Comment description: Add a new comment to a topic. This operation is only possible when the server returns the createComment flag in the Topic authorization, see section 3.2.8 From 5c60e51a9d3e2d696e9eab91984d1e52e07a0f73 Mon Sep 17 00:00:00 2001 From: Jon Anders Sollien Date: Mon, 12 Aug 2024 12:13:19 +0200 Subject: [PATCH 06/15] Viewpoints --- swagger.yaml | 174 +++++++++++++++++++++++++++++---------------------- 1 file changed, 98 insertions(+), 76 deletions(-) diff --git a/swagger.yaml b/swagger.yaml index 5c448cb..f50596f 100644 --- a/swagger.yaml +++ b/swagger.yaml @@ -783,101 +783,123 @@ paths: content: application/json: schema: - type: array - items: - $ref: '#/components/schemas/viewpoint_GET' + type: object + required: + skip + top + totalCount + data + properties: + skip: + type: integer + top: + type: integer + totalCount: + type: integer + nextLink: + type: string + data: + type: array + items: + $ref: "#/components/schemas/viewpoint_GET" example: - [{ + { + "skip": 0, + "top": 1000, + "totalCount": 2, + "nextLink": null, + "data": [{ "guid": "b24a82e9-f67b-43b8-bda0-4946abf39624", "perspective_camera": { - "camera_view_point": { - "x": 0.0, - "y": 0.0, - "z": 0.0 - }, - "camera_direction": { - "x": 1.0, - "y": 1.0, - "z": 2.0 - }, - "camera_up_vector": { - "x": 0.0, - "y": 0.0, - "z": 1.0 - }, - "field_of_view": 90.0, - "aspect_ratio": 1.33 + "camera_view_point": { + "x": 0.0, + "y": 0.0, + "z": 0.0 + }, + "camera_direction": { + "x": 1.0, + "y": 1.0, + "z": 2.0 + }, + "camera_up_vector": { + "x": 0.0, + "y": 0.0, + "z": 1.0 + }, + "field_of_view": 90.0, + "aspect_ratio": 1.33 }, "lines": [{ "start_point": { - "x": 2.0, - "y": 1.0, - "z": 1.0 + "x": 2.0, + "y": 1.0, + "z": 1.0 }, "end_point": { - "x": 0.0, - "y": 1.0, - "z": 0.7 + "x": 0.0, + "y": 1.0, + "z": 0.7 } }], "clipping_planes": [{ - "location": { - "x": 0.7, - "y": 0.3, - "z": -0.2 - }, - "direction": { - "x": 1.0, - "y": 0.4, - "z": 0.1 - } + "location": { + "x": 0.7, + "y": 0.3, + "z": -0.2 + }, + "direction": { + "x": 1.0, + "y": 0.4, + "z": 0.1 + } }] - }, { + }, { "guid": "a11a82e7-e66c-34b4-ada1-5846abf39133", "perspective_camera": { - "camera_view_point": { - "x": 0.0, - "y": 0.0, - "z": 0.0 - }, - "camera_direction": { - "x": 1.0, - "y": 1.0, - "z": 2.0 - }, - "camera_up_vector": { - "x": 0.0, - "y": 0.0, - "z": 1.0 - }, - "field_of_view": 90.0, - "aspect_ratio": 1.33 + "camera_view_point": { + "x": 0.0, + "y": 0.0, + "z": 0.0 + }, + "camera_direction": { + "x": 1.0, + "y": 1.0, + "z": 2.0 + }, + "camera_up_vector": { + "x": 0.0, + "y": 0.0, + "z": 1.0 + }, + "field_of_view": 90.0, + "aspect_ratio": 1.33 }, "lines": [{ - "start_point": { - "x": 1.0, - "y": 1.0, - "z": 1.0 - }, - "end_point": { - "x": 0.0, - "y": 0.0, - "z": 0.0 - } + "start_point": { + "x": 1.0, + "y": 1.0, + "z": 1.0 + }, + "end_point": { + "x": 0.0, + "y": 0.0, + "z": 0.0 + } }], "clipping_planes": [{ - "location": { - "x": 0.5, - "y": 0.5, - "z": 0.5 - }, - "direction": { - "x": 1.0, - "y": 0.0, - "z": 0.0 - } + "location": { + "x": 0.5, + "y": 0.5, + "z": 0.5 + }, + "direction": { + "x": 1.0, + "y": 0.0, + "z": 0.0 + } }] - }] + }] + } post: summary: Create Viewpoint description: | From ec4eaf568845b1e94ef740f1aa65d5d30075e521 Mon Sep 17 00:00:00 2001 From: Jon Anders Sollien Date: Mon, 12 Aug 2024 12:14:53 +0200 Subject: [PATCH 07/15] Related topics --- swagger.yaml | 34 ++++++++++++++++++++++++++++------ 1 file changed, 28 insertions(+), 6 deletions(-) diff --git a/swagger.yaml b/swagger.yaml index f50596f..f212dc0 100644 --- a/swagger.yaml +++ b/swagger.yaml @@ -1379,15 +1379,37 @@ paths: content: application/json: schema: - type: array - items: - $ref: '#/components/schemas/related_topic_GET' + type: object + required: + skip + top + totalCount + data + properties: + skip: + type: integer + top: + type: integer + totalCount: + type: integer + nextLink: + type: string + data: + type: array + items: + $ref: "#/components/schemas/related_topic_GET" example: - [{ + { + "skip": 0, + "top": 1000, + "totalCount": 2, + "nextLink": null, + "data": [{ "related_topic_guid": "db49df2b-0e42-473b-a3ee-f7b785d783c4" - }, { + }, { "related_topic_guid": "6963a846-54d1-4050-954d-607cd5e48aa3" - }] + }] + } put: summary: Update Related Topics description: | From 56177eaa18faf40e180da1ec071051251897ae39 Mon Sep 17 00:00:00 2001 From: Jon Anders Sollien Date: Mon, 12 Aug 2024 12:17:16 +0200 Subject: [PATCH 08/15] Document references --- swagger.yaml | 34 ++++++++++++++++++++++++++++------ 1 file changed, 28 insertions(+), 6 deletions(-) diff --git a/swagger.yaml b/swagger.yaml index f212dc0..de1fdee 100644 --- a/swagger.yaml +++ b/swagger.yaml @@ -1471,19 +1471,41 @@ paths: content: application/json: schema: - type: array - items: - $ref: '#/components/schemas/document_reference_GET' + type: object + required: + skip + top + totalCount + data + properties: + skip: + type: integer + top: + type: integer + totalCount: + type: integer + nextLink: + type: string + data: + type: array + items: + $ref: "#/components/schemas/document_reference_GET" example: - [{ + { + "skip": 0, + "top": 1000, + "totalCount": 2, + "nextLink": null, + "data": [{ "guid": "212ab37a-6122-448e-86fc-86503183b520", "url": "http://example.com/files/LegalRequirements.pdf", "description": "The legal requirements for buildings." - }, { + }, { "guid": "6cbfe31d-95c3-4f4d-92a6-420c23698721", "document_guid": "472ab37a-6122-448e-86fc-86503183b520", "description": "The building owners global design parameters for buildings." - }] + }] + } post: summary: Create Document Reference description: | From fbe7e99f144c14b18a2cb3303ff93d263232e520 Mon Sep 17 00:00:00 2001 From: Jon Anders Sollien Date: Mon, 12 Aug 2024 12:18:01 +0200 Subject: [PATCH 09/15] Documents --- swagger.yaml | 34 ++++++++++++++++++++++++++++------ 1 file changed, 28 insertions(+), 6 deletions(-) diff --git a/swagger.yaml b/swagger.yaml index de1fdee..3c564d2 100644 --- a/swagger.yaml +++ b/swagger.yaml @@ -1599,17 +1599,39 @@ paths: content: application/json: schema: - type: array - items: - $ref: '#/components/schemas/document_GET' + type: object + required: + skip + top + totalCount + data + properties: + skip: + type: integer + top: + type: integer + totalCount: + type: integer + nextLink: + type: string + data: + type: array + items: + $ref: "#/components/schemas/document_GET" example: - [{ + { + "skip": 0, + "top": 1000, + "totalCount": 2, + "nextLink": null, + "data": [{ "guid": "472ab37a-6122-448e-86fc-86503183b520", "filename": "LegalRequirements.pdf" - }, { + }, { "guid": "6cbfe31d-95c3-4f4d-92a6-420c23698721", "filename": "DesignParameters.pdf" - }] + }] + } post: summary: Create Document description: | From 0f194b49511eb7bbed7723125d463b81e0152d5e Mon Sep 17 00:00:00 2001 From: Jon Anders Sollien Date: Mon, 12 Aug 2024 12:19:00 +0200 Subject: [PATCH 10/15] Topic events --- swagger.yaml | 50 ++++++++++++++++++++++++++++++++++++-------------- 1 file changed, 36 insertions(+), 14 deletions(-) diff --git a/swagger.yaml b/swagger.yaml index 3c564d2..da9c13a 100644 --- a/swagger.yaml +++ b/swagger.yaml @@ -1721,31 +1721,53 @@ paths: content: application/json: schema: - type: array - items: - $ref: '#/components/schemas/topic_event_GET' + type: object + required: + skip + top + totalCount + data + properties: + skip: + type: integer + top: + type: integer + totalCount: + type: integer + nextLink: + type: string + data: + type: array + items: + $ref: "#/components/schemas/topic_event_GET" example: - [{ + { + "skip": 0, + "top": 1000, + "totalCount": 2, + "nextLink": null, + "data": [{ "topic_guid": "A211FCC2-3A3B-EAA4-C321-DE22ABC8414", "date": "2014-11-19T14:24:11.316Z", "author": "Architect@example.com", "events": [ - { - "type": "status_updated", - "value": "Closed" - } + { + "type": "status_updated", + "value": "Closed" + } ] - }, { + }, { "topic_guid": "A245F4F2-2C01-B43B-B612-5E456BEF8116", "date": "2013-10-21T17:34:22.409Z", "author": "Architect@example.com", "events": [ - { - "type": "type_updated", - "value": "Warning" - } + { + "type": "type_updated", + "value": "Warning" + } ] - }] + }] + } /bcf/{version}/projects/{project_id}/topics/{topic_guid}/events: parameters: - $ref: "#/components/parameters/version" From ed48b2f4649580aa897ff5e962db8ce38d859bfa Mon Sep 17 00:00:00 2001 From: Jon Anders Sollien Date: Mon, 12 Aug 2024 12:20:12 +0200 Subject: [PATCH 11/15] Single topic events --- swagger.yaml | 50 ++++++++++++++++++++++++++++++++++++-------------- 1 file changed, 36 insertions(+), 14 deletions(-) diff --git a/swagger.yaml b/swagger.yaml index da9c13a..484191d 100644 --- a/swagger.yaml +++ b/swagger.yaml @@ -1812,31 +1812,53 @@ paths: content: application/json: schema: - type: array - items: - $ref: '#/components/schemas/topic_event_GET' + type: object + required: + skip + top + totalCount + data + properties: + skip: + type: integer + top: + type: integer + totalCount: + type: integer + nextLink: + type: string + data: + type: array + items: + $ref: "#/components/schemas/topic_event_GET" example: - [{ + { + "skip": 0, + "top": 1000, + "totalCount": 2, + "nextLink": null, + "data": [{ "topic_guid": "A245F4F2-2C01-B43B-B612-5E456BEF8116", "date": "2014-11-19T14:24:11.316Z", "author": "Architect@example.com", "events": [ - { - "type": "type_updated", - "value": "Error" - } + { + "type": "type_updated", + "value": "Error" + } ] - }, { + }, { "topic_guid": "A245F4F2-2C01-B43B-B612-5E456BEF8116", "date": "2013-10-21T17:34:22.409Z", "author": "Architect@example.com", "events": [ - { - "type": "status_updated", - "value": "Open" - } + { + "type": "status_updated", + "value": "Open" + } ] - }] + }] + } /bcf/{version}/projects/{project_id}/topics/comments/events: parameters: - $ref: "#/components/parameters/version" From ad797f7959859cfb01ab168344ef5aa3029a5209 Mon Sep 17 00:00:00 2001 From: Jon Anders Sollien Date: Mon, 12 Aug 2024 12:21:20 +0200 Subject: [PATCH 12/15] Comments events --- swagger.yaml | 50 ++++++++++++++++++++++++++++++++++++-------------- 1 file changed, 36 insertions(+), 14 deletions(-) diff --git a/swagger.yaml b/swagger.yaml index 484191d..0c4513e 100644 --- a/swagger.yaml +++ b/swagger.yaml @@ -1904,33 +1904,55 @@ paths: content: application/json: schema: - type: array - items: - $ref: '#/components/schemas/comment_event_GET' + type: object + required: + skip + top + totalCount + data + properties: + skip: + type: integer + top: + type: integer + totalCount: + type: integer + nextLink: + type: string + data: + type: array + items: + $ref: "#/components/schemas/comment_event_GET" example: - [{ + { + "skip": 0, + "top": 1000, + "totalCount": 2, + "nextLink": null, + "data": [{ "comment_guid": "C4215F4D-AC45-A43A-D615-AA456BEF832B", "topic_guid": "A211FCC2-3A3B-EAA4-C321-DE22ABC8414", "date": "2014-11-19T14:24:11.316Z", "author": "Architect@example.com", "events": [ - { - "type": "comment_created", - "value": null - } + { + "type": "comment_created", + "value": null + } ] - }, { + }, { "comment_guid": "C4215F4D-AC45-A43A-D615-AA456BEF832B", "topic_guid": "A245F4F2-2C01-B43B-B612-5E456BEF8116", "date": "2013-10-21T17:34:22.409Z", "author": "Architect@example.com", "events": [ - { - "type": "viewpoint_updated", - "value": "b24a82e9-f67b-43b8-bda0-4946abf39624" - } + { + "type": "viewpoint_updated", + "value": "b24a82e9-f67b-43b8-bda0-4946abf39624" + } ] - }] + }] + } /bcf/{version}/projects/{project_id}/topics/{topic_guid}/comments/{comment_guid}/events: parameters: - $ref: "#/components/parameters/version" From 186d506f1e171f441c2d0f301e29358a7514f0a0 Mon Sep 17 00:00:00 2001 From: Jon Anders Sollien Date: Mon, 12 Aug 2024 12:22:11 +0200 Subject: [PATCH 13/15] Comment events --- swagger.yaml | 50 ++++++++++++++++++++++++++++++++++++-------------- 1 file changed, 36 insertions(+), 14 deletions(-) diff --git a/swagger.yaml b/swagger.yaml index 0c4513e..6ab1399 100644 --- a/swagger.yaml +++ b/swagger.yaml @@ -1998,33 +1998,55 @@ paths: content: application/json: schema: - type: array - items: - $ref: '#/components/schemas/comment_event_GET' + type: object + required: + skip + top + totalCount + data + properties: + skip: + type: integer + top: + type: integer + totalCount: + type: integer + nextLink: + type: string + data: + type: array + items: + $ref: "#/components/schemas/comment_event_GET" example: - [{ + { + "skip": 0, + "top": 1000, + "totalCount": 2, + "nextLink": null, + "data": [{ "comment_guid": "C4215F4D-AC45-A43A-D615-AA456BEF832B", "topic_guid": "A211FCC2-3A3B-EAA4-C321-DE22ABC8414", "date": "2014-11-19T14:24:11.316Z", "author": "Architect@example.com", "events": [ - { - "type": "comment_created", - "value": null - } + { + "type": "comment_created", + "value": null + } ] - }, { + }, { "comment_guid": "C4215F4D-AC45-A43A-D615-AA456BEF832B", "topic_guid": "A245F4F2-2C01-B43B-B612-5E456BEF8116", "date": "2013-10-21T17:34:22.409Z", "author": "Architect@example.com", "events": [ - { - "type": "comment_text_updated", - "value": "This is the updated comment" - } + { + "type": "comment_text_updated", + "value": "This is the updated comment" + } ] - }] + }] + } components: schemas: # error From 918848804a9437899b1ebcd9db4808702d0f1054 Mon Sep 17 00:00:00 2001 From: Jon Anders Sollien Date: Mon, 12 Aug 2024 12:36:34 +0200 Subject: [PATCH 14/15] Write projects inline (similar to all other list services) --- swagger.yaml | 42 +++++++++++++++++++----------------------- 1 file changed, 19 insertions(+), 23 deletions(-) diff --git a/swagger.yaml b/swagger.yaml index 6ab1399..33d9d8f 100644 --- a/swagger.yaml +++ b/swagger.yaml @@ -26,7 +26,25 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/projects_GET' + type: object + required: + - skip + - top + - totalCount + - data + properties: + skip: + type: integer + top: + type: integer + totalCount: + type: integer + nextLink: + type: string + data: + type: array + items: + $ref: '#/components/schemas/project_GET' example: { "skip": 0, @@ -2193,28 +2211,6 @@ components: properties: name: type: string - projects_GET: - type: object - required: - - skip - - top - - totalCount - - data - properties: - skip: - type: integer - top: - type: integer - totalCount: - type: integer - nextLink: - type: string - data: - $ref: '#/components/schemas/projects' - projects: - type: array - items: - $ref: '#/components/schemas/project_GET' # actions schemas project_actions: type: array From dfc8fda66936eae3405379600b25eba48b37807d Mon Sep 17 00:00:00 2001 From: Georg Dangl <10274404+GeorgDangl@users.noreply.github.com> Date: Mon, 26 Aug 2024 11:13:31 +0200 Subject: [PATCH 15/15] Update swagger.yaml with list fixes --- swagger.yaml | 98 ++++++++++++++++++++++++++-------------------------- 1 file changed, 49 insertions(+), 49 deletions(-) diff --git a/swagger.yaml b/swagger.yaml index 33d9d8f..a318855 100644 --- a/swagger.yaml +++ b/swagger.yaml @@ -242,10 +242,10 @@ paths: schema: type: object required: - skip - top - totalCount - data + - skip + - top + - totalCount + - data properties: skip: type: integer @@ -450,10 +450,10 @@ paths: schema: type: object required: - skip - top - totalCount - data + - skip + - top + - totalCount + - data properties: skip: type: integer @@ -523,10 +523,10 @@ paths: schema: type: object required: - skip - top - totalCount - data + - skip + - top + - totalCount + - data properties: skip: type: integer @@ -642,10 +642,10 @@ paths: schema: type: object required: - skip - top - totalCount - data + - skip + - top + - totalCount + - data properties: skip: type: integer @@ -803,10 +803,10 @@ paths: schema: type: object required: - skip - top - totalCount - data + - skip + - top + - totalCount + - data properties: skip: type: integer @@ -1399,10 +1399,10 @@ paths: schema: type: object required: - skip - top - totalCount - data + - skip + - top + - totalCount + - data properties: skip: type: integer @@ -1491,10 +1491,10 @@ paths: schema: type: object required: - skip - top - totalCount - data + - skip + - top + - totalCount + - data properties: skip: type: integer @@ -1619,10 +1619,10 @@ paths: schema: type: object required: - skip - top - totalCount - data + - skip + - top + - totalCount + - data properties: skip: type: integer @@ -1741,10 +1741,10 @@ paths: schema: type: object required: - skip - top - totalCount - data + - skip + - top + - totalCount + - data properties: skip: type: integer @@ -1832,10 +1832,10 @@ paths: schema: type: object required: - skip - top - totalCount - data + - skip + - top + - totalCount + - data properties: skip: type: integer @@ -1924,10 +1924,10 @@ paths: schema: type: object required: - skip - top - totalCount - data + - skip + - top + - totalCount + - data properties: skip: type: integer @@ -2018,10 +2018,10 @@ paths: schema: type: object required: - skip - top - totalCount - data + - skip + - top + - totalCount + - data properties: skip: type: integer @@ -3159,4 +3159,4 @@ components: in: query name: $skip schema: - type: string \ No newline at end of file + type: string