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.

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

JSONAPI: optionally include linked documents in responses to save on api requests #403

Closed
jessereynolds opened this issue Jan 1, 2014 · 1 comment
Closed

JSONAPI: optionally include linked documents in responses to save on api requests #403

jessereynolds opened this issue Jan 1, 2014 · 1 comment
Labels
Feature REST API
Milestone
1.0

Comments

@jessereynolds
Copy link
Member

GET /contacts/22?include=notification_rules,entities

This is specified in jsonapi:

Inclusion of Related Documents

A server MAY choose to support returning compound documents that include both primary and related documents.

An endpoint MAY return documents related to the primary document(s) by default.

An endpoint MAY also support custom inclusion of related documents based upon an include request parameter. This parameter should specify the path to one or more documents relative to the primary document. If this parameter is used, ONLY the requested related documents should be returned alongside the primary document(s).

Parent: #396
@jessereynolds jessereynolds mentioned this issue Jan 1, 2014
Closed
@jessereynolds jessereynolds changed the title API: optionally include linked documents in responses to save on api requests JSONAPI: optionally include linked documents in responses to save on api requests Apr 16, 2014
@jessereynolds
Copy link
Member Author

Done

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Feature REST API
Projects
None yet
Milestone
1.0
Development

No branches or pull requests
1 participant
@jessereynolds