search

aws / serverless-application-model

The AWS Serverless Application Model (AWS SAM) transform is a AWS CloudFormation macro that transforms SAM templates into CloudFormation templates.
https://aws.amazon.com/serverless/sam
Apache License 2.0
9.29k stars 2.38k forks source link

Feature Request: AWS::ApiGateway::DocumentationVersion #747

Open schabert opened 5 years ago

schabert commented 5 years ago

Hi, at the moment its not possible to auto publish API Gateway Documentation that is define e.g. via inline Swagger.

Its also not possible to specify the DocumentationVersion at the stage.

  ApiDocumentation:
    Type: AWS::ApiGateway::DocumentationVersion
    Properties:
      DocumentationVersion: $hash_of_template
      RestApiId: !Ref ExternalApi

  Stage:
    Type: AWS::ApiGateway::Stage
    Properties:
      DeploymentId: !Ref Deployment
      DocumentationVersion: !Ref ApiDocumentation
      RestApiId: !Ref RestApi
      StageName: !Ref stageName
keetonian commented 5 years ago

SAM could probably do more than this for documentation; it could possibly allow users to document their API inline inside the SAM template. This is something that could be good for SAM to do

mvanbaak commented 4 years ago

@schabert @keetonian Any known workaround/method to actually deploy the documentation, other then logging into the console and publish it?

cappaberra commented 4 years ago

I am interested in seeing this functionality in SAM, as well. Thanks! 👍