You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
The text was updated successfully, but these errors were encountered:
Discussed in #174
Originally posted by tliron October 6, 2024
Throughout the spec we detail the keyname tables in Markdown similar to this:
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.
The text was updated successfully, but these errors were encountered: