用不同对象的数组声明 raml 数据类型

Question

I have two different Datatypes (this collection can grow and can have more types):

#%RAML 1.0 DataType

type: object
properties:
  sftp:
    type: object
    properties:
      directory: 
        type: string
        example: /upload
      host: 
        type: string
        example: 223.198.120.125
      port: 
        type: string
        example: "2222"
      user: 
        type: string
        example: foo
      pass: 
        type: string
        example: pass

#%RAML 1.0 DataType

type: object
properties:
  file:
    type: object
    properties:
      path: 
        type: string
        example: /mule/inbound

I wish I could define both of them as elements of another Datatype , such as the input JSON could be like:

{
   "alarms":[
      {
         "sftp":{
            "directory":"/upload",
            "host":"223.198.120.125",
            "port":"2222",
            "user":"foo",
            "pass":"pass"
         }
      },
      {
         "file":{
            "path":"/mule/inbound"
         }
      }
   ]
}

Answer 1

I have created 3 RAML files with your DataType input in question

1. DataType input that is mentioned in your question saved as data3.raml

2. DataType input that is mentioned in your question saved as data2.raml

3. crated an another DataType named as data.raml and add both above RAML added into this as elements that is corelating with your inputJSOn mentioned in question

4. all 3 RAMLS kept inside a folder called types

data.raml file is as below:

#%RAML 1.0 DataType

type: object
properties:
  sftp: !include data3.raml   
  file: !include data2.raml

4. crated a examples folder and inside created a file with name data.json and paste the JSON content that was given in your question.

5. created a sample RAML file with resource name /notification that will use all 3rd data type file as below

#RAML 1.0
title: test raml
version: v1
protocols: [HTTPS]

types:
    testdata:
        type: !include types/data.raml
        examples: !include examples/data.json

/notifications:
    post:
        body:
            application/json
                type: testdata

below are the snippet of theses folder structure