You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository has been archived by the owner on May 28, 2022. It is now read-only.
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.
Great progress! Here are some observations (big and small) about things that would improve the description.
UserGrid
toUsergrid
, as theG
should not be capitalized (including the filename)Action Response Info
might becomeActionResponseInfo
UserInfo
might be more succinct asUser
orActionResponseInfo
might beAction
(important to think through the semantics, even of these examples)parameters
can now be defined as a peer ofdefinitions
. @jwest-apigee knows more about this.descriptions
, see https://github.com/apigee-127/usergrid-swagger/blob/master/UserGrid.yaml#L42 for one that begins with lowercase. Recommend uppercase for all.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#L65uuid
, but in docs, useUUID
. https://github.com/apigee-127/usergrid-swagger/blob/master/UserGrid.yaml#L69Credential Info
to be as accurate and succinct as possible https://github.com/apigee-127/usergrid-swagger/blob/master/UserGrid.yaml#L520The text was updated successfully, but these errors were encountered: