Details
-
Bug
-
Resolution: Timed out
-
Low
Description
Using the response format of an issue as a reference:
Many items start with all of: as if anyone would expecting a some of: unless explicitly stated. How does this help readability?
The first item of objects & sub-objects is an object of type string *, though the real response has no such object, rather it has a normal property called type with a fixed string value. The expected value is not obvious (it's in a low-visibility, grey comment), and may not even be correct (the example mentions an account object but this is reporter in a real response with a type of user).
Some items show ... instead of the expected contents, like issue->repository->links.
Some response properties may be null but these are not identified in your examples.
I understand that you're trying to provide more info about values than a literal example (like listing potential issue priority values) but, at the moment, it's more legible to make a few test requests to see the actual structure of a response.