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.

Sign up for GitHub

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

Jump to bottom

JSON Path spec version update in xAPI profiles structure document #257

Open
imartinezortiz opened this issue Apr 15, 2022 · 3 comments · May be fixed by #260
Open

JSON Path spec version update in xAPI profiles structure document #257

imartinezortiz opened this issue Apr 15, 2022 · 3 comments · May be fixed by #260

Comments

@imartinezortiz
Copy link
Contributor

imartinezortiz commented Apr 15, 2022 •
edited

Filing an issue about the xAPI Profiles specification? Please include the following

  • Which part/parts of the specification are at issue?

xAPI profiles structure: statements templates

  • What is your understanding of what the spec means in these parts?

Currently this document references a de-facto JSON path specification documentation, but currently there is an ongoing IETF effort https://datatracker.ietf.org/wg/jsonpath/about/ to create an IETF standard for JSON Path and align it with other IETF efforts.

  • Related to your implementation, what's the use case you're trying to achieve? What are the user stories you're trying to support?

As the IETF about page for the JSON Path WG states, there is some variability in the implementation of the JSON Path specification, having a direct impact in a xAPI profile processor library.

  • How you would like the specification to be improved?

I suggest to track the IETF JSON Path WG progress as part of the IEEE P9274.2.1 WG work, and evaluate the impact in the xapi profile spec update process.
@andyjohnson
Copy link
Collaborator

@andyjohnson will make a PR for this change in document to modify/include guidance and resources.

imartinezortiz added a commit to imartinezortiz/xapi-profiles that referenced this issue Aug 2, 2022
@imartinezortiz
Update reference and clarify constraints
ff80f58 
Update references to the IETF WG documents, clarify some of the
specification JSONPath constraints and provide crossreferences between
documents.

Fixes adlnet#257
imartinezortiz added a commit to imartinezortiz/xapi-profiles that referenced this issue Aug 2, 2022
@imartinezortiz
Update references and clarify JSONPath constraints
8978e60 
Update references to the IETF WG documents, clarify some of the
specification JSONPath constraints and provide crossreferences between
documents.

Fixes adlnet#257
imartinezortiz added a commit to imartinezortiz/xapi-profiles that referenced this issue Aug 2, 2022
@imartinezortiz
Update references and clarify JSONPath constraints
cbebe06 
Update references pointing to the IETF WG documents, clarify some of the
specification JSONPath constraints and provide crossreferences between
documents.

Fixes adlnet#257
imartinezortiz added a commit to imartinezortiz/xapi-profiles that referenced this issue Aug 2, 2022
@imartinezortiz
Update references and clarify JSONPath constraints
c91473e 
Update references pointing to the IETF WG documents, clarify some of the
specification JSONPath constraints and provide crossreferences between
documents.

Fixes adlnet#257
@imartinezortiz imartinezortiz linked a pull request Aug 2, 2022 that will close this issue
Open
@imartinezortiz
Copy link
Contributor Author

Opened #260 to address this issue.

@imartinezortiz
Copy link
Contributor Author

Just doing some maintenance on pending issues.

Seems that the IETF WG is progressing. In fact, the WG seems to be working on two separate specs (I-Reg and JSONPath base) in order to address some of the security concerns of using some parts of the JSONPath spec (in filters and expressions that are currently forbidden in the xAPI profiles spec).

In addition as discussed in one of our subgroup meeting I raised and issue related to the following xapi profiles structure section related to JSONPath:

Any two or more legal JSONPath expressions, joined together by the pipe character |, optionally with whitespace around the pipe, are also considered a legal JSONPath expression. The value of this expression is all the values returned by each expression individually, flattened (that is, if one expression returns N values and another returns a single value, the combination returns N+1 values, not two values).

This constraint is an extension to the JSONPath syntax, so the profile server and processing libraries require to split the JSONPath expression in order to validate / apply it. A more granular approach would be to change the attributes that use JSONPath expressions from string to Array types.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Update references and clarify JSONPath constraints imartinezortiz/xapi-profiles
2 participants
@andyjohnson @imartinezortiz