Add Detect API v1-to-v2 migration guidance to call-rest-apis skill - #23
Merged
Conversation
Add a "Migrating from v1 to v2" section to detect-api.md covering the endpoint mapping, the configuration-based request model, camelCase field renames, flattened file inputs, enum/casing changes, response shape differences, a before/after example, and a migration checklist. Link to it from SKILL.md. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01TXQaHgcqTYu8QxzsMbPywb
There was a problem hiding this comment.
Pull request overview
Adds a dedicated migration reference for users moving from Skyflow Detect API v1 to v2 within the existing call-rest-apis skill documentation, so consumers don’t need to diff the two version sections manually.
Changes:
- Added a new “Migrating from v1 to v2” section to the Detect API guide, including endpoint mapping, field/shape changes, and a checklist.
- Added a callout in
SKILL.mdthat links directly to the new migration section for discoverability.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| skyflow-skills-plugin/skills/call-rest-apis/SKILL.md | Adds a callout linking to the Detect API v1→v2 migration section. |
| skyflow-skills-plugin/skills/call-rest-apis/detect-api.md | Introduces a new v1→v2 migration section with mappings, examples, and checklist. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Follow-up to the v2 Detect API docs (#20). Adds a dedicated "Migrating from v1 to v2" section to the
call-rest-apisskill so users moving off v1 have a single mapping reference instead of diffing the v1 and v2 sections themselves.Kept inside the existing skill (not a separate skill) so v1, v2, and the migration guide stay discoverable together — the migration content is inherently a mapping between the two versions the skill already documents.
Changes
detect-api.md— New# Migrating from v1 to v2section covering:POST /v2/detect/deidentify/file.configurationId/ inlineconfiguration),camelCasefields, flattened file inputs (dataSource/value/dataFormat), uppercase enums (andefs_path→PRESIGNED_URL), the newmetricsobject.snake_case→camelCase) plus response shape changes (re-identify string field rename, re-identify fileoutputobject → array, uppercase processed-file types).SKILL.md— Added a callout linking to the migration section.Notes
detect.openapi.json.🤖 Generated with Claude Code
https://claude.ai/code/session_01TXQaHgcqTYu8QxzsMbPywb
Generated by Claude Code