Skip to content

WPB-6012 create new API version v6 #3815

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.

Sign up for GitHub

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

Merged
battermann merged 6 commits into from
Jan 18, 2024
Merged

WPB-6012 create new API version v6 #3815

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
6d4013d
wip
battermann Jan 16, 2024
fc0cebb
Pregenerate swagger-v5.json
Jan 17, 2024
718f8d2
change api version in integration tests
battermann Jan 17, 2024
a523bb4
changelog
battermann Jan 17, 2024
257cf4e
fix integration test
battermann Jan 18, 2024
9dba9d8
moved swagger tests
battermann Jan 18, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions changelog.d/1-api-changes/WPB-6012
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Create new API version V6 and finalize V5
2 changes: 1 addition & 1 deletion integration/test/Testlib/Env.hs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ mkGlobalEnv cfgFile = do
gDomain1 = intConfig.backendOne.originDomain,
gDomain2 = intConfig.backendTwo.originDomain,
gDynamicDomains = (.domain) <$> Map.elems intConfig.dynamicBackends,
gDefaultAPIVersion = 5,
gDefaultAPIVersion = 6,

@mdimjasevic mdimjasevic Jan 18, 2024

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

A good catch! How did you find it? By running tests or by some other means? Let's add this to the version bump checklist!

@battermann battermann Jan 18, 2024

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

I looked at the previous PR for finalizing V4.

gManager = manager,
gServicesCwdBase = devEnvProjectRoot <&> (</> "services"),
gRemovalKeyPath = error "Uninitialised removal key path",
Expand Down
4 changes: 3 additions & 1 deletion libs/wire-api/src/Wire/API/Routes/Version.hs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ import Wire.Arbitrary (Arbitrary, GenericUniform (GenericUniform))
-- and 'developmentVersions' stay in sync; everything else here should keep working without
-- change. See also documentation in the *docs* directory.
-- https://docs.wire.com/developer/developer/api-versioning.html#version-bump-checklist
data Version = V0 | V1 | V2 | V3 | V4 | V5
data Version = V0 | V1 | V2 | V3 | V4 | V5 | V6
deriving stock (Eq, Ord, Bounded, Enum, Show, Generic)
deriving (FromJSON, ToJSON) via (Schema Version)
deriving (Arbitrary) via (GenericUniform Version)
Expand All @@ -94,6 +94,7 @@ versionInt V2 = 2
versionInt V3 = 3
versionInt V4 = 4
versionInt V5 = 5
versionInt V6 = 6

supportedVersions :: [Version]
supportedVersions = [minBound .. maxBound]
Expand Down Expand Up @@ -197,6 +198,7 @@ isDevelopmentVersion V1 = False
isDevelopmentVersion V2 = False
isDevelopmentVersion V3 = False
isDevelopmentVersion V4 = False
isDevelopmentVersion V5 = False
isDevelopmentVersion _ = True

developmentVersions :: [Version]
Expand Down
Loading