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

Fix pervasive mismatch between TOSCA types and YAML types in spec #175

Open
tliron opened this issue Oct 9, 2024 Discussed in #174 · 0 comments
Open

Fix pervasive mismatch between TOSCA types and YAML types in spec #175

tliron opened this issue Oct 9, 2024 Discussed in #174 · 0 comments
Assignees

Comments

@tliron
Copy link
Contributor

tliron commented Oct 9, 2024

Discussed in #174

Originally posted by tliron October 6, 2024
Throughout the spec we detail the keyname tables in Markdown similar to this:

|Keyname|Mandatory|Type|Description|
| :---- | :------ | :---- | :------ |
|`tosca_definitions_version`|yes|[string](#string)|Defines the [version of the TOSCA specification](#tosca-definitions-version) used in this TOSCA file.|
|`description`|no|[string](#string)|Declares a [description](#description) for this TOSCA file and its contents.|
|`metadata`|no|[map](#map) of YAML values|Defines a section used to declare additional [metadata](#metadata) information. Domain-specific TOSCA profile specifications may define keynames that are mandatory for their implementations.|

Note how the "Type" column features links to sections in TOSCA data types section.

Unfortunately, this is wrong and misleading. The keynames do NOT accept TOSCA data types, but rather YAML values. For example, our TOSCA "map" has key_schemas and entry_schemas that have nothing to do with YAML. A user clicking on such a link to learn more will be led down the wrong path.

If folk agree with me that this is misleading, let's turn this discussion into an issue and I will make the fixes.

Also note that lists in YAML are called "seqs" and should be fixed accordingly.

@tliron tliron self-assigned this Oct 9, 2024
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

No branches or pull requests

1 participant