Skip to content

chore: bump server apiVersion #4112

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

skrobul
Copy link

@skrobul skrobul commented Apr 29, 2025

Overview

Bumps apiVersion so that API clients can correctly discover availability of a certain new API calls.

What this PR does / why we need it

Inline documentation states that apiVersion should be increased every time a new call is added to the API. Unfortunately, this process was not followed in #3598 where GetDiscovery API call was added.
It also was not increased after adding GetClient in #2972.

Inline documentation states that apiVersion should be increased every
time a new call is added to the API. Unfortunately, this process was not
followed in dexidp#3598 where GetDiscovery
API call was added.
It also was not increased after adding GetClient in dexidp#2972.

Signed-off-by: Marek Skrobacki <[email protected]>
Copy link
Member

@nabokihms nabokihms left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It was last time bumbed at 2017...
I'm not sure we need the version bump. Or if we do, we probably need a linter.

If there are clients who wants to know supported API methods, it is better to depend on a Dex version. Another way is to use a semver for the API version instead of the integer (we already have API tags, the latest is v2.3.0).

I think just bumping apiVersion will not bring us benefits we want.
@sagikazarmark wdyt?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants