andrewcurioso / raml-serverless

Work with RAML documentation for Serverless v1.0 projects

Hi there 👋, my name is Andrew

I'm a technologist, software engineer, writer, and architect. I wear a lot of hats.

raml-serverless's Issues

Cannot read property 'split' of undefined

Getting the following error:

$ sls raml
 
  Type Error ---------------------------------------------
 
  Cannot read property 'split' of undefined

Reproduce:

1. Install npm install --save raml-serverless
2. Add raml-serverless to your serverless.yml

$ git diff serverless.yml
 plugins:
   - serverless-python-requirements
+  - raml-serverless

3. sls raml > docs.raml

Node version: v6.10.1
Serverless version 1.18.0

Put all unrecognized properties under "custom"

If a RAML property cannot be understood it should be put under custom so that if a RAML file is generated from the serverless.yml file later, it will have the same properties.

Example:

custom:
  documentation:
    raml:
      title: My Awesome API

Unit tests

Write unit tests.

Initial project

Automatically add specification for Lambda integrations

Automatically add headers and response codes for methods with direct Lambda integrations.

Example: https://serverless.com/framework/docs/providers/aws/events/apigateway#enabling-cors-with-the-lambda-integration-method

Brilliant! Is this project still alive?

Hi. This seems to look like a very cool project. Are you still working on it?

Populate baseUri

Populate baseUri automatically with the root endpoint of the API gateway deployment.

How do you document a URI parameter?

RAML has a mechanism to document URI parameters for a call. I can not figure out how to put this documentation into the server.yml file in such a way that it will show up in the correct spot in the output RAML file. Am I missing something, or does raml-serverless not yet support this?

In the RAML file, the uriParameters: tag should be between the path and the HTTP action. However, by the time we are specifying the "documentation:\n raml:" tag in our server.yml file, we are already specifying information related to the method itself.

If raml-serverless can't do this then please consider this a feature request.

Automatically add API key header to private methods

Automatically add the API key header (x-api-key) to private methods.

Documentation: https://serverless.com/framework/docs/providers/aws/events/apigateway#setting-api-keys-for-your-rest-api

Automatically add CORs headers to documentation if function has CORs

If the function has cors configured on it, the documentation should contain the appropriate headers.

Generate serverless HTTP event from RAML

Take a RAML file as input and generate a Serverless HTTP events for every endpoint in the RAML. For now they can all be under a single function and the user can split it up as necessary.

This includes putting all properties that don't directly translate into Serverless under the documentation: raml: section of the HTTP event.