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.

Sign up for GitHub

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

Jump to bottom

Augment DCL schemas with SchemaVersion field #502

Closed
mdamle opened this issue Aug 9, 2023 · 2 comments
Closed

Augment DCL schemas with SchemaVersion field #502

mdamle opened this issue Aug 9, 2023 · 2 comments
Assignees
@akarabashov
Labels
maintenance
Milestone
v1.4: DCL 1.4

Comments

@mdamle
Copy link

mdamle commented Aug 9, 2023

DCL schemas such as Device Model Schema do not have a schema version field. Schema version is important to maintain forward/backward compatibility in case new fields are added to the schemas or existing fields are moved/deprecated/made optional in future.

Recommendation is to add SchemaVersion to all DCL schemas.
@mdamle mdamle changed the title Augment DCL schemas with schemaversion field Augment DCL schemas with SchemaVersion field Aug 9, 2023
@ashcherbakov ashcherbakov added the enhancement New feature or request label Nov 10, 2023
@ashcherbakov
Copy link
Contributor

We need to write a Design here first.
Adding a Version field to all data schemes (.proto) is possibly one of the things we can do, but maybe we need to do more. Need to look how versioning is implemented in other Cosmos SDK projects.
Need to take into account blockchain/Cosmos specifics.

@ashcherbakov ashcherbakov added maintenance and removed enhancement New feature or request labels Jan 4, 2024
Abdulbois added a commit that referenced this issue Mar 16, 2024
@Abdulbois
#502 Add schema version field to entities
8ba6b99 
Signed-off-by: Abdulbois <abdulbois.tursunov@dsr-corporation.com>
Signed-off-by: Abdulbois <abdulbois123@gmail.com>
Abdulbois added a commit that referenced this issue Mar 18, 2024
@Abdulbois
#502 Add schema version field to entities
5b13ee6 
Signed-off-by: Abdulbois <abdulbois.tursunov@dsr-corporation.com>
Signed-off-by: Abdulbois <abdulbois123@gmail.com>
Abdulbois added a commit that referenced this issue Mar 19, 2024
@Abdulbois
#502 Add schema version field to entities
0be347e 
Signed-off-by: Abdulbois <abdulbois.tursunov@dsr-corporation.com>
Signed-off-by: Abdulbois <abdulbois123@gmail.com>
Abdulbois added a commit that referenced this issue Mar 19, 2024
@Abdulbois
#502 Add schema version field to entities
6dad5b2 
Signed-off-by: Abdulbois <abdulbois.tursunov@dsr-corporation.com>
Signed-off-by: Abdulbois <abdulbois123@gmail.com>
Abdulbois added a commit that referenced this issue Mar 19, 2024
@Abdulbois
#502 Add schema version field to entities
7d0c967 
Signed-off-by: Abdulbois <abdulbois.tursunov@dsr-corporation.com>
Signed-off-by: Abdulbois <abdulbois123@gmail.com>
Abdulbois added a commit that referenced this issue Mar 20, 2024
@Abdulbois
#502 Add schema version field to entities
407702b 
Signed-off-by: Abdulbois <abdulbois.tursunov@dsr-corporation.com>
Signed-off-by: Abdulbois <abdulbois123@gmail.com>
Abdulbois added a commit that referenced this issue Mar 20, 2024
@Abdulbois
#502 Add schema version field to entities
b159689 
Signed-off-by: Abdulbois <abdulbois.tursunov@dsr-corporation.com>
Signed-off-by: Abdulbois <abdulbois123@gmail.com>
Abdulbois added a commit that referenced this issue Mar 20, 2024
@Abdulbois
#502 Add schema version field to entities
411cf74 
- Make 0 as default value for `schemaVersion` field
- Remove `schemaVersion` from Product schema
- Minor refactoring

Signed-off-by: Abdulbois <abdulbois.tursunov@dsr-corporation.com>
Signed-off-by: Abdulbois <abdulbois123@gmail.com>
Abdulbois added a commit that referenced this issue Mar 20, 2024
@Abdulbois
#502 Add schema version field to entities
480e17e 
- Make 0 as default value for `schemaVersion` field
- Remove `schemaVersion` from Product schema
- Minor refactoring

Signed-off-by: Abdulbois <abdulbois.tursunov@dsr-corporation.com>
Signed-off-by: Abdulbois <abdulbois123@gmail.com>
Abdulbois added a commit that referenced this issue Mar 20, 2024
@Abdulbois
#502 Add schema version field to entities
e79cac7 
- Make 0 as default value for `schemaVersion` field
- Remove `schemaVersion` from Product schema
- Minor refactoring

