You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/src/developer/developer/api-versioning.md
+14-9Lines changed: 14 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -107,15 +107,20 @@ non-overlapping version ranges.
107
107
108
108
When making the client API version bump, i.e., when finalising a version, there
109
109
are several steps to make apart from deciding what endpoint changes are part of
110
-
the version:
111
-
112
-
- In `wire-api` extend the `Version` type with a new version by appending the
113
-
new version to the end, e.g., by adding `V6`.
114
-
- In the same `Version` module update the `developmentVersions` value to list
115
-
only the new version,
116
-
- Consider updating the `backendApiVersion` value in Stern, which is
117
-
unit-tested by checking if it is listed as supported in the response to `GET
118
-
/api-version`.
110
+
the version. In these example we assume that version `V6` should be finalized and `V7` should be created:
111
+
112
+
- Run wire-server and download the `swagger.json` of the current development version, e.g. with the following command: `curl localhost:8080/v6/api/swagger.json | jq > swagger-v6.json` and copy the file to `services/brig/docs/swagger-v6.json`.
113
+
- In `wire-api` extend the `Version` type with a new version by appending the
114
+
new version to the end.
115
+
- In the same `Version` module update the `developmentVersions` value to list
116
+
only the new version.
117
+
- In `services/brig/src/Brig/API/Public.hs`
118
+
- update `versionedSwaggerDocsAPI` so that the finalized version points to the pregenerated swagger
119
+
- and `internalEndpointsSwaggerDocsAPI` so that the finalized version `V6`, the new version `V7`, as well as the unversioned path point to the swagger of the internal API, and the previous latest stable version V5 points to an empty swagger.
120
+
- Set the version for `gDefaultAPIVersion` in `integration/test/Testlib/Env.hs` to 7.
121
+
- Consider updating the `backendApiVersion` value in Stern, which is
122
+
unit-tested by checking if it is listed as supported in the response to `GET
0 commit comments