[APIS-16] API Guidelines Revision 4.0 #26
Conversation
There was a problem hiding this comment.
Hopefully most of these comments are just notes about clarification. I know a couple might spark discussion further than just updating wording -- I'm fine if they're not hashed out for this document and I expect for some this will be the case. Just want to bring them up since this document brought them to mind and they could potentially be things to at least note as things lacking any solid specification determination on the current de facto implementation in use today.
| * The _required_ resource name corresponds to an entity in the Ed-Fi Unifying | ||
| Data Model. Examples of resource names, which are always plural: `students`, | ||
| `studentEducationOrganizationAssociations`. |
There was a problem hiding this comment.
regarding plural, it might be obvious to most, but could be worth specifying that it follows standard english grammar and not "programmer plural" (localEducationAgencys vs localEducationAgencies). Not sure if anyone would actually do that, but it would make sense to me if I saw someone design such a thing
api-guidelines/v4.0/API-DESIGN-GUIDELINES/UNIFORM-RESOURCE-LOCATORS.md
Outdated
Show resolved
Hide resolved
Mention Descriptor API Clarifications and additional examples
datetime examples
Move URL notes to new page
* Deprecation of link * Clarifications on case sensitivity * Remove whitespace * Wordsmithing * Further clarification on link * New Keys document * Remove TODO Add new page to TOC
Remove term "primary key"
Discovery API readme Resources API readme
No description provided.