LukeParke/redocly-cli
1
0
Fork 0
mirror of https://github.com/LukeHagar/redocly-cli.git synced 2025-12-10 04:21:20 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: Add a note about expected newlines in multiline markdown fields (#1372)

Browse Source
This commit is contained in:
Lorna Jane Mitchell
2024-01-02 11:17:36 +00:00
committed by GitHub
parent 23eeb3ce85
commit 574541f12e
1 changed files with 9 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
docs/rules/configurable-rules.md
View File

@@ -493,6 +493,11 @@ rules:
notPattern: /^The/ notPattern: /^The/
``` ```
Take care using `notPattern` with multiline Markdown values such as
`description` fields. These may end with a newline rather than the character
you expect. Use the trimmed notations (`|-` or `>-`) or take account of this in
your pattern.
### `pattern` example ### `pattern` example
The following example asserts that the operation summary contains "test". The following example asserts that the operation summary contains "test".
@@ -507,6 +512,10 @@ rules:
pattern: /test/ pattern: /test/
``` ```
Take care using `pattern` with multiline Markdown values such as `description`
fields. These may end with a newline rather than the character you expect. Use
the trimmed notations (`|-` or `>-`) or take account of this in your pattern.
### `ref` example ### `ref` example
The following example asserts that schema in MediaType contains a Reference object ($ref). The following example asserts that schema in MediaType contains a Reference object ($ref).