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

Rename version field to make more clear that this is for the USS version #3

Closed
ldeboer opened this issue May 25, 2022 · 2 comments
Closed

Comments

@ldeboer
Copy link

ldeboer commented May 25, 2022

The issue:

Currently, there is a field on the root universalScheduleStandard object named "version". To most people reading through this object (including myself), I think the version field would be interpreted as containing a version name or number for the production or breakdown data, rather than a place for indicating the current version of the USS standard being used.

Proposed Solution:

I would recommend one of the following solutions:

  1. Rename the "version" field to ussVersion or formatVersion or something similar to this to make clear that it should not be used to store project or breakdown version data.

  2. Move the "version" field outside of the universalScheduleStandard object and to the very top of the JSON object, such as this:

{
  "version" : "1.0.2" 
  "universalScheduleStandard": {
    "id": string | UUID value | required,
    "author": string | name of individual creator | can be null,
    "company": string | name of the company for which the schedule was created | can be null,
    [ .... ]
  }
}

Personally, I think I'm leaning toward option 2. But interested to hear what others think!

Thanks!
Luke @ SetHero (luke@setheroapp.com)

@modemmute
Copy link
Collaborator

Renaming version to ussVersion makes sense and would be a simple and potentially helpful change to the standard. I can definitely see it decreasing the possibility of misusing the key when implemented.

Will leave this issue open for a while to allow others to comment.

@UniversalScheduleStandard
Copy link
Owner

This suggestion was accepted and is included in v0.9.1

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

3 participants