Versions Compared

Key

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


Info

To be published on Exchange/public community documentation

Table of Contents

What is "API Parity"?

The goal of Meadowlark is to able to "fool" a current API client: to be able to substitute the Ed-Fi API provided by Meadowlark with the API provided by the Ed-Fi ODS/API and have API clients continue to function/not realize that they were communicating with a different API. We refer to this as "API parity."

...

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.

...