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

Enhance ls manifest description with schema #1854

Merged
merged 2 commits into from
Mar 16, 2023

Conversation

pmai
Copy link
Collaborator

@pmai pmai commented Mar 1, 2023

This adds a schema for the manifest attributes and the default minimal manifest, and enhances the examples to showcase that to some extent.

@pmai pmai added this to the v3.0.1 milestone Mar 1, 2023
@pmai pmai self-assigned this Mar 1, 2023
Copy link
Collaborator

@chrbertsch chrbertsch left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Shall we include a graphical illustration of the new schema as for the other schemas?

docs/2_6_versioning_layered_standards.adoc Outdated Show resolved Hide resolved
Copy link
Contributor

@PTaeuberDS PTaeuberDS left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is basically the proposal that I made in fmi-ls-xcp so it's fine for me.

<xs:attribute ref="fmi-ls:fmi-ls-description" use="required"/>
</xs:attributeGroup>

<xs:element name="FMILSManifest">
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure if I like the casing. Maybe we should stick to simple camel case as in "fmiModelDescription"?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've regularized and spelt out the naming some more.

<MyRootElement
<MyRootElement
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="fmi_ls_manifest_example_schema.xsd"
xmlns:fmi-ls="http://fmi-standard.org/fmi-ls-manifest"
fmi-ls:fmi-ls-name="org.fmi-standard.demo-ls-name"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we need the attribute prefix in addition to the namespace? Wouldn't "fmi-ls:name" be sufficient?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It technically would, however it is probably still a good idea to have the more explicit names, given that in some circumstances the namespace is not readily apparent.

<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
xmlns:vc="http://www.w3.org/2007/XMLSchema-versioning" elementFormDefault="qualified"
vc:minVersion="1.1"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is version=1.1 necessary for this example? Otherwise we could remove it.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not needed, just happened to be in there...

@chrbertsch
Copy link
Collaborator

It would be good to finalize and merge this.
Let's discuss this at the beginning of tomorrow's design webmeeting.

@chrbertsch chrbertsch merged commit e4f2422 into main Mar 16, 2023
@chrbertsch chrbertsch deleted the feature/enhance-fmi-ls-mechanism branch March 16, 2023 15:50
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

Successfully merging this pull request may close these issues.

3 participants