Error in Swauth API doc - Get User Details

[rbeede]

Under Get User Details it has:

Example Response:

HTTP/1.1 200 Ok

{ "groups": [ { "name": "<account>:<user>" },
              { "name": "<user>" },
              { "name": ".admin" } ],
  "auth" : "plaintext:password" }

It should be:

{ "groups": [ { "name": "<account>:<user>" },
              { "name": "<account>" },
              { "name": ".admin" } ],
  "auth" : "plaintext:password" }

So the error is in <user> which should be account on the second line.

[rbeede]

A similar issue seems to exist at

http://gholt.github.io/swauth/stable/details.html

in the section

The <groups_array> contains at least two groups. The first is a unique group identifying that user and it’s name is of the format <user>:<account>. The second group is the <account> itself. Additional groups of .admin for account administrators and .reseller_admin for reseller administrators may exist. Here’s an example user JSON dictionary:

{"auth": "plaintext:testing",
 "groups": ["name": "test:tester", "name": "test", "name": ".admin"]}

Should it be <account>:<user> instead?

Perhaps use test-account and test-user instead to clarify the example.

[gholt]

I agree that changing from test:tester to test-account:test-user would clarify things, but there's a bit of habit on that already. The main thing that changing all the examples would break is that the functional test suite for Swift uses test:tester testing by default.