Signed-off-by: Abdulbois <abdulbois.tursunov@dsr-corporation.com>
Signed-off-by: Abdulbois <abdulbois123@gmail.com>
Abdulbois added a commit that referenced this issue Mar 20, 2024
@Abdulbois
#502 Add schema version field to entities
8daac57 
- Make 0 as default value for `schemaVersion` field
- Remove `schemaVersion` from Product schema
- Minor refactoring

Signed-off-by: Abdulbois <abdulbois.tursunov@dsr-corporation.com>
Signed-off-by: Abdulbois <abdulbois123@gmail.com>
Abdulbois added a commit that referenced this issue Mar 20, 2024
@Abdulbois
#502 Add schema version field to entities
38fad45 
Signed-off-by: Abdulbois <abdulbois.tursunov@dsr-corporation.com>
Signed-off-by: Abdulbois <abdulbois123@gmail.com>
Abdulbois added a commit that referenced this issue Mar 20, 2024
@Abdulbois
#502 Add schema version field to entities
d9c2548 
- Make 0 as default value for `schemaVersion` field
- Remove `schemaVersion` from Product schema
- Minor refactoring

Signed-off-by: Abdulbois <abdulbois.tursunov@dsr-corporation.com>
Signed-off-by: Abdulbois <abdulbois123@gmail.com>
Abdulbois added a commit that referenced this issue Mar 20, 2024
@Abdulbois
#502 Add schema version field to entities
90d5611 
Signed-off-by: Abdulbois <abdulbois.tursunov@dsr-corporation.com>
Signed-off-by: Abdulbois <abdulbois123@gmail.com>
Abdulbois added a commit that referenced this issue Mar 20, 2024
@Abdulbois
#502 Add schema version field to entities
1076221 
- Make 0 as default value for `schemaVersion` field
- Remove `schemaVersion` from Product schema
- Minor refactoring

Signed-off-by: Abdulbois <abdulbois.tursunov@dsr-corporation.com>
Signed-off-by: Abdulbois <abdulbois123@gmail.com>
Abdulbois added a commit that referenced this issue Mar 22, 2024
@Abdulbois
#502 Add schema version field to entities
ab199e7 
- Enable to validate `schemaVersion` field for uint16 range
- Additionally add `schemaVersion` into proto files
- Update transactions.md

Signed-off-by: Abdulbois <abdulbois.tursunov@dsr-corporation.com>
Signed-off-by: Abdulbois <abdulbois123@gmail.com>
Abdulbois added a commit that referenced this issue Mar 22, 2024
@Abdulbois
#502 Add schema version field to entities
491994b 
- Fix linter errors

Signed-off-by: Abdulbois <abdulbois.tursunov@dsr-corporation.com>
Signed-off-by: Abdulbois <abdulbois123@gmail.com>
Abdulbois added a commit that referenced this issue Mar 22, 2024
@Abdulbois
#502 Add schema version field to entities
cd49561 
- Fix integration test errors

Signed-off-by: Abdulbois <abdulbois.tursunov@dsr-corporation.com>
Signed-off-by: Abdulbois <abdulbois123@gmail.com>
Abdulbois added a commit that referenced this issue Mar 23, 2024
@Abdulbois
#502 Add schema version field to entities
3774cf8 
- Add unit tests for static validation
- Fix integration test errors

Signed-off-by: Abdulbois <abdulbois.tursunov@dsr-corporation.com>
Signed-off-by: Abdulbois <abdulbois123@gmail.com>
Abdulbois added a commit that referenced this issue Mar 23, 2024
@Abdulbois
#502 Add schema version field to entities
2d3ee9b 
- Add unit tests for static validation
- Fix integration test errors

Signed-off-by: Abdulbois <abdulbois.tursunov@dsr-corporation.com>
Signed-off-by: Abdulbois <abdulbois123@gmail.com>
Abdulbois added a commit that referenced this issue Mar 25, 2024
@Abdulbois
#502 Add schema version field to entities
6b6a444 
- Add unit tests for static validation
- Fix integration test errors
- Update openapi.yaml file

Signed-off-by: Abdulbois <abdulbois.tursunov@dsr-corporation.com>
Signed-off-by: Abdulbois <abdulbois123@gmail.com>
akarabashov added a commit that referenced this issue Mar 25, 2024
@akarabashov
Merge pull request #552 from zigbee-alliance/#502-Add-schema-version-…
b0304a0 
…to-all-DCL-schemas

#502 Add SchemaVersion field into PKI, Compliance, Model and VendorInfo schemas
@akarabashov
Copy link
Collaborator

PR: #552

@github-project-automation github-project-automation bot moved this to Done in DCL 1.4 Aug 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@akarabashov akarabashov

Labels
maintenance
Projects
DCL 1.4
Status: Done
Milestone
v1.4: DCL 1.4
Development

No branches or pull requests
3 participants
@mdamle @ashcherbakov @akarabashov