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

true up migration guide: iface, endpoints, auth, request customization, s3crypto #2431

Merged
merged 4 commits into from
Dec 19, 2023
Merged

true up migration guide: iface, endpoints, auth, request customization, s3crypto #2431

merged 4 commits into from
Dec 19, 2023

Conversation

lucix-aws
Copy link
Contributor

@lucix-aws lucix-aws commented Dec 18, 2023 •
edited
Loading

  • Correct verbage throughout on minimum go version
  • Migration
    • add section for migrating from *iface types e.g. s3iface
    • true up endpoint resolution section w.r.t V2
    • add auth section
    • add section on mapping request customization from request.Request
    • add section on API mappings for s3 encryption client - we link to the crypto tools' own migration guide for more information about migrating materials etc.

isaiahvita
isaiahvita reviewed Dec 18, 2023
View reviewed changes
content/en/docs/migrating/_index.md

#### migrating `Params`

```go
Copy link
Contributor

Choose a reason for hiding this comment

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

has all the following new code examples been actually executed to some extent? i think it would be good to actually see this code successfully execute

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I dropped them into my IDE and found some minor issues which I've corrected. I didn't run them fully, though, they're not meant to be drop-in snippets, more examples of what v1 would look like vs v2.

content/en/docs/migrating/_index.md
| v1 handler name | v2 middleware phase |
| --------------- | ------------------- |
| Validate | Initialize |
| Build | Serialize |
Copy link
Contributor

Choose a reason for hiding this comment

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

does V2's Build not have an equivalent in V1?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

It doesn't, Build and Serialize as we know them in v2 were one thing Build in v1

@lucix-aws lucix-aws changed the title true up migration guide: iface, endpoint resolution, auth, request customization true up migration guide: iface, endpoints, auth, request customization, s3crypto Dec 19, 2023
@lucix-aws lucix-aws linked an issue Dec 19, 2023 that may be closed by this pull request
Missing docs on how to migrate from s3crypto #1636
Closed
@lucix-aws lucix-aws mentioned this pull request Dec 19, 2023
Closed
@lucix-aws lucix-aws merged commit 33023c3 into documentation Dec 19, 2023
1 check passed
@lucix-aws lucix-aws deleted the doc-migrationguide branch December 19, 2023 18:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@isaiahvita isaiahvita isaiahvita left review comments

@wty-Bryant wty-Bryant wty-Bryant approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Missing docs on how to migrate from s3crypto
3 participants
@lucix-aws @isaiahvita @wty-Bryant