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

API versioning #1622

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

API versioning #1622

wants to merge 1 commit into from

Conversation

rixx
Copy link
Member

@rixx rixx commented Nov 13, 2023

This PR is part of #1598 and introduces versioned API capabilities to pretalx, while making sure that nothing will change for users of the current and next release.

  • New auth tokens
    • Implement token model
      • token should have only read-only vs read-write permissions for now
      • possibly optional event limit?
    • migrate existing tokens
    • UI for token management: create, delete. no modifying permissions after the fact, I think
    • Get API version from token / set API version on token on first use if no version is set, set to CURRENT
  • Serializer versioning
    • Get serializers based on API version
    • Get API version from request (by header), but only allow LEGACY and DEV for now, make clear what needs to change later
    • Test: errors
    • Add method for logging of use of deprecated endpoints (disable for now)
    • Add method for warning users when using deprecated endpoints (disable for now)
    • Document API versioning in writable-api-wip branch (otherwise people reading the docs would think the feature is ready for prod …)

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