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

Error in Statement fragment pointer description #618

Closed
kd-ods opened this issue Apr 2, 2024 · 1 comment
Closed

Error in Statement fragment pointer description #618

kd-ods opened this issue Apr 2, 2024 · 1 comment

Comments

@kd-ods
Copy link
Collaborator

kd-ods commented Apr 2, 2024

In the Annotation object we have a statementFragmentPointer field. Its description is:

An RFC6901 JSON Pointer (https://tools.ietf.org/html/rfc6901) describing the target fragment of the statement that this annotation applies to, starting from the root of the statement. A value of ‘/’ indicates that the annotation applies to the whole statement.

From rfc6901, it looks like an empty string value points to the whole statement, so the description should be:

An RFC6901 JSON Pointer (https://tools.ietf.org/html/rfc6901) describing the target fragment of the statement that this annotation applies to, starting from the root of the statement. An empty string ("") indicates that the annotation applies to the whole statement.

@radix0000 or @rhiaro - could you just check that my understanding here is correct?

@radix0000
Copy link
Contributor

@kd-ods My interpretation of RFC6901 is that you are correct, though the spec could (and probably should) be more explicit on the matter. Even ignoring the example, the words sequence of zero or more reference tokens, each prefixed
by a '/'
implies that '/' on its own, can only be interpreted as '/""'. I guess this means some of our current pointers are wrong e.g. in current GLEIF annotations.

@kd-ods kd-ods moved this from 📋 To Do - Tasks to 🏗 In progress in Release tracker: BODS version 0.4 Apr 2, 2024
@kd-ods kd-ods moved this from 🏗 In progress to 👀 In review in Release tracker: BODS version 0.4 Apr 4, 2024
@github-project-automation github-project-automation bot moved this from 👀 In review to ✅ Done in Release tracker: BODS version 0.4 Apr 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
No open projects
Status: Done
Development

No branches or pull requests

3 participants