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

Polaris management API spec improvements #779

Open
snazy opened this issue Jan 15, 2025 · 0 comments
Open

Polaris management API spec improvements #779

snazy opened this issue Jan 15, 2025 · 0 comments
Labels
bug Something isn't working

Comments

@snazy
Copy link
Member

snazy commented Jan 15, 2025

Describe the bug

The current Polaris management spec has a few shortcomings:

I propose a complete overhaul of that API, as a v2 and eventually remove v1 before 1.0:

  • Enable pagination of list requests using opaque paging-tokens
  • Have a data model built on actual, distinct properties instead of generic property bags. This helps users to reason about individual properties and also helps to not accidentally exposing sensitive information.
  • Have specific update requests (or update request payloads) for each kind of change instead of sending the whole entity and update everything. This is much easier to reason about from the client side and also much easier to verify & validate on the server side.

To Reproduce

No response

Actual Behavior

No response

Expected Behavior

No response

Additional context

No response

System information

No response

@snazy snazy added the bug Something isn't working label Jan 15, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

1 participant