Skip to content

Finalise API v3#3122

Merged
pcapriotti merged 8 commits intodevelopfrom
pcapriotti/finalise-v3
Mar 6, 2023
Merged

Finalise API v3#3122
pcapriotti merged 8 commits intodevelopfrom
pcapriotti/finalise-v3

Conversation

@pcapriotti
Copy link
Contributor

@pcapriotti pcapriotti commented Mar 3, 2023

This finalises API v3, makes it supported, and introduces a new development API v4. All the new MLS endpoints have been removed from v3 and moved to v4.

Checklist

  • Add a new entry in an appropriate subdirectory of changelog.d
  • Read and follow the PR guidelines

@zebot zebot added the ok-to-test Approved for running tests in CI, overrides not-ok-to-test if both labels exist label Mar 3, 2023
Copy link
Contributor

@mdimjasevic mdimjasevic left a comment

Choose a reason for hiding this comment

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

Great!

I also browsed around in wire-api to see if there are any more endpoints that should be moved to V4, but I couldn't find any.

:shipit:

element 2 V2,
element 3 V3
element 3 V3,
element 4 V4
Copy link
Contributor

Choose a reason for hiding this comment

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

Recently we've had that discussion about using versions in endpoint paths and how we missed a bug because we were not testing what versions get converted to when made a path component. Do you want to add a test for it in Test.Wire.API.Routes.Version?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

What test do you mean?

Copy link
Contributor

Choose a reason for hiding this comment

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

In Test.Wire.API.Routes.Version I'd extend the test like so:

testToPathComponent :: Assertion
testToPathComponent = do
  "v0" @=? toPathComponent V0
  "v1" @=? toPathComponent V1
  "v2" @=? toPathComponent V2
  "v3" @=? toPathComponent V3
  "v4" @=? toPathComponent V4

Copy link
Contributor

@mdimjasevic mdimjasevic left a comment

Choose a reason for hiding this comment

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

Hey, make V4 a development version!

@mdimjasevic
Copy link
Contributor

Hey, make V4 a development version!

Sorry, I clicked approve, then I realized that developmentVersions needs an update in Wire.API.Routes.Version. Right?

@smatting smatting self-requested a review March 3, 2023 13:53
@pcapriotti
Copy link
Contributor Author

Hey, make V4 a development version!

Sorry, I clicked approve, then I realized that developmentVersions needs an update in Wire.API.Routes.Version. Right?

Ah, right, thanks for catching this.

@pcapriotti pcapriotti force-pushed the pcapriotti/finalise-v3 branch from d4d6ae4 to 6ed46a5 Compare March 6, 2023 09:38
@pcapriotti pcapriotti merged commit dc7a4ef into develop Mar 6, 2023
@pcapriotti pcapriotti deleted the pcapriotti/finalise-v3 branch March 6, 2023 10:58
lepsa pushed a commit to lepsa/wire-server that referenced this pull request Nov 28, 2023
* Add pregenerated v3 swagger

* Finalise API v3

* Use v2 for welcome messages in tests

* Add CHANGELOG entry

* Set v4 as the development version

* Update golden tests

* Add assertion for v4 to version test

* Use v2 welcome in end2end tests
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ok-to-test Approved for running tests in CI, overrides not-ok-to-test if both labels exist

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants

Comments