FlexMeasures / flexmeasures / 18493867457

78%

Build Type

push

github

Committed by web-flow

Commit Message

docs: OpenAPI/SwaggerUI (#1703)

* first endpoint working to the point that it can be executed via SwaggerUI

Signed-off-by: Nicolas Höning <nicolas@seita.nl>

* Added docs for Sensor endpoints.

* Added SensorKwargsSchema, Fixed Direct list response, Fixed file upload issues.

* Added generate-openapi to update-docs.

* Updated the URL for docs.

* Added docs to menu.

* Removed JSON file entry.

* Fetch Flexmeasures version dynamically.

* Added external link and one asset endpoint for linking with sensor schedule api.

* Updated changelog.

* Added packages to requirements.

* Update flexmeasures/api/v3_0/assets.py

Co-authored-by: Nicolas Höning <nicolas@seita.nl>
Signed-off-by: Muhammad-Moiz626 <muhammadmoiz4843@gmail.com>

* Update flexmeasures/api/v3_0/assets.py

Co-authored-by: Nicolas Höning <nicolas@seita.nl>
Signed-off-by: Muhammad-Moiz626 <muhammadmoiz4843@gmail.com>

* Fixed Note UI, External linking to actual flexmeasures docs, OpenAPI docs fixes.

* Created FlexContext and FlexModel schemas and added to a new schema for AssetTriggerOpenAPISchema.

* Documented users endpoints.

* Utility function to convert non compatible fields to OpenAPI compatible string field.

* Added UserId schema and fixed password-reset swagger bug.

* Created Schemas for kwargs to be used with docs and actual routes, Generic pagination schemas and some changes in the users endpoints.

* Complete documentation for assets endpoints.

* Fixed assets page 422 error.

* Fixed user endpoint bugs.

* remove description for replacement string field, should resolve error as it is not supported

Signed-off-by: Nicolas Höning <nicolas@seita.nl>

* fix various things in sensor resource endpoints YAML (not 100%) complete yet.

Signed-off-by: Nicolas Höning <nicolas@seita.nl>

* better minimal scheduling example, with a fixed price

Signed-off-by: Nicolas Höning <nicolas@seita.nl>

* clarity on how the query parameters to the get-data endpoint need to be escaped, and can als... (continued)

Run Details

1265 of 1862 branches covered (67.94%)

Branch coverage included in aggregate %.

170 of 198 new or added lines in 17 files covered. (85.86%)

1 existing line in 1 file now uncovered.

9277 of 12573 relevant lines covered (73.79%)

5.9 hits per line