question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Better JSON standardization

See original GitHub issue

Hello,

Just digging into the schema and it seems like there isn’t much standardization when it comes to property naming conventions and even some property values in the JSON schema.

To give some examples:

Naming conventions There seems like there is a good mixture of camelCase and kebab-case in properties

shortTitle vs collection-editor (okay, perhaps this only occurs once)

Property value conventions The following properties accept both type string and type number

id
issue
number
number-of-volumes
volume

The following properties only accept type string

call-number
chapter-number
citation-number
collection-number
number-of-pages
page
page-first
version

Just a friendly drop in the suggestion box for a better standardization on the next schema update 👍

Issue Analytics

  • State:open
  • Created 7 years ago
  • Comments:18 (10 by maintainers)

github_iconTop GitHub Comments

1reaction
rmzellecommented, Apr 19, 2016

Yeah, good call.

For shortTitle, this is a duplicate of https://github.com/citation-style-language/schema/issues/113.

Regarding the property value conventions, the latter properties should probably be relaxed to accept both “string” and “number”.

0reactions
njbartcommented, Jun 23, 2016

Would that affect a decision on whether to adopt EDTF: Not at all.

It’s only the handling of months in edtf.js I find worrying, and my question to the js experts listening here is, would it make sense to try and get this fixed in edtf.js now, before starting any work on citeproc-js and possibly others.

Read more comments on GitHub >

github_iconTop Results From Across the Web

What is JSON? The universal data format - InfoWorld
JSON is the leading data interchange format for web applications and more. Here's what you need to know about JavaScript Object Notation.
Read more >
best practice to standardize data in JSON objects in a flexible ...
What I'm now looking for is a flexible way to standardise the data and simplify the structures in the JSON so there are...
Read more >
Thoughts on the Future of JSON Schema Standardization
Today (September 27, 2022), JSON Schema announced to move away from the model of how they publish specifications.
Read more >
A beginner's guide to JSON, the data format for the internet
JSON is a human-readable format for storing and transmitting data. ... It is much more compact than other standards and allows for easy ......
Read more >
Google JSON style-guide
Now you know you can expand points to get more details. ... This style guide clarifies and standardizes specific cases so that JSON...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found