-
Notifications
You must be signed in to change notification settings - Fork 9
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
0 parents
commit 5d904aa
Showing
28 changed files
with
67,823 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,23 @@ | ||
| <!DOCTYPE html> | ||
| <html> | ||
| <head> | ||
| <title>Honeybee Energy Simulation Parameter Schema</title> | ||
| <!-- needed for adaptive design --> | ||
| <meta charset="utf-8"/> | ||
| <meta name="viewport" content="width=device-width, initial-scale=1"> | ||
|
|
||
| <link href="https://fonts.googleapis.com/css?family=Montserrat:300,400,700|Roboto:300,400,700" rel="stylesheet"> | ||
|
|
||
| <link rel="shortcut icon" href="https://github.com/ladybug-tools/artwork/raw/master/icons_bugs/ico/honeybee.ico"> | ||
| <style> | ||
| body { | ||
| margin: 0; | ||
| padding: 0; | ||
| } | ||
| </style> | ||
| </head> | ||
| <body> | ||
| <redoc spec-url="./comparison-report.json"></redoc> | ||
| <script src="https://cdn.jsdelivr.net/npm/redoc@next/bundles/redoc.standalone.js"> </script> | ||
| </body> | ||
| </html> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,286 @@ | ||
| { | ||
| "openapi": "3.0.2", | ||
| "servers": [], | ||
| "info": { | ||
| "description": "Honeybee comparison-report schema.", | ||
| "version": "1.58.0", | ||
| "title": "Honeybee Comparison Report Schema", | ||
| "contact": { | ||
| "name": "Ladybug Tools", | ||
| "email": "[email protected]", | ||
| "url": "https://github.com/ladybug-tools/honeybee-schema" | ||
| }, | ||
| "x-logo": { | ||
| "url": "https://www.ladybug.tools/assets/img/honeybee-large.png", | ||
| "altText": "Honeybee logo" | ||
| }, | ||
| "license": { | ||
| "name": "BSD", | ||
| "url": "https://github.com/ladybug-tools-in2/honeybee-schema/blob/master/LICENSE" | ||
| } | ||
| }, | ||
| "externalDocs": { | ||
| "description": "OpenAPI Specification with Inheritance", | ||
| "url": "./comparison-report_inheritance.json" | ||
| }, | ||
| "tags": [ | ||
| { | ||
| "name": "addedobject_model", | ||
| "x-displayName": "AddedObject", | ||
| "description": "<SchemaDefinition schemaRef=\"#/components/schemas/AddedObject\" />\n" | ||
| }, | ||
| { | ||
| "name": "changedobject_model", | ||
| "x-displayName": "ChangedObject", | ||
| "description": "<SchemaDefinition schemaRef=\"#/components/schemas/ChangedObject\" />\n" | ||
| }, | ||
| { | ||
| "name": "comparisonreport_model", | ||
| "x-displayName": "ComparisonReport", | ||
| "description": "<SchemaDefinition schemaRef=\"#/components/schemas/ComparisonReport\" />\n" | ||
| }, | ||
| { | ||
| "name": "deletedobject_model", | ||
| "x-displayName": "DeletedObject", | ||
| "description": "<SchemaDefinition schemaRef=\"#/components/schemas/DeletedObject\" />\n" | ||
| }, | ||
| { | ||
| "name": "geometryobjecttypes_model", | ||
| "x-displayName": "GeometryObjectTypes", | ||
| "description": "<SchemaDefinition schemaRef=\"#/components/schemas/GeometryObjectTypes\" />\n" | ||
| } | ||
| ], | ||
| "x-tagGroups": [ | ||
| { | ||
| "name": "Models", | ||
| "tags": [ | ||
| "addedobject_model", | ||
| "changedobject_model", | ||
| "comparisonreport_model", | ||
| "deletedobject_model", | ||
| "geometryobjecttypes_model" | ||
| ] | ||
| } | ||
| ], | ||
| "paths": {}, | ||
| "components": { | ||
| "schemas": { | ||
| "GeometryObjectTypes": { | ||
| "title": "GeometryObjectTypes", | ||
| "description": "Types of Honeybee geometry objects.", | ||
| "enum": [ | ||
| "Shade", | ||
| "Aperture", | ||
| "Door", | ||
| "Face", | ||
| "Room" | ||
| ], | ||
| "type": "string" | ||
| }, | ||
| "ChangedObject": { | ||
| "title": "ChangedObject", | ||
| "type": "object", | ||
| "properties": { | ||
| "element_type": { | ||
| "description": "Text for the type of object that has been changed.", | ||
| "allOf": [ | ||
| { | ||
| "$ref": "#/components/schemas/GeometryObjectTypes" | ||
| } | ||
| ] | ||
| }, | ||
| "element_id": { | ||
| "title": "Element Id", | ||
| "description": "Text string for the unique object ID that has changed.", | ||
| "maxLength": 100, | ||
| "minLength": 1, | ||
| "pattern": "^[^,;!\\n\\t]+$", | ||
| "type": "string" | ||
| }, | ||
| "geometry_changed": { | ||
| "title": "Geometry Changed", | ||
| "description": "A boolean to note whether the geometry of the object has changed (True) or not (False). For the case of a Room, any change in the geometry of child Faces, Apertures or Doors will cause this property to be True. Note that this property is only True if the change in geometry produces a visible change greater than the base model tolerance. So converting the model between different unit systems, removing colinear vertices, or doing other transformations that are common for export to simulation engines will not trigger this property to become True.", | ||
| "type": "boolean" | ||
| }, | ||
| "geometry": { | ||
| "title": "Geometry", | ||
| "description": "A list of DisplayFace3D dictionaries for the new, changed geometry. The schema of DisplayFace3D can be found in the ladybug-display-schema documentation (https://www.ladybug.tools/ladybug-display-schema) and these objects can be used to generate visualizations of individual objects that have been changed. Note that this attribute is always included in the ChangedObject, even when geometry_changed is False.", | ||
| "type": "array", | ||
| "items": { | ||
| "type": "object" | ||
| } | ||
| }, | ||
| "element_name": { | ||
| "title": "Element Name", | ||
| "description": "Text string for the display name of the object that has changed.", | ||
| "type": "string" | ||
| }, | ||
| "type": { | ||
| "title": "Type", | ||
| "default": "ChangedObject", | ||
| "pattern": "^ChangedObject$", | ||
| "type": "string", | ||
| "readOnly": true | ||
| }, | ||
| "energy_changed": { | ||
| "title": "Energy Changed", | ||
| "description": "A boolean to note whether the energy properties of the object have changed (True) or not (False) such that it is possible for the properties of the changed object to be applied to the base model. For Rooms, this property will only be true if the energy property assigned to the Room has changed and will not be true if a property assigned to an individual child Face or Aperture has changed.", | ||
| "default": false, | ||
| "type": "boolean" | ||
| }, | ||
| "radiance_changed": { | ||
| "title": "Radiance Changed", | ||
| "description": "A boolean to note whether the radiance properties of the object have changed (True) or not (False) such that it is possible for the properties of the changed object to be applied to the base model. For Rooms, this property will only be true if the radiance property assigned to the Room has changed and will not be true if a property assigned to an individual child Face or Aperture has changed.", | ||
| "default": false, | ||
| "type": "boolean" | ||
| }, | ||
| "existing_geometry": { | ||
| "title": "Existing Geometry", | ||
| "description": "A list of DisplayFace3D dictionaries for the existing (base) geometry. The schema of DisplayFace3D can be found in the ladybug-display-schema documentation (https://www.ladybug.tools/ladybug-display-schema) and these objects can be used to generate visualizations of individual objects that have been changed. This attribute is optional and will NOT be output if geometry_changed is False.", | ||
| "type": "array", | ||
| "items": { | ||
| "type": "object" | ||
| } | ||
| } | ||
| }, | ||
| "required": [ | ||
| "element_type", | ||
| "element_id", | ||
| "geometry_changed", | ||
| "geometry" | ||
| ] | ||
| }, | ||
| "DeletedObject": { | ||
| "title": "DeletedObject", | ||
| "type": "object", | ||
| "properties": { | ||
| "element_type": { | ||
| "description": "Text for the type of object that has been changed.", | ||
| "allOf": [ | ||
| { | ||
| "$ref": "#/components/schemas/GeometryObjectTypes" | ||
| } | ||
| ] | ||
| }, | ||
| "element_id": { | ||
| "title": "Element Id", | ||
| "description": "Text string for the unique object ID that has changed.", | ||
| "maxLength": 100, | ||
| "minLength": 1, | ||
| "pattern": "^[^,;!\\n\\t]+$", | ||
| "type": "string" | ||
| }, | ||
| "geometry": { | ||
| "title": "Geometry", | ||
| "description": "A list of DisplayFace3D dictionaries for the deleted geometry. The schema of DisplayFace3D can be found in the ladybug-display-schema documentation (https://www.ladybug.tools/ladybug-display-schema) and these objects can be used to generate visualizations of individual objects that have been deleted.", | ||
| "type": "array", | ||
| "items": { | ||
| "type": "object" | ||
| } | ||
| }, | ||
| "element_name": { | ||
| "title": "Element Name", | ||
| "description": "Text string for the display name of the object that has changed.", | ||
| "type": "string" | ||
| }, | ||
| "type": { | ||
| "title": "Type", | ||
| "default": "DeletedObject", | ||
| "pattern": "^DeletedObject$", | ||
| "type": "string", | ||
| "readOnly": true | ||
| } | ||
| }, | ||
| "required": [ | ||
| "element_type", | ||
| "element_id", | ||
| "geometry" | ||
| ] | ||
| }, | ||
| "AddedObject": { | ||
| "title": "AddedObject", | ||
| "type": "object", | ||
| "properties": { | ||
| "element_type": { | ||
| "description": "Text for the type of object that has been changed.", | ||
| "allOf": [ | ||
| { | ||
| "$ref": "#/components/schemas/GeometryObjectTypes" | ||
| } | ||
| ] | ||
| }, | ||
| "element_id": { | ||
| "title": "Element Id", | ||
| "description": "Text string for the unique object ID that has changed.", | ||
| "maxLength": 100, | ||
| "minLength": 1, | ||
| "pattern": "^[^,;!\\n\\t]+$", | ||
| "type": "string" | ||
| }, | ||
| "geometry": { | ||
| "title": "Geometry", | ||
| "description": "A list of DisplayFace3D dictionaries for the added geometry. The schema of DisplayFace3D can be found in the ladybug-display-schema documentation (https://www.ladybug.tools/ladybug-display-schema) and these objects can be used to generate visualizations of individual objects that have been added.", | ||
| "type": "array", | ||
| "items": { | ||
| "type": "object" | ||
| } | ||
| }, | ||
| "element_name": { | ||
| "title": "Element Name", | ||
| "description": "Text string for the display name of the object that has changed.", | ||
| "type": "string" | ||
| }, | ||
| "type": { | ||
| "title": "Type", | ||
| "default": "AddedObject", | ||
| "pattern": "^AddedObject$", | ||
| "type": "string", | ||
| "readOnly": true | ||
| } | ||
| }, | ||
| "required": [ | ||
| "element_type", | ||
| "element_id", | ||
| "geometry" | ||
| ] | ||
| }, | ||
| "ComparisonReport": { | ||
| "title": "ComparisonReport", | ||
| "type": "object", | ||
| "properties": { | ||
| "type": { | ||
| "title": "Type", | ||
| "default": "ComparisonReport", | ||
| "pattern": "^ComparisonReport$", | ||
| "type": "string", | ||
| "readOnly": true | ||
| }, | ||
| "changed_objects": { | ||
| "title": "Changed Objects", | ||
| "description": "A list of ChangedObject definitions for each top-level object that has changed in the model. To be a changed object, the object identifier must be the same in both models but some other property (either geometry or extension attributes) has experienced a meaningful change.", | ||
| "type": "array", | ||
| "items": { | ||
| "$ref": "#/components/schemas/ChangedObject" | ||
| } | ||
| }, | ||
| "deleted_objects": { | ||
| "title": "Deleted Objects", | ||
| "description": "A list of DeletedObject definitions for each top-level object that has been deleted in the process of going from the base model to the new model.", | ||
| "type": "array", | ||
| "items": { | ||
| "$ref": "#/components/schemas/DeletedObject" | ||
| } | ||
| }, | ||
| "added_objects": { | ||
| "title": "Added Objects", | ||
| "description": "A list of AddedObject definitions for each top-level object that has been added in the process of going from the base model to the new model.", | ||
| "type": "array", | ||
| "items": { | ||
| "$ref": "#/components/schemas/AddedObject" | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } |
Oops, something went wrong.