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

Quantify issues people face around resolving $ref against $id #630

Closed
Relequestual opened this issue Jun 28, 2018 · 5 comments
Closed

Quantify issues people face around resolving $ref against $id #630

Relequestual opened this issue Jun 28, 2018 · 5 comments
Assignees

Comments

@Relequestual
Copy link
Member

Relequestual commented Jun 28, 2018

During my attempt to resolve "$ref is delegation", I falsly concluded by #514 (mainly the title) that I should also expand the explanation of how resolution works.

@handrews noted in #585 (comment) after an off-github discussion, that I should collate the StackOverflow questions I had seen regarding $ref resolution to demonstrate the use case that requires modification to $ref resoultion language in the spec, if any.

One to address any clarifications on the process of resolving $ref against $id, which is not significantly impacted by #514/#523. @Relequestual I could see this as going back to an issue or just becoming a new PR. Since you have noted that there are a lot of Stack Oveflow questions motivating this work, I would find an issue linking to some typical SO questions to be very helpful in understanding what you're trying to accomplish. I think my confusion over some of your points is due to lacking this context.

The expected resolution of this issue is the creation of another issue, which will reference this one.

As this issue is not asking and specifically does not want comments from people on issues around $ref, it will be locked.

I kinda feel this issue is just for my own personal tracking purposes.

@Relequestual Relequestual self-assigned this Jun 28, 2018
@json-schema-org json-schema-org locked and limited conversation to collaborators Jun 28, 2018
@handrews
Copy link
Contributor

@Relequestual any update on this? If there's anything going into draft-08 it needs to happen very soon.

@awwright
Copy link
Member

I'm having a difficult time trying to figure out what this issue is asking, in any event.

@handrews
Copy link
Contributor

@awwright IIRC, @Relequestual wanted to rewrite part of the text around $id and $ref while he did the "$ref is delegation" change, but I both found the rewrite more confusing than the original (which had barely been published 3 months ago after a large rewrite with many added examples anyway), and thought it was unrelated to the delegation change.

So I asked him to remove it and file an issue to track figuring out exactly what is unclear and needed, rather than just re-re-re-writing it again. I think it would be at least the fourth time.

@handrews
Copy link
Contributor

I haven't seen any complaints or confusion that point to any particular spec wording problem (as opposed to in the past, where specific complaints led to the rewrite in draft-handrews-json-schema-01). People show up confused on slack, but for those people adding more tutorial to Understanding JSON Schema seems like a better approach to me. But @Relequestual thought there were some specific things to dig up somewhere.

@Relequestual
Copy link
Member Author

Thanks for nudging this issue.
I think I wanted to just look back over a few SO issues and pull out examples of where people found it confusing. The result would live on the UJS site now for sure, and maybe linked to from the main site... I dunno.

I have zero bandwidth on this, and more people come to slack now, so I'll go ahead and close it.
Feel free to open an issue on the UJS site repo and link to this one if anyone would like.

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

No branches or pull requests

3 participants