Skip to content

Commit

Permalink
Total rework, see README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
@linhard
linhard committed Oct 28, 2014
1 parent 8e416cd commit f2a5306
Show file tree
Hide file tree
Showing 29 changed files with 175 additions and 944 deletions.
Binary file added Images/Topology1.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added Images/Topology2.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added Images/Topology3.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
428 changes: 114 additions & 314 deletions README.md
View file

Large diffs are not rendered by default.

17 changes: 0 additions & 17 deletions Schemas/attachment.json
View file

This file was deleted.

3 changes: 1 addition & 2 deletions Schemas/comment.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,6 @@
},
"required": ["guid","status","date","author","comment","topic_guid"],
"links": [
{"rel": "viewpoints","href": "{guid}/viewpoints"},
{"rel": "attachments","href": "{guid}/attachments"}
{"rel": "viewpoints","href": "{guid}/viewpoints"}
]
}
12 changes: 1 addition & 11 deletions Schemas/component.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,25 +3,15 @@
"title": "Component",
"description": "Schema for Component, BCF REST API. A viewpoint can have multiple components.",
"type": "object",
"definitions": {
"guid": {
"type": "string",
"pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}"}
},
"properties": {
"ifc_guid": {"type": "string"},
"guid": {"$ref": "#/definitions/guid"},
"selected": {"type": "boolean"},
"color": {
"type": "string",
"pattern": "^(([0-9]|[a-f]|[A-F]){2})?(([0-9]|[a-f]|[A-F]){2})?(([0-9]|[a-f]|[A-F]){2})?$"
},
"originating_system": {"type": "string"},
"authoring_tool_id": {"type": "string"}
},
"required": ["guid"],
"links": [
{"rel": "attachments","href": "{guid}/attachments"}
]
}
}

34 changes: 0 additions & 34 deletions Schemas/domain.json
View file

This file was deleted.

