[Proposal] Model generate command line option

[stealthycoin]

Introduction

Proposal for #36

Proposed Interface

A new top level command chalice generate-models which will print out a model of the API to stdout.

The format of the models will be OpenAPI, in the future a --format flag can be added to support multiple formats.

Example

(chalice) ➜  tmp chalice new-project testproject
(chalice) ➜  tmp cd testproject
(chalice) ➜  testproject chalice generate-models
{
    "swagger": "2.0",
    "info": {
        "version": "1.0",
        "title": "testproject"
    },
    "schemes": [
        "https"
    ],
    "paths": {
        "/": {
            "get": {
                "consumes": [
                    "application/json"
                ],
                "produces": [
                    "application/json"
                ],
                "responses": {
                    "200": {
                        "description": "200 response",
                        "schema": {
                            "$ref": "#/definitions/Empty"
                        }
                    }
                },
                "x-amazon-apigateway-integration": {
                    "responses": {
                        "default": {
                            "statusCode": "200"
                        }
                    },
                    "uri": "arn:aws:apigateway:{region_name}:lambda:path/2015-03-31/functions/{api_handler_lambda_arn}/invocations",
                    "passthroughBehavior": "when_no_match",
                    "httpMethod": "POST",
                    "contentHandling": "CONVERT_TO_TEXT",
                    "type": "aws_proxy"
                }
            }
        }
    },
    "definitions": {
        "Empty": {
            "type": "object",
            "title": "Empty Schema"
        }
    },
    "x-amazon-apigateway-binary-media-types": [
        "application/octet-stream",
        "application/x-tar",
        "application/zip",
        "audio/basic",
        "audio/ogg",
        "audio/mp4",
        "audio/mpeg",
        "audio/wav",
        "audio/webm",
        "image/png",
        "image/jpg",
        "image/jpeg",
        "image/gif",
        "video/ogg",
        "video/mpeg",
        "video/webm"
    ]
}

[jamesls]

I think this would be good to add, especially as we add support for modeling inputs/outputs.

Looking over our chalice CLI commands, we're not consistent with what we have now, but we should try to not make it any more inconsistent:

Commands:
  delete
  deploy
  gen-policy
  generate-pipeline  Generate a cloudformation template for a...
  generate-sdk
  invoke             Invoke the deployed lambda function NAME.
  local
  logs
  new-project
  package
  url

I hate to bikeshed over this, but it seems like we should stick to gen-models or generate-models.

[stealthycoin]

Updated for bikeshed. PR as well.

[stealthycoin]

Closing since the PR was merged.

[MartijnHarmenzon]

Is there any documentation for this generate-models functionality?