Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Remove BIM Snippet in Swagger spec #335

Merged
merged 1 commit into from
Apr 22, 2024
Merged

Remove BIM Snippet in Swagger spec #335

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
110 changes: 4 additions & 106 deletions swagger.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -132,10 +132,6 @@ paths:
"Structural",
"MEP"
],
"snippet_type": [
".ifc",
".csv"
],
"priority": [
"Low",
"Medium",
Expand All @@ -158,7 +154,6 @@ paths:
],
"topic_actions": [
"update",
"updateBimSnippet",
"updateRelatedTopics",
"updateDocumentReferences",
"updateFiles",
Expand Down Expand Up @@ -268,13 +263,7 @@ paths:
"Architecture",
"Heating"
],
"assigned_to": "[email protected]",
"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": "[email protected]"
}
responses:
'201':
Expand All @@ -297,13 +286,7 @@ paths:
"Architecture",
"Heating"
],
"assigned_to": "[email protected]",
"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": "[email protected]"
}
/bcf/{version}/projects/{project_id}/topics/{topic_id}:
parameters:
Expand Down Expand Up @@ -337,12 +320,6 @@ paths:
"Heating"
],
"assigned_to": "[email protected]",
"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",
Expand Down Expand Up @@ -373,13 +350,7 @@ paths:
"Architecture",
"Heating"
],
"assigned_to": "[email protected]",
"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": "[email protected]"
}
responses:
'200':
Expand All @@ -404,13 +375,7 @@ paths:
"Architecture",
"Heating"
],
"assigned_to": "[email protected]",
"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": "[email protected]"
}
delete:
summary: Delete Topic
Expand All @@ -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"
Expand Down Expand Up @@ -1818,7 +1747,6 @@ components:
- topic_type
- topic_status
- topic_label
- snippet_type
- priority
- users
- stage
Expand All @@ -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
Expand Down Expand Up @@ -1914,7 +1836,6 @@ components:
type: string
enum:
- update
- updateBimSnippet
- updateRelatedTopics
- updateDocumentReferences
- updateFiles
Expand Down Expand Up @@ -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:
Expand Down Expand Up @@ -2265,8 +2169,6 @@ components:
description:
type: string
nullable: true
bim_snippet:
$ref: '#/components/schemas/bim_snippet'
due_date:
type: string
nullable: true
Expand Down Expand Up @@ -2325,8 +2227,6 @@ components:
description:
type: string
nullable: true
bim_snippet:
$ref: '#/components/schemas/bim_snippet'
due_date:
type: string
nullable: true
Expand Down Expand Up @@ -2372,8 +2272,6 @@ components:
description:
type: string
nullable: true
bim_snippet:
$ref: '#/components/schemas/bim_snippet'
due_date:
type: string
nullable: true
Expand Down