search

RadiantLabs / modeling-api-docs

Official Modeling API documentation
0 stars 1 forks source link

Document expectations of array or object #17

Closed jefffriesen closed 9 months ago

jefffriesen commented 9 months ago

Another piece of feedback is relating to the documentation and specifying when an array is accepted vs. a single object. For example, airInfiltration accepts an object and clothesDryers accepts an array (even though, it only accepts a single object within the array). It would be helpful to either standardize this so that they were either all arrays with minimum constraints like clothesDryers or if you were going to allow for arrays and objects, then this should be clear in the documentation.

jefffriesen commented 9 months ago

Closed with https://github.com/RadiantLabs/modeling-api-docs/pull/18/files Deployed: https://docs.radiantlabs.co/projects/modeling-api/en/latest/api.html#schemas