Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

RestAPI - support DocumentationPart and DocumentationVersion #6057

Closed
jamesknowsbest opened this issue Feb 1, 2020 · 4 comments
Closed

RestAPI - support DocumentationPart and DocumentationVersion #6057

jamesknowsbest opened this issue Feb 1, 2020 · 4 comments
Labels
@aws-cdk/aws-apigateway Related to Amazon API Gateway closed-for-staleness This issue was automatically closed because it hadn't received any attention in a while. effort/medium Medium work item – several days of effort feature-request A feature should be added or improved. p2

Comments

@jamesknowsbest
Copy link

The Question

Is it possible to extend the API Gateway rest api object to allow for the stage to be appended with a documentation version?

Source: https://stackoverflow.com/questions/60009052/how-to-document-rest-api-using-aws-cdk

Environment

  • CDK CLI Version:
cdk --version
1.22.0 (build 309ac1b)
  • Module Version:
  • OS: all
  • Language: all | TypeScript
@SomayaB SomayaB added guidance Question that needs advice or information. @aws-cdk/aws-apigateway Related to Amazon API Gateway labels Feb 4, 2020
@nija-at
Copy link
Contributor

nija-at commented Feb 12, 2020

Thanks @jamesknowsbest for filing this issue.

We currently don't support APIGateway's Documentation feature in the CDK. Your specific request will be serviced as part of our implementation for that.

I'm re-purposing this as a feature request for the CDK to support DocumentationPart and DocumentationVersion.

@nija-at nija-at changed the title Add ability to append default stage with documentation version RestAPI - support DocumentationPart and DocumentationVersion Feb 12, 2020
@nija-at nija-at added feature-request A feature should be added or improved. effort/medium Medium work item – several days of effort and removed guidance Question that needs advice or information. labels Feb 12, 2020
@nija-at nija-at mentioned this issue Feb 12, 2020
Closed
12 tasks
@nija-at nija-at added the p2 label Aug 18, 2020
@eladb
Copy link
Contributor

eladb commented May 11, 2021

It should be possible to use CDK escape hatches in order to use this feature even before we have official support.

@github-actions
Copy link

This issue has not received any attention in 1 year. If you want to keep this issue open, please leave a comment below and auto-close will be canceled.

@github-actions github-actions bot added closing-soon This issue will automatically close in 4 days unless further comments are made. closed-for-staleness This issue was automatically closed because it hadn't received any attention in a while. and removed closing-soon This issue will automatically close in 4 days unless further comments are made. labels Jun 17, 2022
@sdpoueme
Copy link

sdpoueme commented Nov 2, 2022

Hi team, do we have an update on this issue ?

@bmckinle bmckinle mentioned this issue Nov 7, 2022
Open
2 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
@aws-cdk/aws-apigateway Related to Amazon API Gateway closed-for-staleness This issue was automatically closed because it hadn't received any attention in a while. effort/medium Medium work item – several days of effort feature-request A feature should be added or improved. p2
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
5 participants
@eladb @sdpoueme @nija-at @SomayaB @jamesknowsbest