Remove BIM Snippet in Swagger spec (#335)

buildingSMART · Apr 22, 2024 · 93e472e · 93e472e
1 parent 7061f9c
commit 93e472e
Showing 1 changed file with 4 additions and 106 deletions.
diff --git a/swagger.yaml b/swagger.yaml
@@ -132,10 +132,6 @@ paths:
                         "Structural",
                         "MEP"
                     ],
-                    "snippet_type": [
-                        ".ifc",
-                        ".csv"
-                    ],
                     "priority": [
                         "Low",
                         "Medium",
@@ -158,7 +154,6 @@ paths:
                     ],
                     "topic_actions": [
                         "update",
-                        "updateBimSnippet",
                         "updateRelatedTopics",
                         "updateDocumentReferences",
                         "updateFiles",
@@ -268,13 +263,7 @@ paths:
                         "Architecture",
                         "Heating"
                     ],
-                    "assigned_to": "harry.muster@example.com",
-                    "bim_snippet": {
-                        "snippet_type": "clash",
-                        "is_external": true,
-                        "reference": "https://example.com/bcf/1.0/ADFE23AA11BCFF444122BB",
-                        "reference_schema": "https://example.com/bcf/1.0/clash.xsd"
-                    }
+                    "assigned_to": "harry.muster@example.com"
                 }              
       responses:
         '201':
@@ -297,13 +286,7 @@ paths:
                         "Architecture",
                         "Heating"
                     ],
-                    "assigned_to": "harry.muster@example.com",
-                    "bim_snippet": {
-                        "snippet_type": "clash",
-                        "is_external": true,
-                        "reference": "https://example.com/bcf/1.0/ADFE23AA11BCFF444122BB",
-                        "reference_schema": "https://example.com/bcf/1.0/clash.xsd"
-                    }
+                    "assigned_to": "harry.muster@example.com"
                 }
   /bcf/{version}/projects/{project_id}/topics/{topic_id}:
     parameters:
@@ -337,12 +320,6 @@ paths:
                         "Heating"
                     ],
                     "assigned_to": "harry.muster@example.com",
-                    "bim_snippet": {
-                        "snippet_type": "clash",
-                        "is_external": true,
-                        "reference": "https://example.com/bcf/1.0/ADFE23AA11BCFF444122BB",
-                        "reference_schema": "https://example.com/bcf/1.0/clash.xsd"
-                    },
                     "authorization": {
                         "topic_actions": [
                             "createComment",
@@ -373,13 +350,7 @@ paths:
                         "Architecture",
                         "Heating"
                     ],
-                    "assigned_to": "harry.muster@example.com",
-                    "bim_snippet": {
-                        "snippet_type": "clash",
-                        "is_external": true,
-                        "reference": "https://example.com/bcf/1.0/ADFE23AA11BCFF444122BB",
-                        "reference_schema": "https://example.com/bcf/1.0/clash.xsd"
-                    }
+                    "assigned_to": "harry.muster@example.com"
                 }           
       responses:
         '200':
@@ -404,13 +375,7 @@ paths:
                         "Architecture",
                         "Heating"
                     ],
-                    "assigned_to": "harry.muster@example.com",
-                    "bim_snippet": {
-                        "snippet_type": "clash",
-                        "is_external": true,
-                        "reference": "https://example.com/bcf/1.0/ADFE23AA11BCFF444122BB",
-                        "reference_schema": "https://example.com/bcf/1.0/clash.xsd"
-                    }
+                    "assigned_to": "harry.muster@example.com"
                 }
     delete:
       summary: Delete Topic
@@ -420,42 +385,6 @@ paths:
       responses:
         '200':
           description: OK
-  /bcf/{version}/projects/{project_id}/topics/{topic_id}/snippet:
-    parameters:
-    - $ref:  "#/components/parameters/version"
-    - $ref:  "#/components/parameters/project_id"
-    - $ref:  "#/components/parameters/topic_id"
-    get:
-      summary: Get Snippet
-      description: Retrieves a topics BIM-Snippet as binary file.
-      tags:
-        - Snippets       
-      responses:
-        '200':
-          description: OK
-          content:
-            application/octet-stream:
-              schema:
-                type: string
-                format: binary
-    put:
-      summary: Update Snippet
-      description:  |
-        Puts a new BIM Snippet binary file to a topic. If this is used, the parent topics BIM Snippet property is_external must
-        be set to false and the reference must be the file name with extension. This operation is only possible when the server returns the updateBimSnippet
-        flag in the Topic authorization, see section 3.2.8
-      tags:
-        - Snippets       
-      requestBody:
-        required: true
-        content:
-          application/octet-stream:
-            schema:
-              type: string
-              format: binary
-      responses:
-        '200':
-          description: OK
   /bcf/{version}/projects/{project_id}/files_information:
     parameters:
     - $ref:  "#/components/parameters/version"
@@ -1818,7 +1747,6 @@ components:
         - topic_type
         - topic_status
         - topic_label
-        - snippet_type
         - priority
         - users
         - stage
@@ -1841,12 +1769,6 @@ components:
           items:
             type: string
             nullable: true
-        snippet_type:
-          type: array
-          nullable: true
-          items:
-            type: string
-            nullable: true
         priority:
           type: array
           nullable: true
@@ -1914,7 +1836,6 @@ components:
         type: string
         enum:
           - update
-          - updateBimSnippet
           - updateRelatedTopics
           - updateDocumentReferences
           - updateFiles
@@ -2191,23 +2112,6 @@ components:
         related_topic_guid:
           type: string
     # topic schemas
-    bim_snippet:
-      type: object
-      nullable: true
-      required:
-        - snippet_type
-        - is_external
-        - reference
-        - reference_schema
-      properties:
-        snippet_type:
-          type: string
-        is_external:
-          type: string
-        reference:
-          type: string
-        reference_schema:
-          type: string
     topic_GET:
       type: object
       required:
@@ -2265,8 +2169,6 @@ components:
         description:
           type: string
           nullable: true
-        bim_snippet:
-          $ref: '#/components/schemas/bim_snippet'
         due_date:
           type: string
           nullable: true
@@ -2325,8 +2227,6 @@ components:
         description:
           type: string
           nullable: true
-        bim_snippet:
-          $ref: '#/components/schemas/bim_snippet'
         due_date:
           type: string
           nullable: true
@@ -2372,8 +2272,6 @@ components:
         description:
           type: string
           nullable: true
-        bim_snippet:
-          $ref: '#/components/schemas/bim_snippet'
         due_date:
           type: string
           nullable: true