Skip to main content

Below is the basic user data type snipped for brevity:

 

#%RAML 1.0 DataType

type: object

properties:

  id?: string

  email?: string

  disableableCredentialTypes?: array

  requiredActions?: !include /dataTypes/requiredActions.raml

  notBefore?: number

examples: 

  !include /examples/user.raml

 

It has the following include, as the file would be used in multiple other data types

 

#%RAML 1.0 DataType

type: array

items:

  enum: [UPDATE PASSWORD,

  CONFIGURE OTP,

  VERIFY EMAIL,

  UPDATE PROFILE]

 

The below in the user example

 

#%RAML 1.0 NamedExample

user:

  id: 334gf546256

  email: this@that.com

  disableableCredentialTypes: []

  requiredActions: !include /examples/requiredActions.raml

  notBefore: 0

 

Below is the requiredActions example

 

#%RAML 1.0 NamedExample

  [UPDATE PASSWORD]

 

Is the above syntax or (- UPDATE PASSWORD) what is always used for arrays or do I have a slightly odd structure?

 

I though it would be closer to the example for the user which has a root of user:

 

RAML syntax is still bit tricky for me

4 answers
  1. Oct 13, 2020, 12:23 PM

    Thanks, that helps clear things up.

0/9000