buildingSMART · jasollien · Sep 11, 2021 · Sep 14, 2021 · May 22, 2023 · Jun 5, 2023
diff --git a/.github/workflows/swagger-update.yml b/.github/workflows/swagger-update.yml
@@ -0,0 +1,17 @@
+name: swagger-update
+
+on: [push]
+
+jobs:
+  ubuntu-latest:
+    name: ubuntu-latest
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v1
+      - name: Install SwaggerHub CLI
+        run: 'npm i -g swaggerhub-cli'
+      - name: Push Swagger API to Swagger Hub
+        run: 'swaggerhub api:update buildingSMART/BCF/4.0 -f swagger.yaml'
+        env:
+          SWAGGERHUB_API_KEY: ${{ secrets.SWAGGER_HUB_API_KEY }}
diff --git a/README.md b/README.md
diff --git a/...Collaboration/Action/comment_actions.json → ...Collaboration/Action/comment_actions.json b/...Collaboration/Action/comment_actions.json → ...Collaboration/Action/comment_actions.json
diff --git a/...Collaboration/Action/project_actions.json → ...Collaboration/Action/project_actions.json b/...Collaboration/Action/project_actions.json → ...Collaboration/Action/project_actions.json
diff --git a/...3/Collaboration/Action/topic_actions.json → ...s/Collaboration/Action/topic_actions.json b/...3/Collaboration/Action/topic_actions.json → ...s/Collaboration/Action/topic_actions.json
@@ -5,7 +5,6 @@
     "items": {
         "type": "string",
         "enum": ["update",
-        "updateBimSnippet",
         "updateRelatedTopics",
         "updateDocumentReferences",
         "updateFiles",

diff --git a/...llaboration/Action/viewpoint_actions.json → ...llaboration/Action/viewpoint_actions.json b/...llaboration/Action/viewpoint_actions.json → ...llaboration/Action/viewpoint_actions.json
diff --git a/...03/Collaboration/Comment/comment_GET.json → ...as/Collaboration/Comment/comment_GET.json b/...03/Collaboration/Comment/comment_GET.json → ...as/Collaboration/Comment/comment_GET.json
@@ -12,7 +12,7 @@
         },
         "author": {
             "required": true,
-            "type": "string"
+            "$ref": "../../User/user_GET.json"
         },
         "comment": {
             "required": true,
@@ -31,8 +31,7 @@
             "null"]
         },
         "modified_author": {
-            "type": ["string",
-            "null"]
+            "$ref": "../../User/user_GET.json"
         },
         "authorization": {
             "type": "object",

diff --git a/...3/Collaboration/Comment/comment_POST.json → ...s/Collaboration/Comment/comment_POST.json b/...3/Collaboration/Comment/comment_POST.json → ...s/Collaboration/Comment/comment_POST.json
diff --git a/...03/Collaboration/Comment/comment_PUT.json → ...as/Collaboration/Comment/comment_PUT.json b/...03/Collaboration/Comment/comment_PUT.json → ...as/Collaboration/Comment/comment_PUT.json
diff --git a/.../Collaboration/Document/document_GET.json → .../Collaboration/Document/document_GET.json b/.../Collaboration/Document/document_GET.json → .../Collaboration/Document/document_GET.json
diff --git a/...mentReference/document_reference_GET.json → ...mentReference/document_reference_GET.json b/...mentReference/document_reference_GET.json → ...mentReference/document_reference_GET.json
diff --git a/...entReference/document_reference_POST.json → ...entReference/document_reference_POST.json b/...entReference/document_reference_POST.json → ...entReference/document_reference_POST.json
diff --git a/...mentReference/document_reference_PUT.json → ...mentReference/document_reference_PUT.json b/...mentReference/document_reference_PUT.json → ...mentReference/document_reference_PUT.json
diff --git a/...llaboration/Events/comment_event_GET.json → ...llaboration/Events/comment_event_GET.json b/...llaboration/Events/comment_event_GET.json → ...llaboration/Events/comment_event_GET.json
@@ -16,7 +16,7 @@
         },
         "author": {
             "required": true,
-            "type": "string"
+            "$ref": "../../User/user_GET.json"
         },
         "actions": {
             "type": "array",

diff --git a/...03/Collaboration/Events/event_action.json → ...as/Collaboration/Events/event_action.json b/...03/Collaboration/Events/event_action.json → ...as/Collaboration/Events/event_action.json
@@ -7,8 +7,7 @@
             "type": "string"
         },
         "value": {
-            "type": ["string",
-            "null"]
+            "$ref": "event_action_value.json"
         }
     }
 }
