Skip to content

Commit 450d146

Browse files
authored
Merge pull request #13 from BHoM/automatic-api-updates
API Updates
2 parents 1842eb1 + 7a7d7c5 commit 450d146

7 files changed

Lines changed: 80 additions & 0 deletions

File tree

docs/oM/Adapter/Adapters/Robot/Enums/CombinationType.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,3 +30,16 @@ The C# enum definition is available on github:
3030
- [CombinationType.cs](https://github.com/BHoM/Robot_Toolkit/blob/develop/Robot_oM/Enums\CombinationType.cs)
3131

3232
All history and changes of the class can be found by inspection the history.
33+
### JSON Schema implementation
34+
35+
The object is defined as a JSON schema. You can validate a JSON instance against this schema by reference. To do this, use the schema reference below in a validator like [this one](https://www.jsonschemavalidator.net/).
36+
37+
``` json title="JSON Schema"
38+
{
39+
"$ref" : "https://raw.githubusercontent.com/BHoM/BHoM_JSONSchema/develop/Robot_oM/CombinationType.json"
40+
}
41+
```
42+
43+
The JSON Schema is available on github here:
44+
45+
- [CombinationType.json](https://github.com/BHoM/BHoM_JSONSchema/blob/develop/Robot_oM/CombinationType.json)

docs/oM/Adapter/Adapters/Robot/Fragments/ContourLoadPanelNumbers.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,3 +44,16 @@ The C# class definition is available on github:
4444
- [ContourLoadPanelNumbers.cs](https://github.com/BHoM/Robot_Toolkit/blob/develop/Robot_oM/Fragments\ContourLoadPanelNumbers.cs)
4545

4646
All history and changes of the class can be found by inspection the history.
47+
### JSON Schema implementation
48+
49+
The object is defined as a JSON schema. You can validate a JSON instance against this schema by reference. To do this, use the schema reference below in a validator like [this one](https://www.jsonschemavalidator.net/).
50+
51+
``` json title="JSON Schema"
52+
{
53+
"$ref" : "https://raw.githubusercontent.com/BHoM/BHoM_JSONSchema/develop/Robot_oM/ContourLoadPanelNumbers.json"
54+
}
55+
```
56+
57+
The JSON Schema is available on github here:
58+
59+
- [ContourLoadPanelNumbers.json](https://github.com/BHoM/BHoM_JSONSchema/blob/develop/Robot_oM/ContourLoadPanelNumbers.json)

docs/oM/Adapter/Adapters/Robot/Fragments/LoadCombinationType.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,3 +44,16 @@ The C# class definition is available on github:
4444
- [LoadCombinationType.cs](https://github.com/BHoM/Robot_Toolkit/blob/develop/Robot_oM/Fragments\LoadCombinationType.cs)
4545

4646
All history and changes of the class can be found by inspection the history.
47+
### JSON Schema implementation
48+
49+
The object is defined as a JSON schema. You can validate a JSON instance against this schema by reference. To do this, use the schema reference below in a validator like [this one](https://www.jsonschemavalidator.net/).
50+
51+
``` json title="JSON Schema"
52+
{
53+
"$ref" : "https://raw.githubusercontent.com/BHoM/BHoM_JSONSchema/develop/Robot_oM/LoadCombinationType.json"
54+
}
55+
```
56+
57+
The JSON Schema is available on github here:
58+
59+
- [LoadCombinationType.json](https://github.com/BHoM/BHoM_JSONSchema/blob/develop/Robot_oM/LoadCombinationType.json)

docs/oM/Adapter/LadybugTools/ExecuteCommands/EPWToCSVCommand.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,3 +46,16 @@ The C# class definition is available on github:
4646
- [EPWToCSVCommand.cs](https://github.com/BHoM/LadybugTools_Toolkit/blob/develop/LadybugTools_oM/ExecuteCommands\EPWToCSVCommand.cs)
4747

4848
All history and changes of the class can be found by inspection the history.
49+
### JSON Schema implementation
50+
51+
The object is defined as a JSON schema. You can validate a JSON instance against this schema by reference. To do this, use the schema reference below in a validator like [this one](https://www.jsonschemavalidator.net/).
52+
53+
``` json title="JSON Schema"
54+
{
55+
"$ref" : "https://raw.githubusercontent.com/BHoM/BHoM_JSONSchema/develop/LadybugTools_oM/EPWToCSVCommand.json"
56+
}
57+
```
58+
59+
The JSON Schema is available on github here:
60+
61+
- [EPWToCSVCommand.json](https://github.com/BHoM/BHoM_JSONSchema/blob/develop/LadybugTools_oM/EPWToCSVCommand.json)

docs/oM/Adapter/LadybugTools/ExecuteCommands/GEMToHBJSONCommand.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,3 +45,16 @@ The C# class definition is available on github:
4545
- [GEMToHBJSONCommand.cs](https://github.com/BHoM/LadybugTools_Toolkit/blob/develop/LadybugTools_oM/ExecuteCommands\GEMToHBJSONCommand.cs)
4646

4747
All history and changes of the class can be found by inspection the history.
48+
### JSON Schema implementation
49+
50+
The object is defined as a JSON schema. You can validate a JSON instance against this schema by reference. To do this, use the schema reference below in a validator like [this one](https://www.jsonschemavalidator.net/).
51+
52+
``` json title="JSON Schema"
53+
{
54+
"$ref" : "https://raw.githubusercontent.com/BHoM/BHoM_JSONSchema/develop/LadybugTools_oM/GEMToHBJSONCommand.json"
55+
}
56+
```
57+
58+
The JSON Schema is available on github here:
59+
60+
- [GEMToHBJSONCommand.json](https://github.com/BHoM/BHoM_JSONSchema/blob/develop/LadybugTools_oM/GEMToHBJSONCommand.json)

docs/oM/Adapter/LadybugTools/ExecuteCommands/HBJSONToGEMCommand.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,3 +45,16 @@ The C# class definition is available on github:
4545
- [HBJSONToGEMCommand.cs](https://github.com/BHoM/LadybugTools_Toolkit/blob/develop/LadybugTools_oM/ExecuteCommands\HBJSONToGEMCommand.cs)
4646

4747
All history and changes of the class can be found by inspection the history.
48+
### JSON Schema implementation
49+
50+
The object is defined as a JSON schema. You can validate a JSON instance against this schema by reference. To do this, use the schema reference below in a validator like [this one](https://www.jsonschemavalidator.net/).
51+
52+
``` json title="JSON Schema"
53+
{
54+
"$ref" : "https://raw.githubusercontent.com/BHoM/BHoM_JSONSchema/develop/LadybugTools_oM/HBJSONToGEMCommand.json"
55+
}
56+
```
57+
58+
The JSON Schema is available on github here:
59+
60+
- [HBJSONToGEMCommand.json](https://github.com/BHoM/BHoM_JSONSchema/blob/develop/LadybugTools_oM/HBJSONToGEMCommand.json)

docs/oM/Dimensional/Geometry/Misc/BoundingBox.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,8 @@ The following properties are defined as extension methods in one of the BHoM_Eng
3939
|------------------|------------------|------------------|------------------|------------------|
4040
| Bounds | [BoundingBox](/api/oM/Dimensional/Geometry/Misc/BoundingBox) | Returns the BoundingBox of the BoundingBox (itself). | - | Geometry_Engine |
4141
| Centre | [Point](/api/oM/Dimensional/Geometry/Vector/Point) | Gets the centre Point of a BoundingBox. | - | Geometry_Engine |
42+
| Corners | [List](https://learn.microsoft.com/en-us/dotnet/api/System.Collections.Generic.List-1?view=netstandard-2.0)<[Point](/api/oM/Dimensional/Geometry/Vector/Point)> | Returns a list of 8 corner points of a bounding box. | - | Geometry_Engine |
43+
| DiagonalLength | [double](https://learn.microsoft.com/en-us/dotnet/api/System.Double?view=netstandard-2.0) | Returns a diagonal length (distance between Min and Max) of a BoundingBox. | - | Geometry_Engine |
4244
| Edges | [List](https://learn.microsoft.com/en-us/dotnet/api/System.Collections.Generic.List-1?view=netstandard-2.0)<[Line](/api/oM/Dimensional/Geometry/Curve/Line)> | Gets all the edges of a BoundingBox as a collection of Lines. | - | Geometry_Engine |
4345
| Extents | [Vector](/api/oM/Dimensional/Geometry/Vector/Vector) | Gets the extents of a BoundingBox as a Vector representing its dimensions. | - | Geometry_Engine |
4446
| GeometryHash | [string](https://learn.microsoft.com/en-us/dotnet/api/System.String?view=netstandard-2.0) | Returns a signature of the input geometry, useful for diffing.<br>The hash is computed as a serialised array representing the coordinate of significant points taken on the geometry.<br>The number of points is reduced to the minimum essential to determine uniquely any geometry.<br>Additionally, the resulting points are transformed based on the source geometry type, to remove or minimise collisions.<br>(Any transformation so performed is translational only, in order to support geometrical tolerance, i.e. numerical distance, when comparing GeometryHashes downstream). | - | Geometry_Engine |

0 commit comments

Comments
 (0)