RAML trait parameter default value

Question

When defining a trait in RAML it's possible to parameterize it, e.g.

traits:
  - searchable:
      queryParameters:
        query:
          description: Blah blah
          example: <<example>>

Has an <<example>> parameter which is provided by a resource that has this trait like so:

is: [searchable: {example: "exampleValue"}]

Is it possible to specify a default value for trait parameters, such that a resource that has the default value can omit the parameter?

score 1 · Answer 1 · answered Mar 17 '16 at 08:22

1

Just adding the default key should perform what you need:

traits:
  - searchable:
      queryParameters:
        query:
          description: Blah blah
          example: <<example>>
          default: "default value"

answered Mar 17 '16 at 08:22

Karl Laird

13
5

score 0 · Answer 2 · answered Mar 23 '17 at 19:00

0

Following your example, You could add a default key:

   query:
     description: Blah blah
     example: <<example>>
     default: value

answered Mar 23 '17 at 19:00

Vitor Santos

33
5

RAML trait parameter default value

2 Answers2