Skip to content

Conversation

@c-julin
Copy link
Contributor

@c-julin c-julin commented Dec 3, 2025

Summary

Migrates the shadowlink API from v1alpha3 to v1 while maintaining backward compatibility. The v1 API includes PREVIEW visibility restrictions and cloud-compatible endpoint paths.

Key Changes

  • Proto Definition: Add shadowlink.proto to dataplane/v1 with PREVIEW visibility restriction
  • HTTP Endpoints: Update paths to cloud-compatible format (/v1/shadow-links/* with hyphen)
  • Frontend Migration: Update all frontend imports and components to use v1 API
  • Backward Compatibility: Both v1alpha3 and v1 APIs coexist; v1alpha3 remains unchanged
  • Lint Configuration: Add buf:lint:ignore directives for shared FailOverRequest type

Technical Details

  • The v1 service uses google.api.api_visibility with PREVIEW restriction
  • Both v1 and v1alpha3 share core.admin.v2.FailOverRequest type (lint exceptions added)
  • Frontend TypeScript types generated for v1 API
  • 14 frontend files updated with new v1 imports
  • OpenAPI specs regenerated to include v1 endpoints

Breaking Changes

None - this is purely additive. Existing v1alpha3 API remains functional.

- Add shadowlink.proto to dataplane/v1 (keeping v1alpha3 unchanged)
- Update HTTP endpoints to /v1/shadow-links/* (cloud-compatible paths)
- Add google.api.api_visibility PREVIEW restriction to v1 service
- Generate protobuf files for backend (Go)
- Update OpenAPI specs to include v1 endpoints
- Frontend continues using v1alpha3 for now
@github-actions
Copy link

github-actions bot commented Dec 3, 2025

The latest Buf updates on your PR. Results from workflow Buf CI / validate (pull_request).

BuildFormatLintBreakingUpdated (UTC)
✅ passed✅ passed✅ passed✅ passedDec 3, 2025, 3:36 PM

- Add PREVIEW visibility annotation to v1 shadowlink API
- Create v1-specific FailOverRequest message to avoid protobuf conflicts
- Generate backend protobuf files for v1 API
- Both v1alpha3 and v1 APIs coexist for backward compatibility
- Frontend continues to use v1alpha3
@c-julin c-julin force-pushed the feat/move-shadowlink-to-v1 branch from d2d513e to b8db1f6 Compare December 3, 2025 15:36
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.

4 participants