Skip to content

Commit e2efdbd

Browse files
authored
Merge pull request #16 from BHoM/automatic-api-updates
API Updates
2 parents 6b1e32c + 8be756d commit e2efdbd

3 files changed

Lines changed: 27 additions & 1 deletion

File tree

docs/oM/Framework/Base/Interface/IObject.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -970,10 +970,10 @@ title: IObject
970970
- BH.oM.MEP.Equipment.Parts.[Fan](/api/oM/Analytical/MEP/Equipment/Parts/Fan)
971971
- BH.oM.MEP.Equipment.Parts.[Filter](/api/oM/Analytical/MEP/Equipment/Parts/Filter)
972972
- BH.oM.MEP.Equipment.Parts.[HeatingCoil](/api/oM/Analytical/MEP/Equipment/Parts/HeatingCoil)
973+
- BH.oM.Adapters.MidasCivil.[MidasCivilId](/api/oM/Adapter/Adapters/MidasCivil/Fragments/MidasCivilId)
973974
- BH.oM.Adapters.MidasCivil.[Metadata](/api/oM/Adapter/Adapters/MidasCivil/Settings/Metadata)
974975
- BH.oM.Adapters.MidasCivil.[MidasCivilSettings](/api/oM/Adapter/Adapters/MidasCivil/Settings/MidasCivilSettings)
975976
- BH.oM.Adapters.MidasCivil.[Review](/api/oM/Adapter/Adapters/MidasCivil/Settings/Review)
976-
- BH.oM.Adapters.MidasCivil.[MidasCivilId](/api/oM/Adapter/Adapters/MidasCivil/Fragments/MidasCivilId)
977977
- BH.oM.Adapters.Mongo.Requests.[CollectionNames](/api/oM/Adapter/Adapters/Mongo/Requests/CollectionNames)
978978
- BH.oM.Adapters.Mongo.Commands.[Transfer](/api/oM/Adapter/Adapters/Mongo/Commands/Transfer)
979979
- BH.oM.Adapters.OpenStreetMap.[BoundingBox](/api/oM/Adapter/Adapters/OpenStreetMap/Elements/BoundingBox)

docs/oM/UI/UI/CodeElementRecord.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,3 +47,16 @@ The C# class definition is available on github:
4747
- [CodeElementRecord.cs](https://github.com/BHoM/BHoM_UI/blob/develop/UI_oM/CodeElementRecord.cs)
4848

4949
All history and changes of the class can be found by inspection the history.
50+
### JSON Schema implementation
51+
52+
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/).
53+
54+
``` json title="JSON Schema"
55+
{
56+
"$ref" : "https://raw.githubusercontent.com/BHoM/BHoM_JSONSchema/develop/UI_oM/CodeElementRecord.json"
57+
}
58+
```
59+
60+
The JSON Schema is available on github here:
61+
62+
- [CodeElementRecord.json](https://github.com/BHoM/BHoM_JSONSchema/blob/develop/UI_oM/CodeElementRecord.json)

docs/oM/UI/UI/CodeElementType.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,3 +41,16 @@ The C# enum definition is available on github:
4141
- [CodeElementType.cs](https://github.com/BHoM/BHoM_UI/blob/develop/UI_oM/CodeElementType.cs)
4242

4343
All history and changes of the class can be found by inspection the history.
44+
### JSON Schema implementation
45+
46+
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/).
47+
48+
``` json title="JSON Schema"
49+
{
50+
"$ref" : "https://raw.githubusercontent.com/BHoM/BHoM_JSONSchema/develop/UI_oM/CodeElementType.json"
51+
}
52+
```
53+
54+
The JSON Schema is available on github here:
55+
56+
- [CodeElementType.json](https://github.com/BHoM/BHoM_JSONSchema/blob/develop/UI_oM/CodeElementType.json)

0 commit comments

Comments
 (0)