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

Mismatch between documentation and diagram for FixedValueMap? #30

Open
sosna opened this issue Jan 5, 2024 · 1 comment
Open

Mismatch between documentation and diagram for FixedValueMap? #30

sosna opened this issue Jan 5, 2024 · 1 comment
Labels
bug Something isn't working documentation Improvements or additions to documentation

Comments

@sosna
Copy link
Member

sosna commented Jan 5, 2024

The documentation for FixedValueMap (p. 114) provides the following description: "Links a Component (source or target) to a fixed value.".

However, the Relationship diagram on page 111 has the following cardinality between FixedValueMap and Component: 0..*. Should it not be 1 instead?

The XML schemas are in line with the description (i.e. only one component is referenced):

<xs:complexType name="FixedValueMapType">
	<xs:annotation>
		<xs:documentation>FixedValueMapType defines the structure for providing a fixed value for a source or target component.</xs:documentation>
	</xs:annotation>
	<xs:complexContent>
		<xs:extension base="common:AnnotableType">
			<xs:sequence>
				<xs:choice>
					<xs:element name="Source" type="common:IDType"/>
					<xs:element name="Target" type="common:IDType"/>
				</xs:choice>
				<xs:element name="Value" type="xs:string" minOccurs="0" maxOccurs="unbounded">
					<xs:annotation>
						<xs:documentation>The fixed value for the component.</xs:documentation>
					</xs:annotation>
				</xs:element>
			</xs:sequence>
		</xs:extension>
	</xs:complexContent>
</xs:complexType>

Thanks!

@stratosn
Copy link
Member

Indeed, the relationship seems wrong, as one Component should be mapped in each FixedValueMap.
This is a bug in the IM.

In addition, it looks like the schema needs also some attention, as it now allows 0 to unbounded values, where there should be only one fixed value.
@dosse does this makes sense?

I also see that in the json-schema it is allowed to have 1..* values.

@stratosn stratosn added bug Something isn't working documentation Improvements or additions to documentation labels Jan 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Improvements or additions to documentation
Projects
Status: No status
Development

No branches or pull requests

2 participants