Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clarify response fields for default properties in spec. #204

Closed
CasperWA opened this issue Nov 20, 2019 · 0 comments · Fixed by #210
Closed

Clarify response fields for default properties in spec. #204

CasperWA opened this issue Nov 20, 2019 · 0 comments · Fixed by #210
Assignees
Labels
status/has-concrete-suggestion This issue has one or more concrete suggestions spelled out that can be brought up for consensus. topic/response-format Issue discussing changes and improvements to the API response format

Comments

@CasperWA
Copy link
Member

CasperWA commented Nov 20, 2019

While I am in full support for the overall changes; after making these changes we are not so helpful on the underlying intent with what properties get included or not. The reader is likely to end up with the feeling that one needs to carefully consider each individual Response point in Sec 6 to decipher arbitrary conditions of when things should be included or not.

In reality, our rules are very straightforward:

  • If response_fields is not present: return only a small set of default properties.
  • If response_fields is present, return only those fields requested.

I think the right place to say this is early in section 4.1, with maybe a callback from 4.2 to say that the same thing applies for single entry endpoints. Or possibly a new subsection. I started to formulate a suggestion, but do not have time to finish it now. (I'll get back to it eventually if no one else makes an attempt.)

Originally posted by @rartino in #203 (comment)

@merkys merkys added status/has-concrete-suggestion This issue has one or more concrete suggestions spelled out that can be brought up for consensus. topic/response-format Issue discussing changes and improvements to the API response format labels Nov 22, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
status/has-concrete-suggestion This issue has one or more concrete suggestions spelled out that can be brought up for consensus. topic/response-format Issue discussing changes and improvements to the API response format
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants