github.com/Axway/agent-sdk@v1.1.101/pkg/apic/testdata/raml_10.raml (about)

     1  #%RAML 1.0
     2  title: API with Examples
     3  description: Grand Theft Auto:Vice City
     4  version: v3
     5  protocols: [HTTP,HTTPS]
     6  baseUri: https://na1.salesforce.com:4000/services/data/{version}/chatter
     7  
     8  types:
     9    User:
    10      type: object
    11      properties:
    12        name: string
    13        lastname: string
    14      example:
    15        name: Bob
    16        lastname: Marley
    17    Org:
    18      type: object
    19      properties:
    20        name: string
    21        address?: string
    22        value? : string
    23  /organisation:
    24    post:
    25      headers:
    26        UserID:
    27          description: the identifier for the user that posts a new organisation
    28          type: string
    29          example: SWED-123 # single scalar example
    30      body:
    31        application/json:
    32          type: Org
    33          example: # single request body example
    34            value: # needs to be declared since type contains 'value' property
    35              name: Doe Enterprise
    36              value: Silver
    37    get:
    38      description: Returns an organisation entity.
    39      responses:
    40        201:
    41          body:
    42            application/json:
    43              type: Org
    44              examples:
    45                acme:
    46                  name: Acme
    47                softwareCorp:
    48                  value: # validate against the available facets for the map value of an example
    49                    name: Software Corp
    50                    address: 35 Central Street
    51                    value: Gold # validate against instance of the `value` property