19 changes: 19 additions & 0 deletions Schemas/error.json
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
{

"$schema": "http://json-schema.org/draft-04/schema#",

"title": "Error",

"description": "Schema for error, BCF REST API.",

"type": "object",

"properties": {

"message": {"type": "string"}

},

"required": ["message"]

}
13 changes: 13 additions & 0 deletions Schemas/file.json
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "File",
"description": "File in BCF REST API. A topic can be related to multiple files.",
"type": "object",
"properties": {
"ifc_project": {"type": "string"},
"ifc_spatial_structure_element": {"type": "string"},
"file_name": {"type": "string"},
"date": {"type": "string", "format": "date-time"},
"reference": {"type": "string"}
}
}
22 changes: 9 additions & 13 deletions Schemas/link.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,18 +3,14 @@
"title": "Link",
"description": "Link schema. Links to available schemas in BCF REST API.",
"links": [
{"rel": "teams","href": "https://raw.github.com/BuildingSMART/BCF-API/master/Schemas/team.json"},
{"rel": "teams/projects","href": "https://raw.github.com/BuildingSMART/BCF-API/master/Schemas/project.json"},
{"rel": "teams/projects/domains","href": "https://raw.github.com/BuildingSMART/BCF-API/master/Schemas/domains.json"},
{"rel": "teams/projects/domains/revisions","href": "https://raw.github.com/BuildingSMART/BCF-API/master/Schemas/revision.json"},
{"rel": "teams/projects/topics", "href": "https://raw.github.com/BuildingSMART/BCF-API/master/Schemas/topic.json"},
{"rel": "teams/projects/topics/revisions", "href": "https://raw.github.com/BuildingSMART/BCF-API/master/Schemas/revision.json"},
{"rel": "teams/projects/topics/document_references","href": "https://raw.github.com/BuildingSMART/BCF-API/master/Schemas/document_reference.json"},
{"rel": "teams/projects/topics/related_topics","href": "https://raw.github.com/BuildingSMART/BCF-API/master/Schemas/related_topic.json"},
{"rel": "teams/projects/topics/comments","href": "https://raw.github.com/BuildingSMART/BCF-API/master/Schemas/comment.json"},
{"rel": "teams/projects/topics/viewpoints","href": "https://raw.github.com/BuildingSMART/BCF-API/master/Schemas/viewpoint.json"},
{"rel": "teams/projects/topics/viewpoints/components","href": "https://raw.github.com/BuildingSMART/BCF-API/master/Schemas/component.json"},
{"rel": "colours","href": "https://raw.github.com/BuildingSMART/BCF-API/master/Schemas/colours.json"},
{"rel": "attachments","href": "https://raw.github.com/BuildingSMART/BCF-API/master/Schemas/attachment.json"}
{"rel": "projects","href": "https://raw.github.com/BuildingSMART/BCF-API/master/Schemas/project.json"},
{"rel": "projects/topics", "href": "https://raw.github.com/BuildingSMART/BCF-API/master/Schemas/topic.json"},
{"rel": "projects/topics/files","href": "https://raw.github.com/BuildingSMART/BCF-API/master/Schemas/file.json"},
{"rel": "projects/topics/document_references","href": "https://raw.github.com/BuildingSMART/BCF-API/master/Schemas/document_reference.json"},
{"rel": "projects/topics/related_topics","href": "https://raw.github.com/BuildingSMART/BCF-API/master/Schemas/related_topic.json"},
{"rel": "projects/topics/comments","href": "https://raw.github.com/BuildingSMART/BCF-API/master/Schemas/comment.json"},
{"rel": "projects/topics/viewpoints","href": "https://raw.github.com/BuildingSMART/BCF-API/master/Schemas/viewpoint.json"},
{"rel": "projects/topics/viewpoints/components","href": "https://raw.github.com/BuildingSMART/BCF-API/master/Schemas/component.json"},
{"rel": "colours","href": "https://raw.github.com/BuildingSMART/BCF-API/master/Schemas/colours.json"}
]
}
70 changes: 15 additions & 55 deletions Schemas/project.json
View file
Original file line number Diff line number Diff line change
@@ -1,55 +1,15 @@
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Project",
"description": "Schema for project, BCF REST API. A team can have multiple projects.",
"type": "object",
"definitions": {
"guid": {
"type": "string",
"pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}"}
},
"properties": {
"guid": {"$ref": "#/definitions/guid"},
"name": {"type": "string"},
"short_descr": {"type": "string"},
"creator": {"$ref": "#/definitions/guid"},
"created": { "type": "string", "format": "date-time" },
"changed": { "type": "string", "format": "date-time" },
"team_guid": {"$ref": "#/definitions/guid"},
"rights": {
"type": "object",
"properties": {
"project_admin": { "type": "boolean" },
"project_delete": { "type": "boolean" },
"project_edit": { "type": "boolean" },
"domain_create": { "type": "boolean" }
}
} ,
"domains": {
"type": "array",
"items": [
{"type": "object",
"properties": {
"guid": {"$ref": "#/definitions/guid"},
"name": {"type": "string"},
"rights": {
"type": "object",
"properties": {
"revision_add": { "type": "boolean" },
"revision_delete": { "type": "boolean" },
"revision_edit": { "type": "boolean" },
"revision_view": { "type": "boolean" }
}
}
}
}
]
}
},
"required": ["guid","name","team_guid"],
"links": [
{"rel": "domains","href": "{guid}/domains"},
{"rel": "attachments","href": "{guid}/attachments"},
{"rel": "thumbnail", "href": "{guid}/bitmap","mediaType": "image/*"}
]
}
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Project",
"description": "Schema for project, BCF REST API.",
"type": "object",
"properties": {
"project_id": {"type": "string"},
"name": {"type": "string"},
"extension_schema": {"type": "string"},
"links": [
{"rel": "topics", "href": "{guid}/topics"},
{"rel": "extension", "href": "{guid}/extension"}
]
}
}
25 changes: 0 additions & 25 deletions Schemas/revision.json
View file

This file was deleted.

48 changes: 0 additions & 48 deletions Schemas/team.json
View file

This file was deleted.

11 changes: 3 additions & 8 deletions Schemas/topic.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -42,8 +42,8 @@
"links":[

{
"rel": "revisions",
"href": "{guid}/revisions"
"rel": "files",
"href": "{guid}/files"
},
{
"rel": "document_references",
Expand All @@ -60,12 +60,7 @@
{
"rel": "viewpoints",
"href": "{guid}/viewpoints"
},

{
"rel": "attachments",
"href": "{guid}/attachments"
}
}
]
}

2 changes: 0 additions & 2 deletions Schemas/viewpoint.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -144,9 +144,7 @@
},
"required": ["guid"],
"links": [
{"rel": "comments","href": "{guid}/comments"},
{"rel": "components","href": "{guid}/components"},
{"rel": "attachments","href": "{guid}/attachments"},
{"rel": "bitmap","href": "{guid}/bitmap"}
]
}
Expand Down
17 changes: 0 additions & 17 deletions Schemas_XSD/attachment.xsd
View file

This file was deleted.

11 changes: 0 additions & 11 deletions Schemas_XSD/colors.xsd
View file

This file was deleted.

Loading

0 comments on commit f2a5306

Please sign in to comment.