From 76e3bd5619038c8e635cd13d525afd456f172e7a Mon Sep 17 00:00:00 2001 From: Jon Anders Sollien Date: Mon, 10 Mar 2025 11:23:01 +0100 Subject: [PATCH 1/6] Add additional properties --- swagger.yaml | 149 +++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 149 insertions(+) diff --git a/swagger.yaml b/swagger.yaml index fa78e4a..543fffc 100644 --- a/swagger.yaml +++ b/swagger.yaml @@ -1859,6 +1859,9 @@ paths: } components: schemas: + additionalProperties: + type: object + additionalProperties: true pagination: type: object required: @@ -1867,6 +1870,8 @@ components: - totalCount - data properties: + additionalProperties: + $ref: '#/components/schemas/additionalProperties' skip: type: integer top: @@ -1882,6 +1887,8 @@ components: required: - message properties: + additionalProperties: + $ref: '#/components/schemas/additionalProperties' message: type: string # project schemas @@ -1895,6 +1902,8 @@ components: - users - stage properties: + additionalProperties: + $ref: '#/components/schemas/additionalProperties' topic_type: type: array nullable: true @@ -1949,6 +1958,8 @@ components: - name - readonly properties: + additionalProperties: + $ref: '#/components/schemas/additionalProperties' id: type: string name: @@ -1963,6 +1974,8 @@ components: - status_type - readonly properties: + additionalProperties: + $ref: '#/components/schemas/additionalProperties' id: type: string name: @@ -1980,6 +1993,8 @@ components: - email - readonly properties: + additionalProperties: + $ref: '#/components/schemas/additionalProperties' id: type: string name: @@ -1993,6 +2008,8 @@ components: required: - id properties: + additionalProperties: + $ref: '#/components/schemas/additionalProperties' id: type: string project_GET: @@ -2002,6 +2019,8 @@ components: - project_id - name properties: + additionalProperties: + $ref: '#/components/schemas/additionalProperties' project_id: type: string name: @@ -2009,6 +2028,8 @@ components: authorization: type: object properties: + additionalProperties: + $ref: '#/components/schemas/additionalProperties' project_actions: $ref: '#/components/schemas/project_actions' project_PUT: @@ -2017,6 +2038,8 @@ components: required: - name properties: + additionalProperties: + $ref: '#/components/schemas/additionalProperties' name: type: string # actions schemas @@ -2059,6 +2082,8 @@ components: required: - type properties: + additionalProperties: + $ref: '#/components/schemas/additionalProperties' type: type: string value: @@ -2066,6 +2091,8 @@ components: event_action_value: type: object properties: + additionalProperties: + $ref: '#/components/schemas/additionalProperties' id: type: string displayValue: @@ -2080,6 +2107,8 @@ components: - comment - topic_guid properties: + additionalProperties: + $ref: '#/components/schemas/additionalProperties' comment_guid: type: string date: @@ -2106,6 +2135,8 @@ components: authorization: type: object properties: + additionalProperties: + $ref: '#/components/schemas/additionalProperties' comment_actions: $ref: "#/components/schemas/comment_actions" comment_POST: @@ -2113,6 +2144,8 @@ components: required: - comment properties: + additionalProperties: + $ref: '#/components/schemas/additionalProperties' comment: type: string viewpoint_guid: @@ -2127,6 +2160,8 @@ components: required: - comment properties: + additionalProperties: + $ref: '#/components/schemas/additionalProperties' comment: type: string viewpoint_guid: @@ -2143,6 +2178,8 @@ components: - document_guid - filename properties: + additionalProperties: + $ref: '#/components/schemas/additionalProperties' document_guid: type: string filename: @@ -2154,6 +2191,8 @@ components: required: - guid properties: + additionalProperties: + $ref: '#/components/schemas/additionalProperties' guid: type: string document_guid: @@ -2168,6 +2207,8 @@ components: document_reference_POST: type: object properties: + additionalProperties: + $ref: '#/components/schemas/additionalProperties' # should be document_reference_guid ? document_reference_guid: type: string @@ -2184,6 +2225,8 @@ components: document_reference_PUT: type: object properties: + additionalProperties: + $ref: '#/components/schemas/additionalProperties' document_guid: type: string nullable: true @@ -2202,6 +2245,8 @@ components: - date - author properties: + additionalProperties: + $ref: '#/components/schemas/additionalProperties' comment_guid: type: string topic_guid: @@ -2223,6 +2268,8 @@ components: - date - author properties: + additionalProperties: + $ref: '#/components/schemas/additionalProperties' topic_guid: type: string date: @@ -2240,6 +2287,8 @@ components: description: Schema for a single file GET, BCF REST API. type: object properties: + additionalProperties: + $ref: '#/components/schemas/additionalProperties' ifc_project: type: string nullable: true @@ -2262,6 +2311,8 @@ components: file_PUT: type: object properties: + additionalProperties: + $ref: '#/components/schemas/additionalProperties' ifc_project: type: string nullable: true @@ -2285,6 +2336,8 @@ components: - field_display_name - field_value properties: + additionalProperties: + $ref: '#/components/schemas/additionalProperties' field_display_name: type: string field_value: @@ -2293,6 +2346,8 @@ components: type: object description: Schema for a single project file information, BCF REST API. properties: + additionalProperties: + $ref: '#/components/schemas/additionalProperties' display_information: type: array default: [] @@ -2313,6 +2368,8 @@ components: - related_topic_guid - relation_type properties: + additionalProperties: + $ref: '#/components/schemas/additionalProperties' related_topic_guid: type: string relation_type: @@ -2325,6 +2382,8 @@ components: - related_topic_guid - relation_type properties: + additionalProperties: + $ref: '#/components/schemas/additionalProperties' related_topic_guid: type: string relation_type: @@ -2340,6 +2399,8 @@ components: - creation_date - creation_author properties: + additionalProperties: + $ref: '#/components/schemas/additionalProperties' topic_guid: type: string server_assigend_id: @@ -2395,6 +2456,8 @@ components: authorization: type: object properties: + additionalProperties: + $ref: '#/components/schemas/additionalProperties' topic_actions: $ref: '#/components/schemas/topic_actions' topic_status: @@ -2412,6 +2475,8 @@ components: required: - title properties: + additionalProperties: + $ref: '#/components/schemas/additionalProperties' topic_guid: type: string nullable: true @@ -2457,6 +2522,8 @@ components: required: - title properties: + additionalProperties: + $ref: '#/components/schemas/additionalProperties' topic_type: $ref: "#/components/schemas/extension_item_SET" topic_status: @@ -2502,6 +2569,8 @@ components: topic_custom_field: type: object properties: + additionalProperties: + $ref: '#/components/schemas/additionalProperties' id: type: string nullable: true @@ -2513,6 +2582,8 @@ components: bitmap_GET: type: object properties: + additionalProperties: + $ref: '#/components/schemas/additionalProperties' bitmap_guid: type: string bitmap_type: @@ -2531,6 +2602,8 @@ components: bitmap_POST: type: object properties: + additionalProperties: + $ref: '#/components/schemas/additionalProperties' bitmap_type: type: string enum: @@ -2551,6 +2624,8 @@ components: type: object nullable: true properties: + additionalProperties: + $ref: '#/components/schemas/additionalProperties' location: $ref: '#/components/schemas/location' direction: @@ -2558,6 +2633,8 @@ components: coloring: type: object properties: + additionalProperties: + $ref: '#/components/schemas/additionalProperties' color: type: string components: @@ -2566,6 +2643,8 @@ components: description: Schema for coloring GET, BCF REST API. type: object properties: + additionalProperties: + $ref: '#/components/schemas/additionalProperties' coloring: type: array nullable: true @@ -2574,6 +2653,8 @@ components: component: type: object properties: + additionalProperties: + $ref: '#/components/schemas/additionalProperties' ifc_guid: type: string nullable: true @@ -2592,6 +2673,8 @@ components: type: object nullable: true properties: + additionalProperties: + $ref: '#/components/schemas/additionalProperties' selection: $ref: '#/components/schemas/component_list' coloring: @@ -2606,6 +2689,8 @@ components: direction: type: object properties: + additionalProperties: + $ref: '#/components/schemas/additionalProperties' x: type: number y: @@ -2616,6 +2701,8 @@ components: type: object nullable: true properties: + additionalProperties: + $ref: '#/components/schemas/additionalProperties' start_point: $ref: '#/components/schemas/point' end_point: @@ -2626,6 +2713,8 @@ components: type: object nullable: true properties: + additionalProperties: + $ref: '#/components/schemas/additionalProperties' x: type: number y: @@ -2636,6 +2725,8 @@ components: type: object nullable: true properties: + additionalProperties: + $ref: '#/components/schemas/additionalProperties' camera_view_point: $ref: '#/components/schemas/point' camera_direction: @@ -2650,6 +2741,8 @@ components: type: object nullable: true properties: + additionalProperties: + $ref: '#/components/schemas/additionalProperties' camera_view_point: $ref: '#/components/schemas/point' camera_direction: @@ -2663,6 +2756,8 @@ components: point: type: object properties: + additionalProperties: + $ref: '#/components/schemas/additionalProperties' x: type: number y: @@ -2673,12 +2768,16 @@ components: description: Schema for selection GET, BCF REST API. type: object properties: + additionalProperties: + $ref: '#/components/schemas/additionalProperties' selection: $ref: '#/components/schemas/component_list' snapshot_GET: type: object nullable: true properties: + additionalProperties: + $ref: '#/components/schemas/additionalProperties' snapshot_type: type: string enum: @@ -2688,6 +2787,8 @@ components: type: object nullable: true properties: + additionalProperties: + $ref: '#/components/schemas/additionalProperties' snapshot_type: type: string enum: @@ -2700,6 +2801,8 @@ components: type: object nullable: true properties: + additionalProperties: + $ref: '#/components/schemas/additionalProperties' spaces_visible: type: boolean default: false @@ -2713,6 +2816,8 @@ components: type: object nullable: true properties: + additionalProperties: + $ref: '#/components/schemas/additionalProperties' spaces_translucent: type: boolean default: true @@ -2725,6 +2830,8 @@ components: translucency_GET: type: object properties: + additionalProperties: + $ref: '#/components/schemas/additionalProperties' translucency: $ref: '#/components/schemas/translucency' viewpoint_GET: @@ -2734,6 +2841,8 @@ components: - creation_date - creation_author properties: + additionalProperties: + $ref: '#/components/schemas/additionalProperties' index: type: integer nullable: true @@ -2773,6 +2882,8 @@ components: authorization: type: object properties: + additionalProperties: + $ref: '#/components/schemas/additionalProperties' viewpoint_actions: $ref: "#/components/schemas/viewpoint_actions" topic_file_ids: @@ -2783,6 +2894,8 @@ components: viewpoint_POST: type: object properties: + additionalProperties: + $ref: '#/components/schemas/additionalProperties' viewpoint_guid: type: string nullable: true @@ -2826,6 +2939,8 @@ components: visibility: type: object properties: + additionalProperties: + $ref: '#/components/schemas/additionalProperties' default_visibility: type: boolean default: false @@ -2836,11 +2951,15 @@ components: visibility_GET: type: object properties: + additionalProperties: + $ref: '#/components/schemas/additionalProperties' visibility: $ref: '#/components/schemas/visibility' translucency: type: object properties: + additionalProperties: + $ref: '#/components/schemas/additionalProperties' default_translucency: type: boolean default: false @@ -2851,6 +2970,8 @@ components: project_custom_field_extension: type: object properties: + additionalProperties: + $ref: '#/components/schemas/additionalProperties' id: type: string name: @@ -2882,6 +3003,8 @@ components: project_custom_field_enum_value: type: object properties: + additionalProperties: + $ref: '#/components/schemas/additionalProperties' value: type: string displayValue: @@ -2891,6 +3014,8 @@ components: marker: type: object properties: + additionalProperties: + $ref: '#/components/schemas/additionalProperties' location: $ref: '#/components/schemas/point' user_GET: @@ -2901,6 +3026,8 @@ components: - required: ['name'] - required: ['email'] properties: + additionalProperties: + $ref: '#/components/schemas/additionalProperties' id: type: string description: 'This is a string that uniquely identifies the user in the server, often it is an email address or an internal id' @@ -2915,6 +3042,8 @@ components: - pagination - data properties: + additionalProperties: + $ref: '#/components/schemas/additionalProperties' pagination: $ref: '#/components/schemas/pagination' data: @@ -2928,6 +3057,8 @@ components: - pagination - data properties: + additionalProperties: + $ref: '#/components/schemas/additionalProperties' pagination: $ref: '#/components/schemas/pagination' data: @@ -2941,6 +3072,8 @@ components: - pagination - data properties: + additionalProperties: + $ref: '#/components/schemas/additionalProperties' pagination: $ref: '#/components/schemas/pagination' data: @@ -2954,6 +3087,8 @@ components: - pagination - data properties: + additionalProperties: + $ref: '#/components/schemas/additionalProperties' pagination: $ref: '#/components/schemas/pagination' data: @@ -2967,6 +3102,8 @@ components: - pagination - data properties: + additionalProperties: + $ref: '#/components/schemas/additionalProperties' pagination: $ref: '#/components/schemas/pagination' data: @@ -2980,6 +3117,8 @@ components: - pagination - data properties: + additionalProperties: + $ref: '#/components/schemas/additionalProperties' pagination: $ref: '#/components/schemas/pagination' data: @@ -2993,6 +3132,8 @@ components: - pagination - data properties: + additionalProperties: + $ref: '#/components/schemas/additionalProperties' pagination: $ref: '#/components/schemas/pagination' data: @@ -3006,6 +3147,8 @@ components: - pagination - data properties: + additionalProperties: + $ref: '#/components/schemas/additionalProperties' pagination: $ref: '#/components/schemas/pagination' data: @@ -3019,6 +3162,8 @@ components: - pagination - data properties: + additionalProperties: + $ref: '#/components/schemas/additionalProperties' pagination: $ref: '#/components/schemas/pagination' data: @@ -3032,6 +3177,8 @@ components: - pagination - data properties: + additionalProperties: + $ref: '#/components/schemas/additionalProperties' pagination: $ref: '#/components/schemas/pagination' data: @@ -3045,6 +3192,8 @@ components: - pagination - data properties: + additionalProperties: + $ref: '#/components/schemas/additionalProperties' pagination: $ref: '#/components/schemas/pagination' data: From 751fcbcee08514b9d72dbd3f667cdba667bcd18f Mon Sep 17 00:00:00 2001 From: Jon Anders Sollien Date: Mon, 10 Mar 2025 11:34:11 +0100 Subject: [PATCH 2/6] Use default ap --- swagger.yaml | 222 +++++++++++++++++---------------------------------- 1 file changed, 73 insertions(+), 149 deletions(-) diff --git a/swagger.yaml b/swagger.yaml index 543fffc..87a8cda 100644 --- a/swagger.yaml +++ b/swagger.yaml @@ -1859,9 +1859,6 @@ paths: } components: schemas: - additionalProperties: - type: object - additionalProperties: true pagination: type: object required: @@ -1869,9 +1866,8 @@ components: - top - totalCount - data + additionalProperties: true properties: - additionalProperties: - $ref: '#/components/schemas/additionalProperties' skip: type: integer top: @@ -1886,9 +1882,8 @@ components: description: Schema for error, BCF REST API. This is defined in the Foundation API and represents the body format of any error responses. required: - message + additionalProperties: true properties: - additionalProperties: - $ref: '#/components/schemas/additionalProperties' message: type: string # project schemas @@ -1901,9 +1896,8 @@ components: - priority - users - stage + additionalProperties: true properties: - additionalProperties: - $ref: '#/components/schemas/additionalProperties' topic_type: type: array nullable: true @@ -1957,9 +1951,8 @@ components: - id - name - readonly + additionalProperties: true properties: - additionalProperties: - $ref: '#/components/schemas/additionalProperties' id: type: string name: @@ -1973,9 +1966,8 @@ components: - name - status_type - readonly + additionalProperties: true properties: - additionalProperties: - $ref: '#/components/schemas/additionalProperties' id: type: string name: @@ -1992,9 +1984,8 @@ components: - name - email - readonly + additionalProperties: true properties: - additionalProperties: - $ref: '#/components/schemas/additionalProperties' id: type: string name: @@ -2007,9 +1998,8 @@ components: type: object required: - id + additionalProperties: true properties: - additionalProperties: - $ref: '#/components/schemas/additionalProperties' id: type: string project_GET: @@ -2018,18 +2008,16 @@ components: required: - project_id - name + additionalProperties: true properties: - additionalProperties: - $ref: '#/components/schemas/additionalProperties' project_id: type: string name: type: string authorization: type: object + additionalProperties: true properties: - additionalProperties: - $ref: '#/components/schemas/additionalProperties' project_actions: $ref: '#/components/schemas/project_actions' project_PUT: @@ -2037,9 +2025,8 @@ components: description: Schema for project PUT, BCF REST API. required: - name + additionalProperties: true properties: - additionalProperties: - $ref: '#/components/schemas/additionalProperties' name: type: string # actions schemas @@ -2081,18 +2068,16 @@ components: nullable: true required: - type + additionalProperties: true properties: - additionalProperties: - $ref: '#/components/schemas/additionalProperties' type: type: string value: $ref: "#/components/schemas/event_action_value" event_action_value: type: object + additionalProperties: true properties: - additionalProperties: - $ref: '#/components/schemas/additionalProperties' id: type: string displayValue: @@ -2106,9 +2091,8 @@ components: - author - comment - topic_guid + additionalProperties: true properties: - additionalProperties: - $ref: '#/components/schemas/additionalProperties' comment_guid: type: string date: @@ -2134,18 +2118,16 @@ components: $ref: "#/components/schemas/user_GET" authorization: type: object + additionalProperties: true properties: - additionalProperties: - $ref: '#/components/schemas/additionalProperties' comment_actions: $ref: "#/components/schemas/comment_actions" comment_POST: type: object required: - comment + additionalProperties: true properties: - additionalProperties: - $ref: '#/components/schemas/additionalProperties' comment: type: string viewpoint_guid: @@ -2159,9 +2141,8 @@ components: type: object required: - comment + additionalProperties: true properties: - additionalProperties: - $ref: '#/components/schemas/additionalProperties' comment: type: string viewpoint_guid: @@ -2177,9 +2158,8 @@ components: required: - document_guid - filename + additionalProperties: true properties: - additionalProperties: - $ref: '#/components/schemas/additionalProperties' document_guid: type: string filename: @@ -2190,9 +2170,8 @@ components: type: object required: - guid + additionalProperties: true properties: - additionalProperties: - $ref: '#/components/schemas/additionalProperties' guid: type: string document_guid: @@ -2206,9 +2185,8 @@ components: nullable: true document_reference_POST: type: object + additionalProperties: true properties: - additionalProperties: - $ref: '#/components/schemas/additionalProperties' # should be document_reference_guid ? document_reference_guid: type: string @@ -2224,9 +2202,8 @@ components: nullable: true document_reference_PUT: type: object + additionalProperties: true properties: - additionalProperties: - $ref: '#/components/schemas/additionalProperties' document_guid: type: string nullable: true @@ -2244,9 +2221,8 @@ components: - topic_guid - date - author + additionalProperties: true properties: - additionalProperties: - $ref: '#/components/schemas/additionalProperties' comment_guid: type: string topic_guid: @@ -2267,9 +2243,8 @@ components: - topic_guid - date - author + additionalProperties: true properties: - additionalProperties: - $ref: '#/components/schemas/additionalProperties' topic_guid: type: string date: @@ -2286,9 +2261,8 @@ components: file_GET: description: Schema for a single file GET, BCF REST API. type: object + additionalProperties: true properties: - additionalProperties: - $ref: '#/components/schemas/additionalProperties' ifc_project: type: string nullable: true @@ -2310,9 +2284,8 @@ components: nullable: true file_PUT: type: object + additionalProperties: true properties: - additionalProperties: - $ref: '#/components/schemas/additionalProperties' ifc_project: type: string nullable: true @@ -2335,9 +2308,8 @@ components: required: - field_display_name - field_value + additionalProperties: true properties: - additionalProperties: - $ref: '#/components/schemas/additionalProperties' field_display_name: type: string field_value: @@ -2345,9 +2317,8 @@ components: project_file_information: type: object description: Schema for a single project file information, BCF REST API. + additionalProperties: true properties: - additionalProperties: - $ref: '#/components/schemas/additionalProperties' display_information: type: array default: [] @@ -2367,9 +2338,8 @@ components: required: - related_topic_guid - relation_type + additionalProperties: true properties: - additionalProperties: - $ref: '#/components/schemas/additionalProperties' related_topic_guid: type: string relation_type: @@ -2381,9 +2351,8 @@ components: required: - related_topic_guid - relation_type + additionalProperties: true properties: - additionalProperties: - $ref: '#/components/schemas/additionalProperties' related_topic_guid: type: string relation_type: @@ -2398,9 +2367,8 @@ components: - server_assigned_id - creation_date - creation_author + additionalProperties: true properties: - additionalProperties: - $ref: '#/components/schemas/additionalProperties' topic_guid: type: string server_assigend_id: @@ -2455,9 +2423,8 @@ components: $ref: '#/components/schemas/related_topic_GET' authorization: type: object + additionalProperties: true properties: - additionalProperties: - $ref: '#/components/schemas/additionalProperties' topic_actions: $ref: '#/components/schemas/topic_actions' topic_status: @@ -2474,9 +2441,8 @@ components: type: object required: - title + additionalProperties: true properties: - additionalProperties: - $ref: '#/components/schemas/additionalProperties' topic_guid: type: string nullable: true @@ -2521,9 +2487,8 @@ components: type: object required: - title + additionalProperties: true properties: - additionalProperties: - $ref: '#/components/schemas/additionalProperties' topic_type: $ref: "#/components/schemas/extension_item_SET" topic_status: @@ -2568,9 +2533,8 @@ components: $ref: '#/components/schemas/topic_custom_field' topic_custom_field: type: object + additionalProperties: true properties: - additionalProperties: - $ref: '#/components/schemas/additionalProperties' id: type: string nullable: true @@ -2581,9 +2545,8 @@ components: # viewpoint schemas bitmap_GET: type: object + additionalProperties: true properties: - additionalProperties: - $ref: '#/components/schemas/additionalProperties' bitmap_guid: type: string bitmap_type: @@ -2601,9 +2564,8 @@ components: type: number bitmap_POST: type: object + additionalProperties: true properties: - additionalProperties: - $ref: '#/components/schemas/additionalProperties' bitmap_type: type: string enum: @@ -2623,18 +2585,16 @@ components: clipping_plane: type: object nullable: true + additionalProperties: true properties: - additionalProperties: - $ref: '#/components/schemas/additionalProperties' location: $ref: '#/components/schemas/location' direction: $ref: '#/components/schemas/direction' coloring: type: object + additionalProperties: true properties: - additionalProperties: - $ref: '#/components/schemas/additionalProperties' color: type: string components: @@ -2642,9 +2602,8 @@ components: coloring_GET: description: Schema for coloring GET, BCF REST API. type: object + additionalProperties: true properties: - additionalProperties: - $ref: '#/components/schemas/additionalProperties' coloring: type: array nullable: true @@ -2652,9 +2611,8 @@ components: $ref: '#/components/schemas/coloring' component: type: object + additionalProperties: true properties: - additionalProperties: - $ref: '#/components/schemas/additionalProperties' ifc_guid: type: string nullable: true @@ -2672,9 +2630,8 @@ components: components: type: object nullable: true + additionalProperties: true properties: - additionalProperties: - $ref: '#/components/schemas/additionalProperties' selection: $ref: '#/components/schemas/component_list' coloring: @@ -2688,9 +2645,8 @@ components: $ref: '#/components/schemas/translucency' direction: type: object + additionalProperties: true properties: - additionalProperties: - $ref: '#/components/schemas/additionalProperties' x: type: number y: @@ -2700,9 +2656,8 @@ components: line: type: object nullable: true + additionalProperties: true properties: - additionalProperties: - $ref: '#/components/schemas/additionalProperties' start_point: $ref: '#/components/schemas/point' end_point: @@ -2712,9 +2667,8 @@ components: location: type: object nullable: true + additionalProperties: true properties: - additionalProperties: - $ref: '#/components/schemas/additionalProperties' x: type: number y: @@ -2724,9 +2678,8 @@ components: orthogonal_camera: type: object nullable: true + additionalProperties: true properties: - additionalProperties: - $ref: '#/components/schemas/additionalProperties' camera_view_point: $ref: '#/components/schemas/point' camera_direction: @@ -2740,9 +2693,8 @@ components: perspective_camera: type: object nullable: true + additionalProperties: true properties: - additionalProperties: - $ref: '#/components/schemas/additionalProperties' camera_view_point: $ref: '#/components/schemas/point' camera_direction: @@ -2755,9 +2707,8 @@ components: type: number point: type: object + additionalProperties: true properties: - additionalProperties: - $ref: '#/components/schemas/additionalProperties' x: type: number y: @@ -2767,17 +2718,15 @@ components: selection_GET: description: Schema for selection GET, BCF REST API. type: object + additionalProperties: true properties: - additionalProperties: - $ref: '#/components/schemas/additionalProperties' selection: $ref: '#/components/schemas/component_list' snapshot_GET: type: object nullable: true + additionalProperties: true properties: - additionalProperties: - $ref: '#/components/schemas/additionalProperties' snapshot_type: type: string enum: @@ -2786,9 +2735,8 @@ components: snapshot_POST: type: object nullable: true + additionalProperties: true properties: - additionalProperties: - $ref: '#/components/schemas/additionalProperties' snapshot_type: type: string enum: @@ -2800,9 +2748,8 @@ components: view_setup_hints: type: object nullable: true + additionalProperties: true properties: - additionalProperties: - $ref: '#/components/schemas/additionalProperties' spaces_visible: type: boolean default: false @@ -2815,9 +2762,8 @@ components: translucency_setup_hints: type: object nullable: true + additionalProperties: true properties: - additionalProperties: - $ref: '#/components/schemas/additionalProperties' spaces_translucent: type: boolean default: true @@ -2829,9 +2775,8 @@ components: default: true translucency_GET: type: object + additionalProperties: true properties: - additionalProperties: - $ref: '#/components/schemas/additionalProperties' translucency: $ref: '#/components/schemas/translucency' viewpoint_GET: @@ -2840,9 +2785,8 @@ components: - viewpoint_guid - creation_date - creation_author + additionalProperties: true properties: - additionalProperties: - $ref: '#/components/schemas/additionalProperties' index: type: integer nullable: true @@ -2881,9 +2825,8 @@ components: $ref: "#/components/schemas/user_GET" authorization: type: object + additionalProperties: true properties: - additionalProperties: - $ref: '#/components/schemas/additionalProperties' viewpoint_actions: $ref: "#/components/schemas/viewpoint_actions" topic_file_ids: @@ -2893,9 +2836,8 @@ components: type: string viewpoint_POST: type: object + additionalProperties: true properties: - additionalProperties: - $ref: '#/components/schemas/additionalProperties' viewpoint_guid: type: string nullable: true @@ -2938,9 +2880,8 @@ components: type: string visibility: type: object + additionalProperties: true properties: - additionalProperties: - $ref: '#/components/schemas/additionalProperties' default_visibility: type: boolean default: false @@ -2950,16 +2891,14 @@ components: $ref: '#/components/schemas/view_setup_hints' visibility_GET: type: object + additionalProperties: true properties: - additionalProperties: - $ref: '#/components/schemas/additionalProperties' visibility: $ref: '#/components/schemas/visibility' translucency: type: object + additionalProperties: true properties: - additionalProperties: - $ref: '#/components/schemas/additionalProperties' default_translucency: type: boolean default: false @@ -2969,9 +2908,8 @@ components: $ref: '#/components/schemas/translucency_setup_hints' project_custom_field_extension: type: object + additionalProperties: true properties: - additionalProperties: - $ref: '#/components/schemas/additionalProperties' id: type: string name: @@ -3002,9 +2940,8 @@ components: $ref: '#/components/schemas/project_custom_field_enum_value' project_custom_field_enum_value: type: object + additionalProperties: true properties: - additionalProperties: - $ref: '#/components/schemas/additionalProperties' value: type: string displayValue: @@ -3013,9 +2950,8 @@ components: type: boolean marker: type: object + additionalProperties: true properties: - additionalProperties: - $ref: '#/components/schemas/additionalProperties' location: $ref: '#/components/schemas/point' user_GET: @@ -3025,9 +2961,8 @@ components: oneOf: - required: ['name'] - required: ['email'] + additionalProperties: true properties: - additionalProperties: - $ref: '#/components/schemas/additionalProperties' id: type: string description: 'This is a string that uniquely identifies the user in the server, often it is an email address or an internal id' @@ -3041,9 +2976,8 @@ components: required: - pagination - data + additionalProperties: true properties: - additionalProperties: - $ref: '#/components/schemas/additionalProperties' pagination: $ref: '#/components/schemas/pagination' data: @@ -3056,9 +2990,8 @@ components: required: - pagination - data + additionalProperties: true properties: - additionalProperties: - $ref: '#/components/schemas/additionalProperties' pagination: $ref: '#/components/schemas/pagination' data: @@ -3071,9 +3004,8 @@ components: required: - pagination - data + additionalProperties: true properties: - additionalProperties: - $ref: '#/components/schemas/additionalProperties' pagination: $ref: '#/components/schemas/pagination' data: @@ -3086,9 +3018,8 @@ components: required: - pagination - data + additionalProperties: true properties: - additionalProperties: - $ref: '#/components/schemas/additionalProperties' pagination: $ref: '#/components/schemas/pagination' data: @@ -3101,9 +3032,8 @@ components: required: - pagination - data + additionalProperties: true properties: - additionalProperties: - $ref: '#/components/schemas/additionalProperties' pagination: $ref: '#/components/schemas/pagination' data: @@ -3116,9 +3046,8 @@ components: required: - pagination - data + additionalProperties: true properties: - additionalProperties: - $ref: '#/components/schemas/additionalProperties' pagination: $ref: '#/components/schemas/pagination' data: @@ -3131,9 +3060,8 @@ components: required: - pagination - data + additionalProperties: true properties: - additionalProperties: - $ref: '#/components/schemas/additionalProperties' pagination: $ref: '#/components/schemas/pagination' data: @@ -3146,9 +3074,8 @@ components: required: - pagination - data + additionalProperties: true properties: - additionalProperties: - $ref: '#/components/schemas/additionalProperties' pagination: $ref: '#/components/schemas/pagination' data: @@ -3161,9 +3088,8 @@ components: required: - pagination - data + additionalProperties: true properties: - additionalProperties: - $ref: '#/components/schemas/additionalProperties' pagination: $ref: '#/components/schemas/pagination' data: @@ -3176,9 +3102,8 @@ components: required: - pagination - data + additionalProperties: true properties: - additionalProperties: - $ref: '#/components/schemas/additionalProperties' pagination: $ref: '#/components/schemas/pagination' data: @@ -3191,9 +3116,8 @@ components: required: - pagination - data + additionalProperties: true properties: - additionalProperties: - $ref: '#/components/schemas/additionalProperties' pagination: $ref: '#/components/schemas/pagination' data: From e95d98862c95c83ed57be73da16e422167ce5690 Mon Sep 17 00:00:00 2001 From: Jon Anders Sollien Date: Mon, 10 Mar 2025 11:44:42 +0100 Subject: [PATCH 3/6] Extract objects --- swagger.yaml | 64 +++++++++++++++++++++++++++++++--------------------- 1 file changed, 38 insertions(+), 26 deletions(-) diff --git a/swagger.yaml b/swagger.yaml index 87a8cda..9f1da04 100644 --- a/swagger.yaml +++ b/swagger.yaml @@ -1887,6 +1887,39 @@ components: message: type: string # project schemas + viewpoint_authorization: + type: object + additionalProperties: true + properties: + viewpoint_actions: + $ref: "#/components/schemas/viewpoint_actions" + + project_authorization: + type: object + additionalProperties: true + properties: + project_actions: + $ref: '#/components/schemas/project_actions' + + comment_authorization: + type: object + additionalProperties: true + properties: + comment_actions: + $ref: "#/components/schemas/comment_actions" + + topic_authorization: + type: object + additionalProperties: true + properties: + topic_actions: + $ref: '#/components/schemas/topic_actions' + topic_status: + type: array + nullable: true + items: + type: string + extensions_GET: type: object required: @@ -2015,11 +2048,7 @@ components: name: type: string authorization: - type: object - additionalProperties: true - properties: - project_actions: - $ref: '#/components/schemas/project_actions' + $ref: "#/components/schemas/project_authorization" project_PUT: type: object description: Schema for project PUT, BCF REST API. @@ -2117,11 +2146,7 @@ components: modified_author: $ref: "#/components/schemas/user_GET" authorization: - type: object - additionalProperties: true - properties: - comment_actions: - $ref: "#/components/schemas/comment_actions" + $ref: "#/components/schemas/comment_authorization" comment_POST: type: object required: @@ -2422,16 +2447,7 @@ components: items: $ref: '#/components/schemas/related_topic_GET' authorization: - type: object - additionalProperties: true - properties: - topic_actions: - $ref: '#/components/schemas/topic_actions' - topic_status: - type: array - nullable: true - items: - type: string + $ref: "#/components/schemas/topic_authorization" default_viewpoint_guid: type: string nullable: true @@ -2824,11 +2840,7 @@ components: creation_author: $ref: "#/components/schemas/user_GET" authorization: - type: object - additionalProperties: true - properties: - viewpoint_actions: - $ref: "#/components/schemas/viewpoint_actions" + $ref: "#/components/schemas/viewpoint_authorization" topic_file_ids: type: array nullable: true @@ -2999,7 +3011,7 @@ components: items: $ref: '#/components/schemas/project_GET' - project_files_informations_GET: + project_files_informations_GET: type: object required: - pagination From dcc6c4511953003f3e6b346bf76917e77f9354c5 Mon Sep 17 00:00:00 2001 From: Jon Anders Sollien Date: Mon, 10 Mar 2025 11:46:49 +0100 Subject: [PATCH 4/6] Update swagger.yaml --- swagger.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/swagger.yaml b/swagger.yaml index 9f1da04..5d4e870 100644 --- a/swagger.yaml +++ b/swagger.yaml @@ -3011,7 +3011,7 @@ components: items: $ref: '#/components/schemas/project_GET' - project_files_informations_GET: + project_files_informations_GET: type: object required: - pagination From 48fc72564dc3ee7d1e934965c4433ef5f4b1344b Mon Sep 17 00:00:00 2001 From: Jon Anders Sollien Date: Mon, 10 Mar 2025 11:47:14 +0100 Subject: [PATCH 5/6] Update swagger.yaml --- swagger.yaml | 150 +++++++++++++++++++++++++-------------------------- 1 file changed, 75 insertions(+), 75 deletions(-) diff --git a/swagger.yaml b/swagger.yaml index 5d4e870..739d9fd 100644 --- a/swagger.yaml +++ b/swagger.yaml @@ -5,7 +5,7 @@ info: servers: # Relative URLs # https://swagger.io/docs/specification/api-host-and-base-path/ -# The server URL defaults to / +# The server URL defaults to / # Test # Added by API Auto Mocking Plugin - description: SwaggerHub API Auto Mocking @@ -82,7 +82,7 @@ paths: summary: Update Project description: Modify a specific project. This operation is only possible when the server returns the update flag in the Project authorization, see section 3.1.5 tags: - - Project + - Project requestBody: required: true content: @@ -116,7 +116,7 @@ paths: Retrieve a specific projects extensions. Project extensions are used to define possible values that can be used in topics and comments, for example topic labels and priorities. They may change during the course of a project. The most recent extensions state which values are valid at a given moment for newly created topics and comments. tags: - - Project + - Project responses: '200': description: OK @@ -187,7 +187,7 @@ paths: type: string description: | Filter items by property values, see [OData Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter) - + |parameter|type|description| |---------|----|-----------| |creation_author|string|userId of the creation author (value from extensions)| @@ -213,11 +213,11 @@ paths: |creation_date|creation date of a topic| |modified_date|modification date of a topic| |server_assigned_id|the server_assigned_id of the topic| - |index|index of a topic| + |index|index of a topic| - $ref: "#/components/parameters/top" - $ref: "#/components/parameters/skip" tags: - - Topics + - Topics responses: '200': description: OK @@ -267,7 +267,7 @@ paths: application/json: schema: $ref: '#/components/schemas/topic_POST' - example: + example: { "topic_type": "Clash", "topic_status": "open", @@ -278,7 +278,7 @@ paths: "Heating" ], "assigned_to": "harry.muster@example.com" - } + } responses: '201': description: Created @@ -286,7 +286,7 @@ paths: application/json: schema: $ref: '#/components/schemas/topic_GET' - example: + example: { "guid": "A245F4F2-2C01-B43B-B612-5E456BEF8116", "server_assigned_id": "ISSUE-01462", @@ -311,7 +311,7 @@ paths: summary: Get Topic description: Retrieve a specific topic. tags: - - Topics + - Topics responses: '200': description: OK @@ -340,20 +340,20 @@ paths: "createViewpoint" ] } - } + } put: summary: Update Topic - description: | + description: | Modify a specific topic, description similar to POST. This operation is only possible when the server returns the update flag in the Topic authorization, see section 3.2.8 tags: - - Topics + - Topics requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/topic_PUT' + $ref: '#/components/schemas/topic_PUT' example: { "topic_type": "Clash", @@ -365,7 +365,7 @@ paths: "Heating" ], "assigned_to": "harry.muster@example.com" - } + } responses: '200': description: OK @@ -373,7 +373,7 @@ paths: application/json: schema: $ref: '#/components/schemas/topic_GET' - example: + example: { "guid": "B345F4F2-3A04-B43B-A713-5E456BEF8228", "server_assigned_id": "ISSUE-00037", @@ -395,7 +395,7 @@ paths: summary: Delete Topic description: Deletes a single topic. This operation is only possible when the server returns the delete flag in the Topic authorization, see section 3.2.8 tags: - - Topics + - Topics responses: '200': description: OK @@ -405,11 +405,11 @@ paths: - $ref: "#/components/parameters/project_id" get: summary: Get Files Information - description: | + description: | Retrieve a collection of project_file_informations to support allowing users to choose which Files (models) to reference in the header of topics created on the server. tags: - - Files + - Files responses: '200': description: OK @@ -445,7 +445,7 @@ paths: }, { "field_display_name": "Revision Date", "field_value": "Apr 30 2020" - }], + }], "file": { "ifc_project": "3hwBHP91jBRwPsmyf$3Hea", "file_name": "OfficeBuilding_Heating_0003.ifc", @@ -461,12 +461,12 @@ paths: get: summary: Get Files description: | - Retrieve a collection of file references as topic header. + Retrieve a collection of file references as topic header. Implementer Note: The reference property can either be an Uri or a server specific id. Uris are given as absolute paths to the model files while ids reference a custom id of the model file and require custom logic per server to retrieve it. This allows referencing of files on the server but requires clients to know how to retrieve files in a specific implementation. tags: - - Files + - Files responses: '200': description: OK @@ -498,7 +498,7 @@ paths: Update a collection of file references on the topic header. This operation is only possible when the server returns the updateFiles flag in the Topic authorization, see section 3.2.8 tags: - - Files + - Files requestBody: required: true content: @@ -516,7 +516,7 @@ paths: "ifc_project": "3hwBHP91jBRwPsmyf$3Hea", "filename": "OfficeBuilding_Heating_0003.ifc", "reference": "https://example.com/files/3hwBHP91jBRwPsmyf$3Hea_0003.ifc" - }] + }] responses: '200': description: OK @@ -526,7 +526,7 @@ paths: type: array items: $ref: '#/components/schemas/file_GET' - example: + example: [{ "ifc_project": "0J$yPqHBD12v72y4qF6XcD", "file_name": "OfficeBuilding_Architecture_0001.ifc", @@ -552,7 +552,7 @@ paths: type: string description: | Filter items by property values, see [OData Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter) - + |parameter|type|description| |---------|----|-----------| |author|string|userId of the author (value from extensions)| @@ -569,7 +569,7 @@ paths: |---------|-----------| |date|creation date of a comment| tags: - - Comments + - Comments responses: '200': description: OK @@ -613,7 +613,7 @@ paths: 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 tags: - - Comments + - Comments requestBody: required: true content: @@ -631,7 +631,7 @@ paths: application/json: schema: $ref: '#/components/schemas/comment_GET' - example: + example: { "guid": "A333FCA8-1A31-CAAC-A321-BB33ABC8414", "date": "2016-08-01T14:24:11.316Z", @@ -641,7 +641,7 @@ paths: } /bcf/{version}/projects/{project_id}/topics/{topic_guid}/comments/{comment_guid}: parameters: - - $ref: "#/components/parameters/version" + - $ref: "#/components/parameters/version" - $ref: "#/components/parameters/project_id" - $ref: "#/components/parameters/topic_guid" - $ref: "#/components/parameters/comment_guid" @@ -649,7 +649,7 @@ paths: summary: Get Comment description: Get a single comment. tags: - - Comments + - Comments responses: '200': description: OK @@ -671,7 +671,7 @@ paths: Update a single comment, description similar to POST. This operation is only possible when the server returns the update flag in the Comment authorization, see section 3.4.6 tags: - - Comments + - Comments requestBody: required: true content: @@ -681,7 +681,7 @@ paths: example: { "comment": "will rework the heating model and fix the ventilation" - } + } responses: '200': description: OK @@ -701,7 +701,7 @@ paths: summary: Delete Comment description: Deletes a single comment. This operation is only possible when the server returns the delete flag in the Comment authorization, see section 3.4.6 tags: - - Comments + - Comments responses: '200': description: OK @@ -714,7 +714,7 @@ paths: summary: Get Viewpoints description: Retrieve a collection of all viewpoints related to a topic. tags: - - Viewpoints + - Viewpoints responses: '200': description: OK @@ -828,7 +828,7 @@ paths: Add a new viewpoint. Viewpoints are immutable, meaning that they should never change. Requirements for different visualizations should be handled by creating new viewpoint elements. This operation is only possible when the server returns the createViewpoint flag in the Topic authorization, see section 3.2.8 tags: - - Viewpoints + - Viewpoints requestBody: required: true content: @@ -937,7 +937,7 @@ paths: application/json: schema: $ref: '#/components/schemas/viewpoint_GET' - example: + example: { "guid": "a11a82e7-e66c-34b4-ada1-5846abf39133", "index": 10, @@ -1018,7 +1018,7 @@ paths: summary: Get Viewpoint description: Retrieve a specific viewpoint. tags: - - Viewpoints + - Viewpoints responses: '200': description: OK @@ -1101,7 +1101,7 @@ paths: summary: Delete Viewpoint description: Deletes a single viewpoint. This operation is only possible when the server returns the delete flag in the Viewpoint authorization, see section 3.5.10 tags: - - Viewpoints + - Viewpoints responses: '200': description: OK @@ -1115,7 +1115,7 @@ paths: summary: Get Snapshot description: Retrieve a viewpoints snapshot (png or jpg) as image file. A viewpoint contains a snapshot if viewpoint.snapshot != null. tags: - - Viewpoints + - Viewpoints responses: '200': description: OK @@ -1135,7 +1135,7 @@ paths: summary: Get Bitmap description: Retrieve a specific viewpoints bitmap image file (png or jpg). tags: - - Viewpoints + - Viewpoints responses: '200': description: OK @@ -1154,7 +1154,7 @@ paths: summary: Get Selection description: Retrieve a collection of all selected components in a viewpoint. tags: - - Viewpoints + - Viewpoints responses: '200': description: OK @@ -1184,7 +1184,7 @@ paths: summary: Get Coloring description: Retrieve a collection of all colored components in a viewpoint. tags: - - Viewpoints + - Viewpoints responses: '200': description: OK @@ -1219,7 +1219,7 @@ paths: summary: Get Visibility description: Retrieve visibility of components in a viewpoint. tags: - - Viewpoints + - Viewpoints responses: '200': description: OK @@ -1257,7 +1257,7 @@ paths: summary: Get Translucency description: Retrieve translucency of components in a viewpoint. tags: - - Viewpoints + - Viewpoints responses: '200': description: OK @@ -1294,7 +1294,7 @@ paths: summary: Get Related Topics description: Retrieve a collection of all related topics to a topic. tags: - - Related Topics + - Related Topics responses: '200': description: OK @@ -1323,7 +1323,7 @@ paths: flag in the Topic authorization, see section 3.2.8. Throws "409 Conflict" if requesting to add a parent-child relation causing an infinite loop. Example: TopicA is already the parent of TopicB. Making TopicB the parent of TopicA is not allowed. tags: - - Related Topics + - Related Topics requestBody: required: true content: @@ -1339,7 +1339,7 @@ paths: "related_topic_guid": "6963a846-54d1-4050-954d-607cd5e48aa3" }, { "related_topic_guid": "bac66ab4-331e-4f21-a28e-083d2cf2e796" - }] + }] responses: '409': description: Conflict @@ -1370,7 +1370,7 @@ paths: Add a document reference to a topic. This operation is only possible when the server returns the updateDocumentReferences flag in the Topic authorization, see section 3.2.8 tags: - - Document References + - Document References responses: '200': description: OK @@ -1410,7 +1410,7 @@ paths: document_guid must be null url must be the url to the external resource tags: - - Document References + - Document References requestBody: required: true content: @@ -1440,14 +1440,14 @@ paths: - $ref: "#/components/parameters/version" - $ref: "#/components/parameters/project_id" - $ref: "#/components/parameters/topic_guid" - - $ref: "#/components/parameters/document_reference_guid" + - $ref: "#/components/parameters/document_reference_guid" put: summary: Update Document Reference description: | Update an existing document reference identified by guid. Uses the same rules as POST Document Reference Service. This operation is only possible when the server returns the updateDocumentReferences flag in the Topic authorization, see section 4.2.8 tags: - - Document References + - Document References requestBody: required: true content: @@ -1482,7 +1482,7 @@ paths: description: | Retrieve a collection of all documents uploaded to a project. tags: - - Documents + - Documents responses: '200': description: OK @@ -1512,7 +1512,7 @@ paths: Upload a document (binary file) to a project. This operation is only possible when the server returns the createDocument flag in the Project authorization, see section 4.1.5 tags: - - Documents + - Documents requestBody: required: true content: @@ -1542,7 +1542,7 @@ paths: description: | Retrieves a document as binary file. tags: - - Documents + - Documents responses: '200': description: OK @@ -1575,7 +1575,7 @@ paths: |topic_guid|string|guid of the topic | |author|string|userId of the author (value from extensions)| |type|string|type of the event (value from Topic event types, table above)| - |date|datetime|date of the event| + |date|datetime|date of the event| - in: query name: $orderby example: date asc @@ -1588,7 +1588,7 @@ paths: |---------|-----------| |date|date of the event| tags: - - Events + - Events responses: '200': description: OK @@ -1650,7 +1650,7 @@ paths: |---------|----|-----------| |author|string|userId of the author (value from extensions)| |type|string|type of the event (value from Topic event types, table above)| - |date|datetime|date of the event| + |date|datetime|date of the event| - in: query name: $orderby example: date asc @@ -1663,7 +1663,7 @@ paths: |---------|-----------| |date|date of the event| tags: - - Events + - Events responses: '200': description: OK @@ -1739,7 +1739,7 @@ paths: |---------|-----------| |date|date of the event| tags: - - Events + - Events responses: '200': description: OK @@ -1817,7 +1817,7 @@ paths: |---------|-----------| |date|date of the event| tags: - - Events + - Events responses: '200': description: OK @@ -1950,7 +1950,7 @@ components: type: array nullable: true items: - $ref: '#/components/schemas/extension_item_GET' + $ref: '#/components/schemas/extension_item_GET' users: type: array nullable: true @@ -2176,7 +2176,7 @@ components: # Not part of 3_0? # reply_to_comment_guid: # type: string - # nullable: true + # nullable: true # document schemas document_GET: type: object @@ -2604,9 +2604,9 @@ components: additionalProperties: true properties: location: - $ref: '#/components/schemas/location' + $ref: '#/components/schemas/location' direction: - $ref: '#/components/schemas/direction' + $ref: '#/components/schemas/direction' coloring: type: object additionalProperties: true @@ -2690,7 +2690,7 @@ components: y: type: number z: - type: number + type: number orthogonal_camera: type: object nullable: true @@ -2906,7 +2906,7 @@ components: additionalProperties: true properties: visibility: - $ref: '#/components/schemas/visibility' + $ref: '#/components/schemas/visibility' translucency: type: object additionalProperties: true @@ -2925,7 +2925,7 @@ components: id: type: string name: - type: string + type: string type: type: string enum: @@ -2957,7 +2957,7 @@ components: value: type: string displayValue: - type: string + type: string readonly: type: boolean marker: @@ -2983,7 +2983,7 @@ components: email: type: string - topics_GET: + topics_GET: type: object required: - pagination @@ -3006,7 +3006,7 @@ components: properties: pagination: $ref: '#/components/schemas/pagination' - data: + data: type: array items: $ref: '#/components/schemas/project_GET' @@ -3150,19 +3150,19 @@ components: name: project_id schema: type: string - required: true + required: true topic_guid: in: path name: topic_guid schema: type: string - required: true + required: true comment_guid: in: path name: comment_guid schema: type: string - required: true + required: true viewpoint_guid: in: path name: viewpoint_guid @@ -3192,7 +3192,7 @@ components: name: $top schema: type: string - skip: + skip: in: query name: $skip schema: From 4a9267b42906659a67e9a441302819b66e5b5c51 Mon Sep 17 00:00:00 2001 From: Jon Anders Sollien Date: Mon, 10 Mar 2025 11:56:50 +0100 Subject: [PATCH 6/6] Remove oneOf to fix UserGet not being correctly generated --- swagger.yaml | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/swagger.yaml b/swagger.yaml index 739d9fd..b81138e 100644 --- a/swagger.yaml +++ b/swagger.yaml @@ -2970,9 +2970,6 @@ components: type: object required: - id - oneOf: - - required: ['name'] - - required: ['email'] additionalProperties: true properties: id: @@ -2980,8 +2977,10 @@ components: description: 'This is a string that uniquely identifies the user in the server, often it is an email address or an internal id' name: type: string + description: 'Must be provided if email is null' email: type: string + description: 'Must be provided if name is null' topics_GET: type: object