Skip to content

SK-2837: Add V2.1 migration guide and README upgrade banner#313

Open
Devesh-Skyflow wants to merge 3 commits into
v1from
devesh/sk-2837
Open

SK-2837: Add V2.1 migration guide and README upgrade banner#313
Devesh-Skyflow wants to merge 3 commits into
v1from
devesh/sk-2837

Conversation

@Devesh-Skyflow
Copy link
Copy Markdown
Collaborator

Adds docs/migrate_to_v2.md covering auth options, client init, request/response structure, error format, and camelCase field name changes for V1 → V2 migration. Adds README banner pointing V1 users to the guide and noting EOL on 2026-10-31.

Start with a concise summary of the PR. The first three sections are required. The questions present in each section is there to help you guide you what to add. They are meant to be overwritten by your comments.

Why

  • Why are you making the change?
  • What is the underlying issue that you are trying to case, in case of fix?
  • Why is it needed by the feature you are working on?
  • What is the intent behind making the change?

Goal

  • What is the intended outcome?
  • What part of the feature should start working?
  • What are the non-goals or will be covered in future PR?

Testing

  • How was the code tested?
  • If you haven't written unit tests, why?
  • What more testing is needed? Do you intend to manually test it after deployment?
  • Do you have any concerns if this changed is released to prod?

Tech debt

  • Is the PR adding to tech debt in any way?
  • Are you addressing some Tech debt in this PR?
  • If both the above are false, feel free to remove this section.

Adds docs/migrate_to_v2.md covering auth options, client init, request/response
structure, error format, and camelCase field name changes for V1 → V2 migration.
Adds README banner pointing V1 users to the guide and noting EOL on 2026-10-31.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@Devesh-Skyflow Devesh-Skyflow changed the base branch from main to v1 May 20, 2026 14:04
Devesh-Skyflow and others added 2 commits May 22, 2026 13:02
Add sections for UpdateRequest skyflowId preference, updateLogLevel
and getBYOT deprecations.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
…names table

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant