raml-org / raml-spec

RAML Specification
http://raml.org
3.87k stars 858 forks source link

Clarify "NamedExample" typed fragment description and usage #727

Closed jstoiko closed 3 years ago

jstoiko commented 4 years ago

The NamedExample fragment, being in the singular form, may lead to confusion as to whether it could be used to define a singular example as with example node, or any number of examples as with examples node. The "Typed Fragments" section unambiguously refers to Examples as being the "Relevant RAML Specification Section" for this type of fragment, however the description should be clarified.

Proposed changes

to:

A declaration of the examples facet, whose keys are names of examples and whose values describe each of the examples

  • Add a RAML example making of NamedExample at the bottom of that same section