name: {{name}} service
description: |
    {{description}}
style: COLLECTION
uriTemplate: {{uriTemplate}}
methods:
    GET:
        summary: List all the {{name}}
        notes: List all the {{name}}
        # implementation: api.get{{cName}}
        request:
            parameters: []
            cookies: []
            headers:
                -
                    field: Accept
                    content: "application/json"
                -
                    field: Accept-Encoding
                    content: "gzip, deflate"
        responses:
            -
                name: OK
                statusCode: &OkStatusCode 200
                reason: &OkReason Successful execution
                # validationSchema: getCollection-responseBody-validationSchema.json
                cookies: []
                headers:
                    -
                        field: Content-Type
                        content: application/json
                mockBody: getCollection-responseBody.json
        testCases:
            -
                name: Get {{cName}}
                description: Successfully retrieves all the {{name}}
                url: {{uriTemplate}}
                template: testGetMethod.js
                request:
                    cookies: []
                    headers:
                        -
                            field : "Accept"
                            content: "application/json"
                        -
                            field: "Accept-Encoding"
                            content: "gzip, deflate"
                response:
                    name: OK
                    statusCode: *OkStatusCode
                    reason: *OkReason
                    cookies: []
                    headers:
                        -
                            field: "Content-Type"
                            content: "application/json"
                    # validationSchema: getCollection-responseBody-validationSchema.json

    POST:
        summary: Create a new instance of {{cName}}
        notes: Create a new instance {{cName}}
        # implementation: api.post{{cName}}
        uriTemplate: {{uriTemplate}}
        request:
            parameters: []
            cookies: []
            headers:
                -
                    field: Accept
                    content: "application/json"
                -
                    field: Accept-Encoding
                    content: "gzip, deflate"
            mockBody: postCollection-requestBody.json
        responses:
            -
                name: OK
                statusCode: *OkStatusCode
                reason: *OkReason
                # validationSchema: postCollection-responseBody-validationSchema.json
                cookies: []
                headers:
                    -
                        field: Content-Type
                        content: application/json
                mockBody: postCollection-responseBody.json
        testCases:
            -
                name: Create one instance of {{cName}}
                description: Succesfully creates a new instance of {{cName}}
                url: {{uriTemplate}}
                template: testPostMethod.js
                request:
                    cookies: []
                    headers:
                        -
                            field : "Accept"
                            content: "application/json"
                        -
                            field: "Accept-Encoding"
                            content: "gzip, deflate"
                    body: postCollection-requestBody.json
                response:
                    name: OK
                    statusCode: *OkStatusCode
                    reason: *OkReason
                    cookies: []
                    headers:
                        -
                            field: "Content-Type"
                            content: "application/json"
                    body: postCollection-responseBody.json
                    # validationSchema: postCollection-responseBody-validationSchema.json
