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

(aws_apigateway): Broken link in v2 docs for Lambda-based request authorizer #18984

Closed
niklaswallerstedt opened this issue Feb 16, 2022 · 1 comment · Fixed by #21792
Closed

(aws_apigateway): Broken link in v2 docs for Lambda-based request authorizer #18984

niklaswallerstedt opened this issue Feb 16, 2022 · 1 comment · Fixed by #21792
Labels
@aws-cdk/aws-apigateway Related to Amazon API Gateway bug This issue is a bug. docs/generated Related to the generated API Reference documentation documentation This is a problem with documentation. effort/small Small work item – less than a day of effort p1

Comments

@niklaswallerstedt
Copy link
Contributor

link to reference doc page

https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_apigateway-readme.html#lambda-based-request-authorizer

Describe your issue?

In the docs there is a link that is broken.

A full working example is shown below.

Full request authorizer example.
@niklaswallerstedt niklaswallerstedt added documentation This is a problem with documentation. feature-request A feature should be added or improved. needs-triage This issue or PR still needs to be triaged. labels Feb 16, 2022
@github-actions github-actions bot added the @aws-cdk/aws-apigateway Related to Amazon API Gateway label Feb 16, 2022
@peterwoodworth peterwoodworth added bug This issue is a bug. docs/generated Related to the generated API Reference documentation p1 and removed feature-request A feature should be added or improved. needs-triage This issue or PR still needs to be triaged. labels Feb 16, 2022
@peterwoodworth peterwoodworth added the effort/small Small work item – less than a day of effort label Feb 16, 2022
@yamatatsu yamatatsu mentioned this issue Aug 28, 2022
Merged
4 tasks
@mergify mergify bot closed this as completed in #21792 Aug 29, 2022
mergify bot pushed a commit that referenced this issue Aug 29, 2022
@yamatatsu
chore: remove obsoleted pragma pragma:ignore-assets (#21792)
e86ae92 
This PR remove all `pragma:ignore-assets` pragma. `pragma:ignore-assets` was obsoleted at #17592.

fix: #18984
As said in this issue, this pragma has been displayed in the documentation as following:

<img width="998" alt="image" src="https://user-images.githubusercontent.com/11013683/187058745-efffaf49-f51c-4a2d-988f-c9c798082aaa.png">

----

### All Submissions:

* [x] Have you followed the guidelines in our [Contributing guide?](https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md)

### Adding new Unconventional Dependencies:

* [ ] This PR adds new unconventional dependencies following the process described [here](https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md/#adding-new-unconventional-dependencies)

### New Features

* [ ] Have you added the new feature to an [integration test](https://github.com/aws/aws-cdk/blob/main/INTEGRATION_TESTS.md)?
	* [ ] Did you use `yarn integ` to deploy the infrastructure and generate the snapshot (i.e. `yarn integ` without `--dry-run`)?

*By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
@github-actions
Copy link

⚠️COMMENT VISIBILITY WARNING⚠️

Comments on closed issues are hard for our team to see.
If you need more assistance, please either tag a team member or open a new issue that references this one.
If you wish to keep having a conversation with other community members under this issue feel free to do so.

josephedward pushed a commit to josephedward/aws-cdk that referenced this issue Aug 30, 2022
@yamatatsu @josephedward
chore: remove obsoleted pragma pragma:ignore-assets (aws#21792)
1134609 
This PR remove all `pragma:ignore-assets` pragma. `pragma:ignore-assets` was obsoleted at aws#17592.

fix: aws#18984
As said in this issue, this pragma has been displayed in the documentation as following:

<img width="998" alt="image" src="https://user-images.githubusercontent.com/11013683/187058745-efffaf49-f51c-4a2d-988f-c9c798082aaa.png">

----

### All Submissions:

* [x] Have you followed the guidelines in our [Contributing guide?](https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md)

### Adding new Unconventional Dependencies:

* [ ] This PR adds new unconventional dependencies following the process described [here](https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md/#adding-new-unconventional-dependencies)

### New Features

* [ ] Have you added the new feature to an [integration test](https://github.com/aws/aws-cdk/blob/main/INTEGRATION_TESTS.md)?
	* [ ] Did you use `yarn integ` to deploy the infrastructure and generate the snapshot (i.e. `yarn integ` without `--dry-run`)?

*By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
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 bug This issue is a bug. docs/generated Related to the generated API Reference documentation documentation This is a problem with documentation. effort/small Small work item – less than a day of effort p1
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

chore: remove obsoleted pragma pragma:ignore-assets yamatatsu/aws-cdk
3 participants
@otaviomacedo @niklaswallerstedt @peterwoodworth