Skip to end of metadata
Go to start of metadata

The sections that follow contain guidelines for Ed-Fi REST API designs and implementations. Certain key terms have specific meanings in these guidelines.[4] From this point forward, key terms are italicized when used with the specific meanings shown below:

  • Must, required, shall. These terms indicate an absolute requirement for an aligned Ed-Fi REST API implementation.
  • Must not, shall not. These terms indicate an absolute prohibition for an aligned Ed-Fi REST API implementation.
  • Should, recommended. These terms indicate that there may be valid reasons to ignore a particular item, but the full implications must be understood and carefully weighed before choosing a different course.
  • Should not, not recommended. These terms indicate that there may be circumstances when a particular behavior is acceptable or useful, but the full implications should be understood and the case carefully weighed before implementing such behavior.
  • May, optional. These terms indicate items that are truly optional. One organization may choose to include the item because their specific implementation requires it or because they feel it enhances the implementation, while another organization may omit the item. Client applications must be prepared to interoperate with an implementation that does not include the option, although perhaps with reduced functionality. In the same vein, a client who does include a particular option must be prepared to interoperate with another implementation that does not include the option.
  • Aligned. An aligned implementation meets all the must, required, and shall requirements of these guidelines.

 


Language for this section has been adapted for use from http://www.ietf.org/rfc/rfc2119.txt. This document conforms to the guidelines provided there. 


REST API Specification Documentation Contents

Find out more about the Ed-Fi REST API:

  • No labels