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

Generate TRAPI warning log when QNode and QEdge are given properties not specified in TRAPI #503

Closed
colleenXu opened this issue Sep 19, 2022 · 2 comments
Assignees
Labels
good first issue Good for newcomers

Comments

@colleenXu
Copy link
Collaborator

We currently don't do anything when the incoming Query has a property on a QNode or QEdge that isn't explicitly-listed in the TRAPI 1.3 spec (see links for QNode and QEdge).

However, the implementation rules that TRAPI APIs are supposed to follow says that we should:

  • generate a TRAPI log (WARNING level). Something like "We've encountered one or more properties on a QNode that we don't recognize: {list them}. We will ignore them and continue execution." for QNode (and similar for QEdge)
  • proceed (aka ignore them)

Note that some Translator devs use QNode.name to give a human-readable label to their QNode. I think it's okay to give a warning on this - since we don't do anything with this "name" right now.

@colleenXu
Copy link
Collaborator Author

Not sure what the status of this is....but there's discussion in the PRs linked to this issue, and it looks like it's close to done...

@tokebe
Copy link
Member

tokebe commented Jan 25, 2023

Deployed to Prod.

@tokebe tokebe closed this as completed Jan 25, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

3 participants