Make type violations explicit for enumerations #13
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
In #12, we made type violations explicit for non-primitives. However, for enumerations, the type violations are now misinterpreted as invalid enumeration literals, as enumerations in JSON and XML are represented as strings. In this patch, we generate type violations for enumerations as unexpected instances to avoid confusion due to uninformative messages reported from the SDKs.
mristin
deleted the
mristin/Make-type-violations-explicit-for-enumerations
branch
mristin
added a commit
to aas-core-works/aas-core3.0-csharp
that referenced
this pull request
Jun 24, 2023
We update the development requirements to and re-generate everything with: * [aas-core-meta 44756fb], * [aas-core-codegen e2b793f] and * [aas-core3.0-testgen bf3720d7]. This is an important patch propagating in particular the following fixes which affected the constraints and their documentation: * Pull requests in aas-core-meta [#271], [#272] and [#273] which affect the nullability checks in constraints, * Pull request in aas-core-meta [#275] which affects the documentation of many constraints. This patch also includes a propagation of improved test data: * Pull request in aas-core3.0-testgen [#12] which makes the errors in XML more meaningful and easier to debug, and * Pull request in aas-core3.0-testgen [#13] which makes the type violations of enumerations more explicit and thus easier to debug. [aas-core-meta 44756fb]: aas-core-works/aas-core-meta@44756fb [aas-core-codegen e2b793f]: aas-core-works/aas-core-codegen@e2b793f [aas-core3.0-testgen bf3720d7]: aas-core-works/aas-core3.0-testgen@bf3720d7 [#271]: aas-core-works/aas-core-meta#271 [#272]: aas-core-works/aas-core-meta#272 [#273]: aas-core-works/aas-core-meta#273 [#275]: aas-core-works/aas-core-meta#275 [#12]: aas-core-works/aas-core3.0-testgen#12 [#13]: aas-core-works/aas-core3.0-testgen#13
mristin
added a commit
to aas-core-works/aas-core3.0-csharp
that referenced
this pull request
Jun 24, 2023
…18) We update the development requirements to and re-generate everything with: * [aas-core-meta 44756fb], * [aas-core-codegen e2b793f] and * [aas-core3.0-testgen bf3720d7]. This is an important patch propagating in particular the following fixes which affected the constraints and their documentation: * Pull requests in aas-core-meta [#271], [#272] and [#273] which affect the nullability checks in constraints, * Pull request in aas-core-meta [#275] which affects the documentation of many constraints. This patch also includes a propagation of improved test data: * Pull request in aas-core3.0-testgen [#12] which makes the errors in XML more meaningful and easier to debug, and * Pull request in aas-core3.0-testgen [#13] which makes the type violations of enumerations more explicit and thus easier to debug. [aas-core-meta 44756fb]: aas-core-works/aas-core-meta@44756fb [aas-core-codegen e2b793f]: aas-core-works/aas-core-codegen@e2b793f [aas-core3.0-testgen bf3720d7]: aas-core-works/aas-core3.0-testgen@bf3720d7 [#271]: aas-core-works/aas-core-meta#271 [#272]: aas-core-works/aas-core-meta#272 [#273]: aas-core-works/aas-core-meta#273 [#275]: aas-core-works/aas-core-meta#275 [#12]: aas-core-works/aas-core3.0-testgen#12 [#13]: aas-core-works/aas-core3.0-testgen#13
mristin
added a commit
to aas-core-works/aas-core3.0-python
that referenced
this pull request
Jun 24, 2023
We update the development requirements to and re-generate everything with: * [aas-core-meta 44756fb], * [aas-core-codegen 607f65c] and * [aas-core3.0-testgen bf3720d7]. This is an important patch propagating in particular the following fixes which affected the constraints and their documentation: * Pull requests in aas-core-meta [#271], [#272] and [#273] which affect the nullability checks in constraints, * Pull request in aas-core-meta [#275] which affects the documentation of many constraints. This patch also includes a propagation of improved test data: * Pull request in aas-core3.0-testgen [#12] which makes the errors in XML more meaningful and easier to debug, and * Pull request in aas-core3.0-testgen [#13] which makes the type violations of enumerations more explicit and thus easier to debug. [aas-core-meta 44756fb]: aas-core-works/aas-core-meta@44756fb [aas-core-codegen 607f65c]: aas-core-works/aas-core-codegen@607f65c [aas-core3.0-testgen bf3720d7]: aas-core-works/aas-core3.0-testgen@bf3720d7 [#271]: aas-core-works/aas-core-meta#271 [#272]: aas-core-works/aas-core-meta#272 [#273]: aas-core-works/aas-core-meta#273 [#275]: aas-core-works/aas-core-meta#275 [#12]: aas-core-works/aas-core3.0-testgen#12 [#13]: aas-core-works/aas-core3.0-testgen#13
mristin
added a commit
to aas-core-works/aas-core3.0-python
that referenced
this pull request
Jun 24, 2023
) We update the development requirements to and re-generate everything with: * [aas-core-meta 44756fb], * [aas-core-codegen 607f65c] and * [aas-core3.0-testgen bf3720d7]. This is an important patch propagating in particular the following fixes which affected the constraints and their documentation: * Pull requests in aas-core-meta [#271], [#272] and [#273] which affect the nullability checks in constraints, * Pull request in aas-core-meta [#275] which affects the documentation of many constraints. This patch also includes a propagation of improved test data: * Pull request in aas-core3.0-testgen [#12] which makes the errors in XML more meaningful and easier to debug, and * Pull request in aas-core3.0-testgen [#13] which makes the type violations of enumerations more explicit and thus easier to debug. [aas-core-meta 44756fb]: aas-core-works/aas-core-meta@44756fb [aas-core-codegen 607f65c]: aas-core-works/aas-core-codegen@607f65c [aas-core3.0-testgen bf3720d7]: aas-core-works/aas-core3.0-testgen@bf3720d7 [#271]: aas-core-works/aas-core-meta#271 [#272]: aas-core-works/aas-core-meta#272 [#273]: aas-core-works/aas-core-meta#273 [#275]: aas-core-works/aas-core-meta#275 [#12]: aas-core-works/aas-core3.0-testgen#12 [#13]: aas-core-works/aas-core3.0-testgen#13
mristin
added a commit
to aas-core-works/aas-core3.0-typescript
that referenced
this pull request
Jun 24, 2023
We update the development requirements to and re-generate everything with: * [aas-core-meta 44756fb], * [aas-core-codegen 607f65c] and * [aas-core3.0-testgen bf3720d7]. This is an important patch propagating in particular the following fixes which affected the constraints and their documentation: * Pull requests in aas-core-meta [#271], [#272] and [#273] which affect the nullability checks in constraints, * Pull request in aas-core-meta [#275] which affects the documentation of many constraints. This patch also includes a propagation of improved test data: * Pull request in aas-core3.0-testgen [#13] which makes the type violations of enumerations more explicit and thus easier to debug. [aas-core-meta 44756fb]: aas-core-works/aas-core-meta@44756fb [aas-core-codegen 607f65c]: aas-core-works/aas-core-codegen@607f65c [aas-core3.0-testgen bf3720d7]: aas-core-works/aas-core3.0-testgen@bf3720d7 [#271]: aas-core-works/aas-core-meta#271 [#272]: aas-core-works/aas-core-meta#272 [#273]: aas-core-works/aas-core-meta#273 [#275]: aas-core-works/aas-core-meta#275 [#13]: aas-core-works/aas-core3.0-testgen#13
mristin
added a commit
to aas-core-works/aas-core3.0-typescript
that referenced
this pull request
Jun 24, 2023
) We update the development requirements to and re-generate everything with: * [aas-core-meta 44756fb], * [aas-core-codegen 607f65c] and * [aas-core3.0-testgen bf3720d7]. This is an important patch propagating in particular the following fixes which affected the constraints and their documentation: * Pull requests in aas-core-meta [#271], [#272] and [#273] which affect the nullability checks in constraints, * Pull request in aas-core-meta [#275] which affects the documentation of many constraints. This patch also includes a propagation of improved test data: * Pull request in aas-core3.0-testgen [#13] which makes the type violations of enumerations more explicit and thus easier to debug. [aas-core-meta 44756fb]: aas-core-works/aas-core-meta@44756fb [aas-core-codegen 607f65c]: aas-core-works/aas-core-codegen@607f65c [aas-core3.0-testgen bf3720d7]: aas-core-works/aas-core3.0-testgen@bf3720d7 [#271]: aas-core-works/aas-core-meta#271 [#272]: aas-core-works/aas-core-meta#272 [#273]: aas-core-works/aas-core-meta#273 [#275]: aas-core-works/aas-core-meta#275 [#13]: aas-core-works/aas-core3.0-testgen#13
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
In #12, we made type violations explicit for non-primitives. However, for enumerations, the type violations are now misinterpreted as invalid enumeration literals, as enumerations in JSON and XML are represented as strings.
In this patch, we generate type violations for enumerations as unexpected instances to avoid confusion due to uninformative messages reported from the SDKs.