Feature Request: AWS::ApiGateway::DocumentationVersion

[schabert]

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]

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]

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

[cappaberra]

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