Documenting a resource that implements multiple traits


#1

In my RAML API docs I have a resource that has multiple traits

/userProfile:
  is: [statusCodes, oauthSecured]
  get: !include includes/get-user-profile.raml

The oauthSecured trait defines a <<scope>> parameter, but when I try to supply a value for this parameter by changing the above to:

/userProfile:
  is: [statusCodes, oauthSecured: {scope: "profile"}]
  get: !include includes/get-user-profile.raml

I get an error. I’ve used this syntax with resources that implement a single parameterized trait, is a different syntax required for resources that implement multiple traits?


#2

Hi @domurtag, can you post the relevant pieces from your RAML so I can test it on my side, pls. What designer are you using?