Skip to content

Update to 10.4 "Output Structure" #825

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
Jan 31, 2020

Conversation

bwicklund
Copy link
Contributor

Per the following issue: #824

@gregsdennis
Copy link
Member

gregsdennis commented Dec 10, 2019

To be clear, there's not a typo in the text. This is about vertices not being defined.

Copy link
Member

@gregsdennis gregsdennis left a comment

Choose a reason for hiding this comment

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

These are informal errors intended for the prose explanation of the output, not errors as they would be generated by an implementation. It's fine for them to have semantic information about the schema.

"Vertices" is probably left over from an earlier draft of this section while I wrote it.

@Relequestual what's the process for changes like these? Does this go into a "draft 2019-12” or whatever the next minor iteration is?

@Relequestual
Copy link
Member

Interesting case here.
What would happen if the $ref was inlined?
You would then only know what "it" was based on any provided annotations, for example title.
Alterntativly, use properties key, OR, say "at the document root".
My feeling is the correct "fix" for this would be to include the annotation.
Additionally, we could suggest a workflow for determining the subject of the error.

Later in 10.4.2, we give the BASIC output with the error "Expected at least 3 items but found 2".

Maybe the mentioned error message was simply not sanity checked.
Either way, the ISSUE is correct, but I'm not sure on the intent or the best resolution right now.

@Relequestual
Copy link
Member

In terms of "what's the process", let's open a new issue and get it defined properly =]

@handrews
Copy link
Contributor

@gregsdennis I tried really hard to get all of the example lines within the limits of the IETF text rendering format, or at least down to only giving specification build warnings instead of errors. I'm fairly certain I changed it to "points" to save a few letters and must have missed "vertices" here.

@handrews handrews added this to the draft-08-patch1 milestone Jan 15, 2020
@handrews
Copy link
Contributor

@Relequestual @gregsdennis the process is to tag these things with the appropriate milestone, which would be draft-08-patch1. Which I've been doing as appropriate since 2019-09 was published. See also the big table at https://json-schema.org/specification-links.html which records milestones along with every other type of version thingy we use.

@Relequestual
Copy link
Member

I think two is the magic number here...

@Relequestual Relequestual merged commit f8a5d46 into json-schema-org:master Jan 31, 2020
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