Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Info

To be published on Exchange/public community documentation

...

GET: no support for limit and offset

DescriptionCurrently the GET querystring parameters offset and limit are not supported.
Likely directionIf the project development continues, support for these will be a priority. Support for these is critical to allow for scaling of larger data pulls from the API, and fixing these issues would allow for larger scale testing of those capabilities, and for that reason would be a priority.

Full authentication support

DescriptionMeadowlark's current authentication is hard coded to two key/secret pairs and hard-coded claims.
Likely directionIf the project development continues, this would be a candidate for further development. However, as this authentication pattern is well-known, it is not seen as an element of the proof-of-concept that there is high value in exploring. Therefore, this is likely to be a lower priority.

Over-posting: posting fields not part of the JSON schema

DescriptionThe Ed-Fi ODS API allows for extraneous fields to be posted without error; such fields are simply ignored. In Meadowlark, these are schema violations and a 4xx error is returned.
Likely direction

Allowing over-posting is generally a bad practice, as it often indicates the API client is not following the schema and can lead to hard to detect errors. However, over-posting can be employed as a simple API client strategy to support multiple versions of an API with less complexity.

This is likely not to be prioritized, given that this permissiveness has both pros and cons and which is more important is unclear. Note also the proposal to the ODS API to allow for this: /wiki/spaces/EFTD/pages/24805685