This repository was archived by the owner on May 28, 2022. It is now read-only.

Description
Great progress! Here are some observations (big and small) about things that would improve the description.
- Change all instances of
UserGrid to Usergrid, as the G should not be capitalized (including the filename)
- Since schemas refer to definition keys, recommend removing the spaces, for example,
Action Response Info might become ActionResponseInfo
- Consider names of things, like
UserInfo might be more succinct as User or ActionResponseInfo might be Action (important to think through the semantics, even of these examples)
parameters can now be defined as a peer of definitions. @jwest-apigee knows more about this.
- Consistent casing of
descriptions, see https://github.com/apigee-127/usergrid-swagger/blob/master/UserGrid.yaml#L42 for one that begins with lowercase. Recommend uppercase for all.
- Try not to use the verb in the description of the operation. For example,
Use the GET method to retrieve details about an admin user could be expressed as, Retrieve details about an admin user https://github.com/apigee-127/usergrid-swagger/blob/master/UserGrid.yaml#L65
- As a property, use
uuid, but in docs, use UUID. https://github.com/apigee-127/usergrid-swagger/blob/master/UserGrid.yaml#L69
- Is it valid to use a | in a path? Need to check. See: https://github.com/apigee-127/usergrid-swagger/blob/master/UserGrid.yaml#L316
- Reconsider tag names, such as
Credential Info to be as accurate and succinct as possible https://github.com/apigee-127/usergrid-swagger/blob/master/UserGrid.yaml#L520