-
Notifications
You must be signed in to change notification settings - Fork 890
Clarify relationship self link #920
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
Conversation
a5eea96
to
3846bf7
Compare
Any objections to my merging this? |
PR in response to the confusion in http://discuss.jsonapi.org/t/how-to-handle-an-excessive-number-of-included-resources/209 This isn't adding anything new, just repeating info in another place to make it easier to find amidst our (now quite long) spec.
3846bf7
to
136f37a
Compare
The wording is slightly awkward, but I am fine with this 👍 |
Cool beans; merged. Re the wording, I'm happy to revise it if anyone has ideas. In the mean time, though, I figure something is better than nothing. |
Clarify relationship self link
I think the wording of the added part is fine; however, I've always thought the previous sentence is unhelpful:
Surely you don't need to go through the relationship URL to do that — just set the value to In #498 I suggested:
Looking at this now, "replacing the entire set of |
Nice to see you again, @bintoro! Hope all's going well :) About the sentence you mentioned: I've always understood its chief purpose to be pointing out the difference between updating resource objects and updating the links between them. Your text better captures when exactly a relationship link would be needed (since, as you point out, the example currently given could be handled through the resource object), but it seems to bury this high-level distinction a bit. Maybe there's some text that gets the best of both worlds? |
Well hey @ethanresnick 😄 I had to take some time off coding because of vision problems that turned out to be a tumor messing with the optic nerve! It got taken out and now I'm recovered. 💪
Ahh okay now I get it. I've always read it as if it's trying to present a way to do something fancy:
Rewriting it like this totally changes the connotation for me:
To me, this looks more like a description of what the link is, as opposed to an example of something cool the link can do. Am I making any sense here? |
@bintoro Sorry to hear about the vision issues, and so glad you're recovered!
Yeah, that makes total sense, and I'm 👍 on the spirit of your wording, though I'd tweak it a bit:
Does that sound good? If so, can you open a PR and, assuming no one objects, we'll merge it in! |
Yessss, that's the word I was going for. Perfect. |
PR in response to the confusion in http://discuss.jsonapi.org/t/how-to-handle-an-excessive-number-of-included-resources/209
This isn't adding anything new, just repeating info in another place to make it easier to find amidst our (now quite long) spec.