Myujth

I've an AWS serverless API definition written in YAML with the help of the serverless-documentation plugin.

It's articulated like this :

1. serverless.yml :

startCreatingItem:
handler: index.startCreatingItem
description: Request a new item
events:
- http:
path: items
method: post
cors: true
private: true
reqValidatorName: 'xMyRequestValidator'
documentation: $file(./documentation/items/startCreatingItem.yml)

2. startCreatingItem.yml :

summary: "Request a new item"
description: "Item information creation"
tags:
-Items
requestBody:
description: Item to be generated
requestModels:
"application/json": "ItemInfo"
methodResponses:
-
statusCode: "200"
description: "Item creation added"
responseModels:
"application/json": "ItemInfo"


3. ItemInfo.json :


"type": "object",
"description": "Model representing the item information",
"required": [ "results" ],
"properties":
"id":
"type": "string",
"format": "uuid",
"description": "The item identifier"
,
"results":
"type": "array",
"description": "A list of result identifier to include in the item",
"items":
"type": "string",
"format": "uuid"

,



I'd like to add a request model example for the object ItemInfo, so it appears in the Swagger page (where the dev can try some things directly from within this page).
For example, I was thinking of something like this in the serverless.yml file :

startCreatingItem:
handler: index.startCreatingItem
description: Request a new item
events:
- http:
path: items
method: post
cors: true
private: true
reqValidatorName: 'xMyRequestValidator'
documentation: $file(./documentation/items/startCreatingItem.yml)
example :
results: [
006897b5-e3fc-4358-8c27-cd54dfd53d49,
769e1c03-9136-465b-93ad-90d889245557
]

(but that doesn't seem to work obviously).

If you have any question or remark, I'll be glad to answer you :)
Thank you in advance for your help !