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

docs: identify the schema used for Yaml 1.2 tag resolution #1050

Merged
merged 3 commits into from
Apr 1, 2020
Merged

docs: identify the schema used for Yaml 1.2 tag resolution #1050

merged 3 commits into from
Apr 1, 2020

Conversation

nulltoken
Copy link
Contributor

Fixes #936

Checklist

  • Tests added / updated
  • Docs added / updated

Does this PR introduce a breaking change?

  • Yes
  • No

P0lip
P0lip previously approved these changes Apr 1, 2020
@@ -23,6 +23,7 @@ spectral
```

Please note that by default Spectral supports YAML 1.2 with merge keys extension.
As recommended by the [spec](https://yaml.org/spec/1.2/spec.html#id2804923), tags are resolved according to the "Core schema".
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
As recommended by the [spec](https://yaml.org/spec/1.2/spec.html#id2804923), tags are resolved according to the "Core schema".
As recommended by the [spec](https://yaml.org/spec/1.2/spec.html#id2804923), tags are resolved according to the "Core Schema".

Copy link
Contributor

Choose a reason for hiding this comment

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

Honestly though, YAML spec isn't clear about the schema 😅.
https://medium.com/@P0lip/yaml-is-great-but-dont-use-it-2d02a60181ab section 6.

@P0lip P0lip changed the title chore(doc): Identify the schema used for Yaml 1.2 tag resolution docs: identify the schema used for Yaml 1.2 tag resolution Apr 1, 2020
@@ -23,6 +23,7 @@ spectral
```

Please note that by default Spectral supports YAML 1.2 with merge keys extension.
As recommended by the [spec](https://yaml.org/spec/1.2/spec.html#id2804923), tags are resolved according to the "Core Schema".
Copy link
Contributor

Choose a reason for hiding this comment

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

On a slightly unrelated note - we could move these 2 sentences elsewhere in future, to some more general document.

@philsturgeon philsturgeon merged commit b37e93d into stoplightio:develop Apr 1, 2020
@nulltoken nulltoken deleted the ntk/yaml_doco branch April 6, 2020 09:31
@nulltoken nulltoken self-assigned this Apr 17, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Falsely Identifying Strings as Octals
3 participants