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

Pick and apply consistent JSON excerpt format #104

Closed
zimeon opened this issue Sep 14, 2023 · 1 comment
Closed

Pick and apply consistent JSON excerpt format #104

zimeon opened this issue Sep 14, 2023 · 1 comment
Assignees

Comments

@zimeon
Copy link
Member

zimeon commented Sep 14, 2023

At present we have 3 styles:

  1. Braces added on same line:
{ "summary": "My Authority - Incremental Updates from 2022-01-01 Full Download" }
  1. Braces added on surrounding lines:
{
  "first": {
    "type": "OrderedCollectionPage",
    "id": "https://data.my.authority/change_documents/2021/activity-stream/page/1"
  }  
}
  1. No braces added:
"partOf": {
  "type": "OrderedCollectionPage",
  "id": "https://data.my.authority/change_documents/2021/activity-stream/page/2"
}

I think we should not add extra braces (i.e. use style 3) because it is confusing to suggest that lone properties are JSON objects when they would actually occur with other properties.

@sfolsom sfolsom self-assigned this Sep 25, 2023
@zimeon
Copy link
Member Author

zimeon commented Sep 27, 2023

Was agreed to go with the last form (3) in https://wiki.lyrasis.org/display/LD4P3/2023-09-25+Meeting%3A+Review+tasks

Has been fixed as part of #109, closing

@zimeon zimeon closed this as completed Sep 27, 2023
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