Skip to content

state that the server may send a subset of fields by default #1500

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 3 commits into from
Aug 7, 2020
Merged

state that the server may send a subset of fields by default #1500

merged 3 commits into from
Aug 7, 2020

Conversation

freddrake
Copy link
Contributor

@freddrake
state that the server may send a subset of fields by default
e75bb6f 
- the subset may be empty
- fields[type]= can be used to request no fields
- see json-api#1499
gabesullice
gabesullice reviewed Aug 7, 2020
View reviewed changes
Copy link
Contributor

@gabesullice gabesullice left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @freddrake! I suggested a slight change. WDYT?

_format/1.0/index.md
@@ -1000,11 +1000,16 @@ response on a per-type basis by including a `fields[TYPE]` parameter.

The value of the `fields` parameter **MUST** be a comma-separated (U+002C
COMMA, ",") list that refers to the name(s) of the fields to be returned.
An empty value indicates that no fields should be returned.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

freddrake and others added 2 commits August 7, 2020 15:28
@freddrake @gabesullice
Apply suggestions from code review
972ff17 
Co-authored-by: Gabe Sullice <gabriel@sullice.com>
@gabesullice
Fix line wrapping.
2d9a681
gabesullice
gabesullice approved these changes Aug 7, 2020
View reviewed changes
Copy link
Contributor

@gabesullice gabesullice left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @freddrake!

@gabesullice
Copy link
Contributor

@dgeb, I'll let you merge this as a final +1.

dgeb
dgeb approved these changes Aug 7, 2020
View reviewed changes
Copy link
Member

@dgeb dgeb left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems like a good clarification. Thanks @freddrake!

@dgeb dgeb merged commit 1a57180 into json-api:gh-pages Aug 7, 2020
@freddrake freddrake mentioned this pull request Aug 7, 2020
Closed
@cmeeren
Copy link
Contributor

cmeeren commented Aug 8, 2020

Excellent clarification. Thanks!

@jelhan jelhan mentioned this pull request Jan 3, 2021
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@dgeb dgeb dgeb approved these changes

@gabesullice gabesullice gabesullice approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@freddrake @gabesullice @cmeeren @dgeb