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

Document mapping of snake_case to lowerCamelCase when validating json #40

Closed
cmungall opened this issue Mar 2, 2022 · 1 comment
Closed

Comments

@cmungall
Copy link
Member

cmungall commented Mar 2, 2022

The protobuf schema uses snake_case:

time_at_last_encounter

however, when I run pfx-tools example, the json examples using lowerCamelCase

E.g.

  "subject": {
    "id": "proband C",
    "timeAtLastEncounter": {
      "age": {
        "iso8601duration": "P27Y"
      }
    },

At first I thought this was a bug, but I see it is documented (albeit in the most cursory fashion) in the protobuf docs:

https://developers.google.com/protocol-buffers/docs/proto3#json

I suspect this is highly non-obvious to non-proto-geeks

maybe document here:
https://phenopacket-schema.readthedocs.io/en/latest/java.html?highlight=json#json-export

I think this needs to be added to the phenopacket-schema,
phenopackets/phenopacket-schema#358

Also, we should add it to the manuscript. Closing here.

@pnrobinson
Copy link
Collaborator

I think this needs to be added to the phenopacket-schema,
phenopackets/phenopacket-schema#358

Also, we should add it to the manuscript. Closing here.

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

No branches or pull requests

2 participants