diff --git a/Schemas/Collaboration/Events/event_action_value.json b/Schemas/Collaboration/Events/event_action_value.json
@@ -0,0 +1,12 @@
+{
+    "title": "event_action",
+    "type": ["object", "null"],
+    "properties": {
+        "id":  {
+            "type": ["string", "null"]
+        },
+        "displayValue": {
+            "type": ["string", "null"]
+        }
+    }
+}
diff --git a/...Collaboration/Events/topic_event_GET.json → ...Collaboration/Events/topic_event_GET.json b/...Collaboration/Events/topic_event_GET.json → ...Collaboration/Events/topic_event_GET.json
@@ -12,7 +12,7 @@
         },
         "author": {
             "required": true,
-            "type": "string"
+            "$ref": "../../User/user_GET.json"
         },
         "actions": {
             "type": "array",

diff --git a/...draft-03/Collaboration/File/file_GET.json → Schemas/Collaboration/File/file_GET.json b/...draft-03/Collaboration/File/file_GET.json → Schemas/Collaboration/File/file_GET.json
@@ -23,6 +23,10 @@
         "reference": {
             "type": ["string",
             "null"]
+        },
+        "id": {
+            "type": ["string",
+            "null"]
         }
     }
 }
diff --git a/...draft-03/Collaboration/File/file_PUT.json → Schemas/Collaboration/File/file_PUT.json b/...draft-03/Collaboration/File/file_PUT.json → Schemas/Collaboration/File/file_PUT.json
diff --git a/...ile/project_file_display_information.json → ...ile/project_file_display_information.json b/...ile/project_file_display_information.json → ...ile/project_file_display_information.json
diff --git a/...ration/File/project_file_information.json → ...ration/File/project_file_information.json b/...ration/File/project_file_information.json → ...ration/File/project_file_information.json
diff --git a/...n/File/project_files_information_GET.json → ...n/File/project_files_information_GET.json b/...n/File/project_files_information_GET.json → ...n/File/project_files_information_GET.json
diff --git a/...ation/RelatedTopic/related_topic_GET.json → ...ation/RelatedTopic/related_topic_GET.json b/...ation/RelatedTopic/related_topic_GET.json → ...ation/RelatedTopic/related_topic_GET.json
@@ -7,6 +7,11 @@
         "related_topic_guid": {
             "required": true,
             "type": "string"
+        },
+        "relation_type": {
+            "required": true,
+            "type": "string",
+            "enum": ["relates", "parent", "child"]
         }
     }
 }
diff --git a/...ation/RelatedTopic/related_topic_PUT.json → ...ation/RelatedTopic/related_topic_PUT.json b/...ation/RelatedTopic/related_topic_PUT.json → ...ation/RelatedTopic/related_topic_PUT.json
@@ -7,6 +7,11 @@
         "related_topic_guid": {
             "required": true,
             "type": "string"
+        },
+        "relation_type": {
+            "required": true,
+            "type": "string",
+            "enum": ["relates", "parent", "child"]
         }
     }
 }
