Skip to content

Introduce "resource identifier objects" #632

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

Merged
merged 2 commits into from
May 20, 2015
Merged

Conversation

dgeb
Copy link
Member

@dgeb dgeb commented May 20, 2015

Instead of referring to "linkage objects" that identify resources with
type and id, this concept is generalized with a new definition:
"resource identifier objects".

Using this term throughout the spec provides simplification and
consistency, as it can be used not only for relationships but also
for bulk deletes.

Furthermore, with the introduction of the relationships object, we no
longer need to force the term "linkage" into the document structure.
Within a relationships object, this member has been replaced simply with
"data", which represents the relationship data. This has a nice
parallel for relationship URLs in which relationship data is the
primary data.

Credit to @ethanresnick for the term "resource identifier object".

See #618 and #625 for more history and discussion.

@dgeb dgeb force-pushed the relationship-data branch 2 times, most recently from 228cbec to c9dc099 Compare May 20, 2015 13:38
@dgeb dgeb added this to the 1.0 milestone May 20, 2015
The body of the request **MUST** contain a `data` member whose value is an
an array of objects that each contain a `type` and `id`.
The body of the request **MUST** contain a `"data"` member whose value is an
an array of resource identifier objects.
Copy link
Member

Choose a reason for hiding this comment

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

I would link this to the resource identifier objects section (same for all references).

Copy link
Member Author

Choose a reason for hiding this comment

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

Agreed - might as well add these references now.

@tkellen
Copy link
Member

tkellen commented May 20, 2015

👍 with those minor nits addressed. I'm okay with waiting on the inter-document linking, if you think it'll be too arduous given our current timeframe.

dgeb added 2 commits May 20, 2015 10:45
Instead of referring to "linkage objects" that identify resources with
`type` and `id`, this concept is generalized with a new definition:
"resource identifier objects".

Using this term throughout the spec provides simplification and
consistency, as it can be used not only for relationships but also
for bulk deletes.

Furthermore, with the introduction of the relationships object, we no
longer need to force the term "linkage" into the document structure.
Within a relationships object, this member has been replaced simply with
`"data"`, which represents the relationship data. This has a nice
parallel for relationship URLs in which relationship data _is_ the
primary data.
@dgeb dgeb force-pushed the relationship-data branch from c9dc099 to 4f3cbcf Compare May 20, 2015 14:46
@dgeb
Copy link
Member Author

dgeb commented May 20, 2015

@tkellen Thanks for the review. I just made all those changes with the exception of the inter-document links. We'll need a thorough review to catch all of those. Plus I'm not sure if there's a better strategy than just hard-coding the URLs in each document.

@tkellen
Copy link
Member

tkellen commented May 20, 2015

👍

tkellen pushed a commit that referenced this pull request May 20, 2015
Introduce "resource identifier objects"
@tkellen tkellen merged commit 42ea032 into gh-pages May 20, 2015
@tkellen tkellen deleted the relationship-data branch May 20, 2015 14:52
@ethanresnick
Copy link
Member

+1. Thanks for actually writing this up, @dgeb. My family's in town today and tomorrow and I'm graduating, so I didn't have a chance to do this.

@dgeb
Copy link
Member Author

dgeb commented May 20, 2015

Wow, congratulations @ethanresnick! Hopefully our little spec will graduate along with you :)

@ethanresnick
Copy link
Member

Thanks @dgeb! It's been quite a crazy day.

@neomerx
Copy link
Contributor

neomerx commented May 20, 2015

@ethanresnick for someone crazy day only begins 😉
I've just closed 'relationships' change and got another one

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy