report post documentation

[wholmgren]

The report POST documentation and examples don't give me enough information to figure out how to format the request. https://api.solarforecastarbiter.org/#tag/Reports/paths/~1reports~1/post

@lboeman can you clarify this doc string?

[lboeman]

In the current iteration, you'll need these keys in the report_parameters property:

• start, end as ISO 8601 datetimes
• metrics: A list/json array of strings with current options of: 'mae', 'mbe', 'rmse'
• object_type: list/json array of (obs_id, forecast_id) tuples
• filters: empty list as this is yet to be implemented.

The apispec module doesn't have support for rendering the Marshmallow Tuple field type or the nested schema validation (e.g. the List of String Field objects in the metrics field does not display options), so the fields aren't rendering properly yet.

[alorenzo175]

seems like it's taken care of now? https://dev-api.solarforecastarbiter.org/#tag/Reports/paths/~1reports~1/get

[alorenzo175]

Looks like the only missing piece is that the filters keys is not well documented. This probably just requires a change in the schema from a list of dicts to a list of a FilterParameter schema

[alorenzo175]

if filters need an update in the datamodel, do that first