Skip to content

Commit 439d522

Browse files
shelcrowcwhanseNradzykewycz
authored
PVSystemArray, PVSystemString update (#24)
* PVSystemArray, PVSystemString update * Update Master-OB-OpenAPI.json Co-authored-by: Cliff Hansen <cwhanse@sandia.gov> * Update Master-OB-OpenAPI.json Co-authored-by: Cliff Hansen <cwhanse@sandia.gov> * Update Master-OB-OpenAPI.json Co-authored-by: Cliff Hansen <cwhanse@sandia.gov> * Update Master-OB-OpenAPI.json Co-authored-by: Cliff Hansen <cwhanse@sandia.gov> * Update Master-OB-OpenAPI.json Co-authored-by: Cliff Hansen <cwhanse@sandia.gov> * Update Master-OB-OpenAPI.json Co-authored-by: Cliff Hansen <cwhanse@sandia.gov> * Update Master-OB-OpenAPI.json Co-authored-by: Cliff Hansen <cwhanse@sandia.gov> * Update Master-OB-OpenAPI.json Co-authored-by: Cliff Hansen <cwhanse@sandia.gov> * Update Master-OB-OpenAPI.json Co-authored-by: Cliff Hansen <cwhanse@sandia.gov> * Update Master-OB-OpenAPI.json Co-authored-by: Cliff Hansen <cwhanse@sandia.gov> * Update Master-OB-OpenAPI.json Co-authored-by: Cliff Hansen <cwhanse@sandia.gov> * Update Master-OB-OpenAPI.json Co-authored-by: Nradzykewycz <80283142+Nradzykewycz@users.noreply.github.com> * Update Master-OB-OpenAPI.json Co-authored-by: Nradzykewycz <80283142+Nradzykewycz@users.noreply.github.com> * Update Master-OB-OpenAPI.json Co-authored-by: Nradzykewycz <80283142+Nradzykewycz@users.noreply.github.com> * Update version number * Fixed typo Co-authored-by: Cliff Hansen <cwhanse@sandia.gov> Co-authored-by: Nradzykewycz <80283142+Nradzykewycz@users.noreply.github.com>
1 parent 87de5bd commit 439d522

1 file changed

Lines changed: 259 additions & 2 deletions

File tree

‎Master-OB-OpenAPI.json‎

Lines changed: 259 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"openapi": "3.0.0",
33
"info": {
4-
"version": "1.1.2",
4+
"version": "1.1.3",
55
"title": "OB OpenAPI Taxonomy",
66
"description": "OB OpenAPI Definitions For Orange Button."
77
},
@@ -96,6 +96,9 @@
9696
},
9797
"Description": {
9898
"$ref": "#/components/schemas/Description"
99+
},
100+
"FileFolderURL": {
101+
"$ref": "#/components/schemas/FileFolderURL"
99102
}
100103
},
101104
"x-ob-usage-tips": ""
@@ -126,6 +129,9 @@
126129
},
127130
"Location": {
128131
"$ref": "#/components/schemas/Location"
132+
},
133+
"Orientation": {
134+
"$ref": "#/components/schemas/Orientation"
129135
}
130136
},
131137
"x-ob-usage-tips": ""
@@ -3581,6 +3587,9 @@
35813587
"type": "object",
35823588
"description": "A certification for a product",
35833589
"properties": {
3590+
"ProdCertificationName": {
3591+
"$ref": "#/components/schemas/ProdCertificationName"
3592+
},
35843593
"ProdCertificationValue": {
35853594
"$ref": "#/components/schemas/ProdCertificationValue"
35863595
},
@@ -6989,6 +6998,254 @@
69896998
}
69906999
},
69917000
"x-ob-usage-tips": ""
7001+
},
7002+
"Azimuth": {
7003+
"allOf": [
7004+
{
7005+
"$ref": "#/components/schemas/TaxonomyElementString"
7006+
},
7007+
{
7008+
"type": "object",
7009+
"description": "Azimuth relative to North where North is 0 degrees and East is 90 degrees",
7010+
"x-ob-item-type": "num-us:planeAngleItemType",
7011+
"x-ob-usage-tips": "",
7012+
"x-ob-sample-value": {
7013+
"Decimals": "",
7014+
"EndTime": "",
7015+
"Precision": "",
7016+
"StartTime": "",
7017+
"Unit": "Degree",
7018+
"Value": "180"
7019+
},
7020+
"x-ob-item-type-group": ""
7021+
}
7022+
]
7023+
},
7024+
"PVSystemStringID": {
7025+
"allOf": [
7026+
{
7027+
"$ref": "#/components/schemas/TaxonomyElementString"
7028+
},
7029+
{
7030+
"type": "object",
7031+
"description": "A UUID for identifying a specific string",
7032+
"x-ob-item-type": "solar-types:uuidItemType",
7033+
"x-ob-usage-tips": "",
7034+
"x-ob-sample-value": {
7035+
"Decimals": "",
7036+
"EndTime": "",
7037+
"Precision": "",
7038+
"StartTime": "",
7039+
"Unit": "",
7040+
"Value": "7a00622c6bb04a3fc6da73090958db3a1bf6c791"
7041+
},
7042+
"x-ob-item-type-group": ""
7043+
}
7044+
]
7045+
},
7046+
"Area": {
7047+
"allOf": [
7048+
{
7049+
"$ref": "#/components/schemas/TaxonomyElementNumber"
7050+
},
7051+
{
7052+
"type": "object",
7053+
"description": "Area",
7054+
"x-ob-item-type": "num:areaItemType",
7055+
"x-ob-usage-tips": "",
7056+
"x-ob-sample-value": {
7057+
"Decimals": "",
7058+
"EndTime": "",
7059+
"Precision": "",
7060+
"StartTime": "",
7061+
"Unit": "Square Foot",
7062+
"Value": "10"
7063+
},
7064+
"x-ob-item-type-group": ""
7065+
}
7066+
]
7067+
},
7068+
"Tilt": {
7069+
"allOf": [
7070+
{
7071+
"$ref": "#/components/schemas/TaxonomyElementString"
7072+
},
7073+
{
7074+
"type": "object",
7075+
"description": "Tilt is the angle relative to horizontal. Horizontal is defined as the x,y plane of a right-hand coordinate system where the the x-axis is East, y-axis is North, and the z-axis is vertical.",
7076+
"x-ob-item-type": "num-us:planeAngleItemType",
7077+
"x-ob-usage-tips": "",
7078+
"x-ob-sample-value": {
7079+
"Decimals": "",
7080+
"EndTime": "",
7081+
"Precision": "",
7082+
"StartTime": "",
7083+
"Unit": "Degree",
7084+
"Value": "30"
7085+
},
7086+
"x-ob-item-type-group": ""
7087+
}
7088+
]
7089+
},
7090+
"Roll": {
7091+
"allOf": [
7092+
{
7093+
"$ref": "#/components/schemas/TaxonomyElementString"
7094+
},
7095+
{
7096+
"type": "object",
7097+
"description": "Roll is a right-hand rotation about an oriented axis, with a positive value being a counter-clockwise rotation. In the context of a solar module, Roll is the rotation of the module about the vector normal to the module's plane that is oriented towards the sky.",
7098+
"x-ob-item-type": "num-us:planeAngleItemType",
7099+
"x-ob-usage-tips": "The Roll element of Orientation is used when solar modules are installed on a slant.",
7100+
"x-ob-sample-value": {
7101+
"Decimals": "",
7102+
"EndTime": "",
7103+
"Precision": "",
7104+
"StartTime": "",
7105+
"Unit": "Degree",
7106+
"Value": "20"
7107+
},
7108+
"x-ob-item-type-group": ""
7109+
}
7110+
]
7111+
},
7112+
"RoofPlaneID": {
7113+
"allOf": [
7114+
{
7115+
"$ref": "#/components/schemas/TaxonomyElementString"
7116+
},
7117+
{
7118+
"type": "object",
7119+
"description": "The UUID of the roofplane",
7120+
"x-ob-item-type": "solar-types:uuidItemType",
7121+
"x-ob-usage-tips": "",
7122+
"x-ob-sample-value": {
7123+
"Decimals": "",
7124+
"EndTime": "",
7125+
"Precision": "",
7126+
"StartTime": "",
7127+
"Unit": "",
7128+
"Value": "7a00622c6bb04a3fc6da73090958db3a1bf6c791"
7129+
},
7130+
"x-ob-item-type-group": ""
7131+
}
7132+
]
7133+
},
7134+
"PVSystemArray": {
7135+
"type": "object",
7136+
"description": "An array of modules within a PVSystem that have a common orientation.",
7137+
"properties": {
7138+
"PVSystemStrings": {
7139+
"$ref": "#/components/schemas/PVSystemStrings"
7140+
},
7141+
"Orientation": {
7142+
"$ref": "#/components/schemas/Orientation"
7143+
},
7144+
"Area": {
7145+
"$ref": "#/components/schemas/Area"
7146+
},
7147+
"RoofPlaneID": {
7148+
"$ref": "#/components/schemas/RoofPlaneID"
7149+
},
7150+
"FileFolderURL": {
7151+
"$ref": "#/components/schemas/FileFolderURL"
7152+
},
7153+
"Description": {
7154+
"$ref": "#/components/schemas/Description"
7155+
},
7156+
"CapacityDC": {
7157+
"$ref": "#/components/schemas/CapacityDC"
7158+
},
7159+
"ProductLineItems": {
7160+
"$ref": "#/components/schemas/ProductLineItems"
7161+
},
7162+
"Devices": {
7163+
"$ref": "#/components/schemas/Devices"
7164+
}
7165+
}
7166+
},
7167+
"PVSystemStrings": {
7168+
"type": "array",
7169+
"items": {
7170+
"$ref": "#/components/schemas/PVSystemString"
7171+
}
7172+
},
7173+
"PVSystemString": {
7174+
"type": "object",
7175+
"description": "A string of Modules within a PVSystem",
7176+
"properties": {
7177+
"Devices": {
7178+
"$ref": "#/components/schemas/Devices"
7179+
},
7180+
"Orientation": {
7181+
"$ref": "#/components/schemas/Orientation"
7182+
},
7183+
"ProductLineItems": {
7184+
"$ref": "#/components/schemas/ProductLineItems"
7185+
},
7186+
"CapacityDC": {
7187+
"$ref": "#/components/schemas/CapacityDC"
7188+
},
7189+
"FileFolderURL": {
7190+
"$ref": "#/components/schemas/FileFolderURL"
7191+
},
7192+
"Description": {
7193+
"$ref": "#/components/schemas/Description"
7194+
},
7195+
"PVSystemStringID": {
7196+
"$ref": "#/components/schemas/PVSystemStringID"
7197+
}
7198+
}
7199+
},
7200+
"Orientation": {
7201+
"description": "Orientation is defined by Azimuth, Tilt and Roll. Azimuth and Tilt are defined in the context of a right-hand coordinate system where the the x-axis is East, y-axis is North, and the z-axis is vertical.",
7202+
"properties": {
7203+
"Azimuth": {
7204+
"$ref": "#/components/schemas/Azimuth"
7205+
},
7206+
"Tilt": {
7207+
"$ref": "#/components/schemas/Tilt"
7208+
},
7209+
"Roll": {
7210+
"$ref": "#/components/schemas/Roll"
7211+
}
7212+
},
7213+
"type": "object"
7214+
},
7215+
"ProductLineItems": {
7216+
"type": "array",
7217+
"items": {
7218+
"$ref": "#/components/schemas/ProductLineItem"
7219+
},
7220+
"x-ob-usage-tips": ""
7221+
},
7222+
"ProductLineItem": {
7223+
"type": "object",
7224+
"description": "A product used within a PVSystem and the quantity of that product",
7225+
"properties": {
7226+
"Product": {
7227+
"$ref": "#/components/schemas/Product"
7228+
},
7229+
"Description": {
7230+
"$ref": "#/components/schemas/Description"
7231+
},
7232+
"FileFolderURL": {
7233+
"$ref": "#/components/schemas/FileFolderURL"
7234+
},
7235+
"Quantity": {
7236+
"$ref": "#/components/schemas/Quantity"
7237+
},
7238+
"AmountExtended": {
7239+
"$ref": "#/components/schemas/AmountExtended"
7240+
}
7241+
},
7242+
"x-ob-usage-tips": ""
7243+
},
7244+
"PVSystemArrays": {
7245+
"type": "array",
7246+
"items": {
7247+
"$ref": "#/components/schemas/PVSystemArray"
7248+
}
69927249
}
69937250
}
69947251
},
@@ -11925,4 +12182,4 @@
1192512182
]
1192612183
}
1192712184
}
11928-
}
12185+
}

0 commit comments

Comments
 (0)