feat(apigateway): access parent api resolver from router

[to-mc]

Issue #, if available: #834

Description of changes:

Enable access to parent api resolver class from child router classes. Example:

app.py

...
app = ApiGatewayResolver()
app.include_router(users.router, prefix="/users") # prefix 

def lambda_handler(event: Dict, context: LambdaContext):
    return app.resolve(event, context)

users.py

...

router = Router()

@router.get("/users/")
def get_users() -> Dict:
    router.api_resolver.custom_functionality()
    return {"message": "success"}

Checklist

• Meet tenets criteria
• Update tests
• Update docs
• PR title follows conventional commit semantics

Breaking change checklist

RFC issue #:

• Migration process documented
• Implement warnings (if it can live side by side)

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

[codecov-commenter]

Codecov Report

Merging #842 (a95ca0b) into develop (fe2cf13) will increase coverage by 0.00%.
The diff coverage is 100.00%.

@@           Coverage Diff            @@
##           develop     #842   +/-   ##
========================================
  Coverage    99.90%   99.90%           
========================================
  Files          118      118           
  Lines         5108     5110    +2     
  Branches       280      280           
========================================
+ Hits          5103     5105    +2     
  Misses           2        2           
  Partials         3        3           

Impacted Files	Coverage Δ
aws_lambda_powertools/event_handler/api_gateway.py	100.00% <100.00%> (ø)

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update fe2cf13...a95ca0b. Read the comment docs.

[heitorlessa]

Should we add a note in the docs? E.g. subclassing ApiGatewayResolver etc

…

On Mon, 22 Nov 2021 at 09:15, Tom McCarthy ***@***.***> wrote: @cakepietoast <https://github.com/cakepietoast> requested your review on: #842 <#842> feat: access api resolver from router. — You are receiving this because your review was requested. Reply to this email directly, view it on GitHub <#842 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAZPQBHAFHTNET5HSCMRX4DUNH327ANCNFSM5IQKXQYA> .

[to-mc]

Should we add a note in the docs? E.g. subclassing ApiGatewayResolver etc

I think if we add documentation here it needs to be a more widely scoped section explaining how and why you might want to subclass ApiGatewayResolver, as opposed to just the particular detail this PR implements. I'd like to try and understand how common this is, and what some of the use cases are, before expanding on the docs there.

[heitorlessa]

Agree - that’s what I meant by whether it should be in the docs (explained with an example). LGTM

…

On Wed, 24 Nov 2021 at 10:20, Tom McCarthy ***@***.***> wrote: Should we add a note in the docs? E.g. subclassing ApiGatewayResolver etc I think if we add documentation here it needs to be a more widely scoped section explaining how and why you might want to subclass ApiGatewayResolver, as opposed to just the particular detail this PR implements. I'd like to try and understand how common this is, and what some of the use cases are, before expanding on the docs there. — You are receiving this because your review was requested. Reply to this email directly, view it on GitHub <#842 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAZPQBATJ3NKP5P6QWNBJB3UNSU7BANCNFSM5IQKXQYA> .