diff --git a/Schemas/Collaboration/Topic/custom_field.json b/Schemas/Collaboration/Topic/custom_field.json
@@ -0,0 +1,18 @@
+{
+    "title": "custom_field",
+    "type": ["object"],
+    "properties": {
+        "id": {
+            "description": "Refers to the id of the custom field in the project extensions.",
+            "required": false,
+            "type": "string"
+        },
+        "values": {
+            "required": false,
+            "type": "array",
+            "items": {
+                "type": "string"
+            }
+        }
+    }
+}
diff --git a/Schemas/Collaboration/Topic/custom_fields.json b/Schemas/Collaboration/Topic/custom_fields.json
@@ -0,0 +1,7 @@
+{
+    "title": "custom_fields",
+    "type": ["array"],
+    "items": {
+        "$ref": "custom_field.json"
+    }
+}
diff --git a/Schemas/Collaboration/Topic/extension_item_GET.json b/Schemas/Collaboration/Topic/extension_item_GET.json
@@ -0,0 +1,14 @@
+{
+    "title": "extension_item_get",
+    "type": ["object", "null"],
+    "properties": {
+        "id": {
+            "type": "string",
+            "required": true
+        },
+        "name": {
+            "type": "string",
+            "required": true
+        }
+    }
+}
diff --git a/Schemas/Collaboration/Topic/extension_item_SET.json b/Schemas/Collaboration/Topic/extension_item_SET.json
@@ -0,0 +1,10 @@
+{
+    "title": "extension_item_set",
+    "type": ["object", "null"],
+    "properties": {
+        "id": {
+            "type": "string",
+            "required": true
+        }
+    }
+}
diff --git a/...aft-03/Collaboration/Topic/topic_GET.json → Schemas/Collaboration/Topic/topic_GET.json b/...aft-03/Collaboration/Topic/topic_GET.json → Schemas/Collaboration/Topic/topic_GET.json
@@ -1,6 +1,6 @@
 {
     "title": "topic_GET",
-    "type": "object",
+    "type": ["object", "null"],
     "properties": {
         "guid": {
             "required": true,
@@ -11,12 +11,10 @@
             "type": "string"
         },
         "topic_type": {
-            "type": ["string",
-            "null"]
+            "$ref": "extension_item_GET.json"
         },
         "topic_status": {
-            "type": ["string",
-            "null"]
+            "$ref": "extension_item_GET.json"
         },
         "reference_links": {
             "type": ["array",
@@ -30,8 +28,7 @@
             "type": "string"
         },
         "priority": {
-            "type": ["string",
-            "null"]
+            "$ref": "extension_item_GET.json"
         },
         "index": {
             "type": [
@@ -43,8 +40,7 @@
             "type": ["array",
             "null"],
             "items": {
-                "type": ["string",
-                "null"]
+                "$ref": "extension_item_GET.json"
             }
         },
         "creation_date": {
@@ -53,34 +49,40 @@
         },
         "creation_author": {
             "required": true,
-            "type": "string"
+            "$ref": "../../User/user_GET.json"
         },
         "modified_date": {
             "type": "string"
         },
         "modified_author": {
-            "type": ["string",
-            "null"]
+            "$ref": "../../User/user_GET.json"
         },
         "assigned_to": {
-            "type": ["string",
-            "null"]
+            "$ref": "../../User/user_GET.json"
         },
         "stage": {
-            "type": ["string",
-            "null"]
+            "$ref": "extension_item_GET.json"
         },
         "description": {
             "type": ["string",
             "null"]
         },
-        "bim_snippet": {
-            "$ref": "bim_snippet.json"
-        },
         "due_date": {
             "type": ["string",
             "null"]
         },
+        "custom_fields": {
+            "$ref": "custom_fields.json"
+        },
+        "related_topics": {
+            "type": ["array", "null"],
+            "items": {
+                "$ref": "../RelatedTopic/related_topic_GET.json"
+            }
+        },
+        "default_viewpoint_guid": {
+            "type": ["string", "null"]
+        },
         "authorization": {
             "type": "object",
             "required": false,

diff --git a/...ft-03/Collaboration/Topic/topic_POST.json → Schemas/Collaboration/Topic/topic_POST.json b/...ft-03/Collaboration/Topic/topic_POST.json → Schemas/Collaboration/Topic/topic_POST.json
@@ -9,12 +9,10 @@
             "null"]
         },
         "topic_type": {
-            "type": ["string",
-            "null"]
+            "$ref": "extension_item_SET.json"
         },
         "topic_status": {
-            "type": ["string",
-            "null"]
+            "$ref": "extension_item_SET.json"
         },
         "reference_links": {
             "type": ["array",
@@ -28,8 +26,7 @@
             "type": "string"
         },
         "priority": {
-            "type": ["string",
-            "null"]
+            "$ref": "extension_item_SET.json"
         },
         "index": {
             "type": [
@@ -41,28 +38,28 @@
             "type": ["array",
             "null"],
             "items": {
-                "type": ["string",
-                "null"]
+                "$ref": "extension_item_SET.json"
             }
         },
         "assigned_to": {
-            "type": ["string",
-            "null"]
+            "$ref": "extension_item_SET.json"
         },
         "stage": {
-            "type": ["string",
-            "null"]
+            "$ref": "extension_item_SET.json"
         },
         "description": {
             "type": ["string",
             "null"]
         },
-        "bim_snippet": {
-            "$ref": "bim_snippet.json"
-        },
         "due_date": {
             "type": ["string",
             "null"]
+        },
+        "custom_fields": {
+            "$ref": "custom_fields.json"
+        },
+        "default_viewpoint_guid": {
+            "type": ["string", "null"]
         }
     }
 }
diff --git a/...aft-03/Collaboration/Topic/topic_PUT.json → Schemas/Collaboration/Topic/topic_PUT.json b/...aft-03/Collaboration/Topic/topic_PUT.json → Schemas/Collaboration/Topic/topic_PUT.json
@@ -5,12 +5,10 @@
     "type": "object",
     "properties": {
         "topic_type": {
-            "type": ["string",
-            "null"]
+            "$ref": "extension_item_SET.json"
         },
         "topic_status": {
-            "type": ["string",
-            "null"]
+            "$ref": "extension_item_SET.json"
         },
         "reference_links": {
             "type": ["array",
@@ -24,8 +22,7 @@
             "type": "string"
         },
         "priority": {
-            "type": ["string",
-            "null"]
+            "$ref": "extension_item_SET.json"
         },
         "index": {
             "type": [
@@ -37,28 +34,28 @@
             "type": ["array",
             "null"],
             "items": {
-                "type": ["string",
-                "null"]
+                "$ref": "extension_item_SET.json"
             }
         },
         "assigned_to": {
-            "type": ["string",
-            "null"]
+            "$ref": "extension_item_SET.json"
         },
         "stage": {
-            "type": ["string",
-            "null"]
+            "$ref": "extension_item_SET.json"
         },
         "description": {
             "type": ["string",
             "null"]
         },
-        "bim_snippet": {
-            "$ref": "bim_snippet.json"
-        },
         "due_date": {
             "type": ["string",
             "null"]
+        },
+        "custom_fields": {
+            "$ref": "custom_fields.json"
+        },
+        "default_viewpoint_guid": {
+            "type": ["string", "null"]
         }
     }
 }
diff --git a/...3/Collaboration/Viewpoint/bitmap_GET.json → ...s/Collaboration/Viewpoint/bitmap_GET.json b/...3/Collaboration/Viewpoint/bitmap_GET.json → ...s/Collaboration/Viewpoint/bitmap_GET.json
diff --git a/.../Collaboration/Viewpoint/bitmap_POST.json → .../Collaboration/Viewpoint/bitmap_POST.json b/.../Collaboration/Viewpoint/bitmap_POST.json → .../Collaboration/Viewpoint/bitmap_POST.json
diff --git a/...llaboration/Viewpoint/clipping_plane.json → ...llaboration/Viewpoint/clipping_plane.json b/...llaboration/Viewpoint/clipping_plane.json → ...llaboration/Viewpoint/clipping_plane.json
diff --git a/...-03/Collaboration/Viewpoint/coloring.json → ...mas/Collaboration/Viewpoint/coloring.json b/...-03/Collaboration/Viewpoint/coloring.json → ...mas/Collaboration/Viewpoint/coloring.json
diff --git a/...Collaboration/Viewpoint/coloring_GET.json → ...Collaboration/Viewpoint/coloring_GET.json b/...Collaboration/Viewpoint/coloring_GET.json → ...Collaboration/Viewpoint/coloring_GET.json
diff --git a/...03/Collaboration/Viewpoint/component.json → ...as/Collaboration/Viewpoint/component.json b/...03/Collaboration/Viewpoint/component.json → ...as/Collaboration/Viewpoint/component.json
diff --git a/...llaboration/Viewpoint/component_list.json → ...llaboration/Viewpoint/component_list.json b/...llaboration/Viewpoint/component_list.json → ...llaboration/Viewpoint/component_list.json