Cannot handle nested RAML

[ghost]

Is there any way we can use this library to generate nested RAML like below

get:
  description: >
    Get account details
  responses:
    200:
      description: >
        Account Data
      body:
        application/json:
          example: !include ../examples/accounts.json

[rscheumann]

This library lacks support of the responses at the moment. I need this feature too and I will have a look into it.

[rscheumann]

I just added a first support for responses.

At file level add these annotations:

 * @\raml\annotations\ResponseScheme(name="interpretation-result", url="https://api.karmap.com/patterns/v1/schema-interpretation-result.json")
 * @\raml\annotations\ResponseScheme(name="interpretation-result-example", url="https://api.karmap.com/patterns/v1/schema-interpretation-result-example.json")

At method level add these annotation (you may add multiple response annotations):

     * @\raml\annotations\Response(
     *   statusCode="200",
     *   description="successfully calculated interpretation",
     *   contentType="application/json",
     *   schema="interpretation-result",
     *   example="interpretation-result-example"
     * )

Example:

<?php

/**
 * @\raml\annotations\Title(title="Karmap Core API")
 * @\raml\annotations\Version(version="v1")
 * @\raml\annotations\BaseUri(baseUri="https://api.core.karmap.com/{version}")
 * @\raml\annotations\MediaType(mediaType="application/json")
 * @\raml\annotations\Protocol(protocol="HTTPS")
 * @\raml\annotations\SecurityScheme(name="basic", type="Basic Authentication")
 * @\raml\annotations\ResponseScheme(name="interpretation-result", url="https://api.karmap.com/patterns/v1/schema-interpretation-result.json")
 * @\raml\annotations\ResponseScheme(name="interpretation-result-example", url="https://api.karmap.com/patterns/v1/schema-interpretation-result-example.json")
 */

/**
 * Class RamlAnnotatedClass
 */
class RamlAnnotatedClassWithResponse
{
    /**
     * Process request.
     *
     * @\raml\annotations\HttpVerb(verb="POST")
     * @\raml\annotations\Resource(resource="/anonymousInterpretationsWithResponse")
     * @\raml\annotations\Description(description="Create anonymous interpretation")
     * @\raml\annotations\SecuredBy(scheme="basic")
     * @\raml\annotations\Parameter(
     *   parameterType="form",
     *   name="clientCode",
     *   displayName="Client code",
     *   description="Code identifying the client",
     *   type="string",
     *   pattern="^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$",
     *   required="true",
     *   example="7e2c20d3-6500-497c-83f1-76c64de3bb02"
     * )
     * @\raml\annotations\Parameter(
     *   parameterType="form",
     *   name="personBirthdate",
     *   displayName="Person birthday",
     *   description="A person's birthdate in the form ""YYYY-MM-DD HH:mm:ss"".",
     *   type="string",
     *   pattern="^[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}-[0-9]{2}-[0-9]{2}$",
     *   required="true",
     *   example="1979-06-19 11:17:00"
     * )
     * @\raml\annotations\Response(
     *   statusCode="200",
     *   description="successfully calculated interpretation",
     *   contentType="application/json",
     *   schema="interpretation-result",
     *   example="interpretation-result-example"
     * )
     */
    public function process()
    {

    }
}

The resulting RAML document looks like this:

#%RAML 0.8
title: Karmap Core API
version: v1
baseUri: https://api.core.karmap.com/{version}
protocols: [HTTPS]
securitySchemes:
  - basic:
      type: Basic Authentication

/anonymousInterpretationsWithResponse:
  post:
    description: Create anonymous interpretation
    securedBy: [basic]
    body:
      application/x-www-form-urlencoded:
        formParameter:
          clientCode:
            displayName: Client code
            description: Code identifying the client
            type: string
            pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
            required: true
            example: 7e2c20d3-6500-497c-83f1-76c64de3bb02
          personBirthdate:
            displayName: Person birthday
            description: A person's birthdate in the form "YYYY-MM-DD HH:mm:ss".
            type: string
            pattern: ^[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}-[0-9]{2}-[0-9]{2}$
            required: true
            example: 1979-06-19 11:17:00
    responses:
      200
        description: successfully calculated interpretation
        body:
          application/json
            schema: !include https://api.karmap.com/patterns/v1/schema-interpretation-result.json
            example: !include https://api.karmap.com/patterns/v1/schema-interpretation-result-example.json

Thanks for feedback.