Skip to content

Commit

Permalink
docs(apigateway): change "full working example" link to embed example (
Browse files Browse the repository at this point in the history
…aws#11384)

The relative link given for the "full working example" works fine here on GitHub, but not when this is compiled into one of the API references.

Change the link to be a complete URL so it works from anywhere this content ends up.


----

*By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
  • Loading branch information
Jerry Kindall authored Nov 19, 2020
1 parent 2fadf12 commit e8a8c1c
Show file tree
Hide file tree
Showing 5 changed files with 8 additions and 4 deletions.
8 changes: 6 additions & 2 deletions packages/@aws-cdk/aws-apigateway/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -524,7 +524,9 @@ books.addMethod('GET', new apigateway.HttpIntegration('http://amazon.com'), {
});
```

You can find a full working example [here](test/authorizers/integ.token-authorizer.ts).
A full working example is shown below.

[Full token authorizer example](test/authorizers/integ.token-authorizer.lit.ts).

By default, the `TokenAuthorizer` looks for the authorization token in the request header with the key 'Authorization'. This can,
however, be modified by changing the `identitySource` property.
Expand Down Expand Up @@ -565,7 +567,9 @@ books.addMethod('GET', new apigateway.HttpIntegration('http://amazon.com'), {
});
```

You can find a full working example [here](test/authorizers/integ.request-authorizer.ts).
A full working example is shown below.

[Full request authorizer example](test/authorizers/integ.request-authorizer.lit.ts).

By default, the `RequestAuthorizer` does not pass any kind of information from the request. This can,
however, be modified by changing the `identitySource` property, and is required when specifying a value for caching.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -313,4 +313,4 @@
}
}
}
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -313,4 +313,4 @@
}
}
}
}
}

0 comments on commit e8a8c1c

Please sign in to comment.