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

Refactor versionable extensions versions #3346

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

flo-dup
Copy link
Contributor

@flo-dup flo-dup commented Mar 6, 2025

Please check if the PR fulfills these requirements

  • The commit message follows our guidelines
  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been added / updated (for bug fixes / features)
  • A PR or issue has been opened in all impacted repositories (if any)

Does this PR already have an issue describing the problem?
No

What kind of change does this PR introduce?
Design fix

What is the current behavior?
Many parameters relative to each serialization version are defined separately

What is the new behavior (if this is a feature change)?
Each version is defined with all the parameters relative to it

Does this PR introduce a breaking change or deprecate an API?

  • Yes
  • No

If yes, please check if the following requirements are fulfilled

  • The Breaking Change or Deprecated label has been added
  • The migration steps are described in the following section

What changes might users need to make in their application due to this PR? (migration steps)
Starting from this release, AbstractVersionableNetworkExtensionSerDe constructor now takes only 3 arguments:

  • An extensionName, like before
  • An extensionClass, like before
  • An array of versions (objects extending SerDeVersion), which replaces
    • the namespace default prefix
    • the namespace URIs
    • the resource path to the xsd
    • the extension versions corresponding to an IIDM version
    • the list of AlternativeSerializationData describing the alternative serialization names
      (more details to come once concept is validated)

@flo-dup flo-dup added the Breaking Change API is broken label Mar 6, 2025
@flo-dup flo-dup requested a review from olperr1 March 6, 2025 14:54
Base automatically changed from multiple_extension_names to main March 6, 2025 16:23
@flo-dup flo-dup force-pushed the versionable_extensions_versions branch from 86aa241 to ce3249f Compare March 6, 2025 16:33
flo-dup added 2 commits March 6, 2025 17:49
Signed-off-by: Florian Dupuy <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Breaking Change API is broken
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant