Versions Compared

Key

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


Info

To be published on Exchange/public community documentation

...

Rather than try to close all these gaps, the goal should be to clearly define what API features are required and which should be allowed to vary. Doing so will allow for the development of alternative API implementations, whether through the open-source effort of the Ed-Fi community or through efforts independent outside of that community work.

List of API Parity Gaps

No extension support





Support for "link" objects in JSON

...

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.

...