Skip to content
This repository was archived by the owner on Nov 8, 2024. It is now read-only.
This repository was archived by the owner on Nov 8, 2024. It is now read-only.

Variable Property Name: using asterisks in the name is broken #89

@anentropic

Description

@anentropic

https://github.com/apiaryio/mson/blob/master/MSON%20Specification.md#322-variable-property-name

*rel (Custom String)* (object)

(where the (Custom String) type annotation is optional)

In my project we have a case where we want to use the literal string value ** as a Variable Property Name

As you can expect, this case is broken 😄

https://github.com/apiaryio/mson/blob/master/MSON%20Specification.md#343-variable-value
The spec appears to say that asterisks in *rel (Custom String)* (object) are Markdown italics

In which case it should be possible to escape the asterisks in my example value using Markdown convention: *\*\**

This gives:
'variable named property' must be string or its sub-type
'semantic issue' error in Apiary web editor

No escaping i.e. **** gives same error

Backticks *`**`* give no error but the variable property name is displayed as just ` (single backtick, i.e. not ** that we were aiming for)

Adding the type annotation helps a bit:

*\*\* (string)* displays as ***
*** (string)* also displays as ***

but this still seems to be wrong, should be **

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions