Sunday 21 May 2017

nodeJS/swager/YAML: How to end a multi-line variable description while adding an object structure sample

I am working on swagger documentation block as shown below that uses {|} operator for multi-line description for one of the item params.

/**
 * @swagger
 * /someCall:
 *   post:
 *     description:
 *       some description 
 *     parameters:
 *       - name: someParamList
 *         description: some param list
 *         in: body
 *         required: true
 *         schema:
 *           type: object
 *           properties:
 *             someObjectParam:
 *                type: object
 *                description: |
                                        sample e.g. {
                                                                                "abcd" - "123", 
                                                                                "xyz"   - "567"
                                                                              }
 *             xyz:
 *                items:
 *                  type: string
 *                  description: number of entries to be retrieved. If lesser log entries are found all will be returned.
 */

This gives following exception:

YAMLException: can not read a block mapping entry; a multiline key may not be an
 implicit key at line 61, column 16:
                xyz:

How should I work around this - how can i terminate the multi-line param text to start a new param definition avoiding such exceptions.



via StillNestling

No comments:

Post a Comment