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.

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

Add middleware documentation #1844

Merged
merged 12 commits into from
Oct 25, 2022
Merged

Add middleware documentation #1844

merged 12 commits into from
Oct 25, 2022

Conversation

hlbarber
Copy link
Contributor

@hlbarber hlbarber commented Oct 12, 2022

Motivation and Context

There is currently no description on where and how a customer can apply Layer.

Description

Rendered

Add a middleware.md document.

Notes

This describes the new service builder API and therefore will remain hidden until its official release.

@hlbarber hlbarber requested review from a team as code owners October 12, 2022 15:05
@hlbarber hlbarber added documentation Improvements or additions to documentation server Rust server SDK needs-server-review labels Oct 12, 2022
@github-actions
Copy link

A new generated diff is ready to view.

A new doc preview is ready to view.

@smithy-lang smithy-lang deleted a comment from github-actions bot Oct 12, 2022
@smithy-lang smithy-lang deleted a comment from github-actions bot Oct 12, 2022
@github-actions
Copy link

A new generated diff is ready to view.

A new doc preview is ready to view.

design/src/server/middleware.md Outdated Show resolved Hide resolved
design/src/server/middleware.md Outdated Show resolved Hide resolved

where `UpgradeLayer` is the `Layer` converting Smithy model structures to HTTP structures and the `RoutingService` is responsible for routing requests to the appropriate operation.

### A) Outer Middleware
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

While I understand it, I believe the difference between A) and B) is not clear in the doc.

Copy link
Contributor Author

@hlbarber hlbarber Oct 13, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hows this?
debae27

@github-actions
Copy link

A new generated diff is ready to view.

A new doc preview is ready to view.

@github-actions
Copy link

A new generated diff is ready to view.

A new doc preview is ready to view.

@smithy-lang smithy-lang deleted a comment from github-actions bot Oct 25, 2022
@hlbarber hlbarber enabled auto-merge (squash) October 25, 2022 11:50
@github-actions
Copy link

A new generated diff is ready to view.

A new doc preview is ready to view.

@hlbarber hlbarber merged commit c18b1a0 into main Oct 25, 2022
@hlbarber hlbarber deleted the harryb/middleware-docs branch October 25, 2022 12:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation server Rust server SDK
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants