Vale CMS Need more than a rule playground? Explore
Asset Explorer

OpenAPI

The title and every description and summary in an OpenAPI document, read as Markdown.

view daselapi Source

Getting started

Save the file as config/views/OpenAPI.yml under your StylesPath, then:

[*.{yml,yaml}]
BasedOnStyles = Vale

View = OpenAPI

OpenAPI.yml

Pull named scopes out of a file Vale can’t otherwise parse.
# An OpenAPI description: the title, and every `description` and `summary`
# field, which are Markdown by the specification.
#
#   [*.{yml,yaml}]
#   BasedOnStyles = Vale
#   View = OpenAPI
engine: dasel
scopes:
  - name: title
    expr: info.title

  - name: description
    expr: 'search(has("description")).map(description)'
    type: md

  - name: summary
    expr: 'search(has("summary")).map(summary)'
    type: md