[WPB-21259] Finalize API Version V12 (#4817)

Author: fisx

changelog.d/1-api-changes/freeze-v12

@@ -0,0 +1 @@
+Finalize API Version V12, start new develop version V13.

docs/src/developer/developer/api-versioning.md

@@ -106,14 +106,13 @@ non-overlapping version ranges.
 ### Version bump checklist
 
 When making the client API version bump, i.e., when finalising a version, there
-are several steps to make apart from deciding what endpoint changes are part of
+are several steps to take apart from deciding what endpoint changes are part of
 the version. In these example we assume that version `V6` should be finalized and `V7` should be created:
 
 - 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`.
 - In `wire-api` extend the `Version` type with a new version by appending the
   new version to the end.
-- In the same `Version` module update the `developmentVersions` value to list
-  only the new version.
+- In the same `Version` module update the `isDevelopmentVersion` to your taste.
 - In `services/brig/src/Brig/API/Public.hs`
   - update `versionedSwaggerDocsAPI` so that the finalized version points to the pregenerated swagger, and the dynamically generated swagger spits out swagger for the new `V7`.
 - Set the version for `gDefaultAPIVersion` in `integration/test/Testlib/Env.hs` to 7.

integration/test/Test/Swagger.hs

@@ -13,7 +13,7 @@ import Testlib.Prelude
 import UnliftIO.Temporary
 
 existingVersions :: Set Int
-existingVersions = Set.fromList [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12]
+existingVersions = Set.fromList [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13]
 
 internalApis :: Set String
 internalApis = Set.fromList ["brig", "cannon", "cargohold", "cannon", "spar"]

integration/test/Testlib/Env.hs

@@ -116,7 +116,7 @@ mkGlobalEnv cfgFile = do
         gFederationV1Domain = intConfig.federationV1.originDomain,
         gFederationV2Domain = intConfig.federationV2.originDomain,
         gDynamicDomains = (.domain) <$> Map.elems intConfig.dynamicBackends,
-        gDefaultAPIVersion = 12,
+        gDefaultAPIVersion = 13,
         gManager = manager,
         gServicesCwdBase = devEnvProjectRoot <&> (</> "services"),
         gBackendResourcePool = resourcePool,

libs/wire-api/src/Wire/API/Routes/Public/Brig.hs

@@ -413,7 +413,7 @@ type UserGroupAPI =
     :<|> Named
            "update-user-group-members"
            ( Summary "[STUB] Update user group members. Replaces the users with the given list."
-               :> From 'V12
+               :> From 'V13
                :> ZLocalUser
                :> "user-groups"
                :> Capture "gid" UserGroupId
@@ -424,7 +424,7 @@ type UserGroupAPI =
     :<|> Named
            "update-user-group-channels"
            ( Summary "Replaces the channels with the given list."
-               :> From 'V12
+               :> From 'V13
                :> CanThrow 'UserGroupNotFound
                :> CanThrow 'UserGroupNotATeamAdmin
                :> ZLocalUser
@@ -438,7 +438,7 @@ type UserGroupAPI =
     :<|> Named
            "check-user-group-name-available"
            ( Summary "[STUB] Check if a user group name is available"
-               :> From 'V12
+               :> From 'V13
                :> ZLocalUser
                :> "user-groups"
                :> "check-name"

libs/wire-api/src/Wire/API/Routes/Public/Galley/Conversation.hs

@@ -1413,7 +1413,7 @@ type ConversationAPI =
     :<|> Named
            "search-channels"
            ( Summary "[STUB] Search channels"
-               :> From 'V12
+               :> From 'V13
                :> ZLocalUser
                :> "search"
                :> "channels"

libs/wire-api/src/Wire/API/Routes/Version.hs

@@ -81,7 +81,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 | V6 | V7 | V8 | V9 | V10 | V11 | V12
+data Version = V0 | V1 | V2 | V3 | V4 | V5 | V6 | V7 | V8 | V9 | V10 | V11 | V12 | V13
   deriving stock (Eq, Ord, Bounded, Enum, Show, Generic)
   deriving (FromJSON, ToJSON) via (Schema Version)
   deriving (Arbitrary) via (GenericUniform Version)
@@ -110,6 +110,8 @@ instance RenderableSymbol V11 where renderSymbol = "V11"
 
 instance RenderableSymbol V12 where renderSymbol = "V12"
 
+instance RenderableSymbol V13 where renderSymbol = "V13"
+
 -- | Manual enumeration of version integrals (the `<n>` in the constructor `V<n>`).
 --
 -- This is not the same as 'fromEnum': we will remove unsupported versions in the future,
@@ -130,6 +132,7 @@ versionInt V9 = 9
 versionInt V10 = 10
 versionInt V11 = 11
 versionInt V12 = 12
+versionInt V13 = 13
 
 supportedVersions :: [Version]
 supportedVersions = [minBound .. maxBound]
@@ -249,7 +252,8 @@ isDevelopmentVersion V8 = False
 isDevelopmentVersion V9 = False
 isDevelopmentVersion V10 = False
 isDevelopmentVersion V11 = False
-isDevelopmentVersion V12 = True
+isDevelopmentVersion V12 = False
+isDevelopmentVersion V13 = True
 
 developmentVersions :: [Version]
 developmentVersions = filter isDevelopmentVersion supportedVersions

postgres-schema.sql

@@ -7,6 +7,8 @@
 -- PostgreSQL database dump
 --
 
+\restrict Hl9XxATRAdecxBiFt8PPZgKxbcBTtxdglRrKHEan0Af69hORYkknDeYWBzNNCd6
+
 -- Dumped from database version 17.6
 -- Dumped by pg_dump version 17.6
 
@@ -68,6 +70,106 @@ CREATE TABLE public.collaborators (
 
 ALTER TABLE public.collaborators OWNER TO "wire-server";
 
+--
+-- Name: conversation; Type: TABLE; Schema: public; Owner: wire-server
+--
+
+CREATE TABLE public.conversation (
+    id uuid NOT NULL,
+    access integer[],
+    access_roles_v2 integer[],
+    cells_state integer,
+    channel_add_permission integer,
+    cipher_suite integer,
+    creator uuid,
+    epoch bigint,
+    epoch_timestamp timestamp with time zone,
+    group_conv_type integer,
+    group_id bytea,
+    message_timer bigint,
+    name text,
+    protocol integer,
+    public_group_state bytea,
+    receipt_mode integer,
+    team uuid,
+    type integer NOT NULL,
+    parent_conv uuid
+);
+
+
+ALTER TABLE public.conversation OWNER TO "wire-server";
+
+--
+-- Name: conversation_member; Type: TABLE; Schema: public; Owner: wire-server
+--
+
+CREATE TABLE public.conversation_member (
+    conv uuid NOT NULL,
+    "user" uuid NOT NULL,
+    conversation_role text,
+    hidden boolean,
+    hidden_ref text,
+    otr_archived boolean,
+    otr_archived_ref text,
+    otr_muted boolean,
+    otr_muted_ref text,
+    otr_muted_status integer,
+    provider uuid,
+    service uuid
+);
+
+
+ALTER TABLE public.conversation_member OWNER TO "wire-server";
+
+--
+-- Name: local_conversation_remote_member; Type: TABLE; Schema: public; Owner: wire-server
+--
+
+CREATE TABLE public.local_conversation_remote_member (
+    conv uuid NOT NULL,
+    user_remote_domain text NOT NULL,
+    user_remote_id uuid NOT NULL,
+    conversation_role text
+);
+
+
+ALTER TABLE public.local_conversation_remote_member OWNER TO "wire-server";
+
+--
+-- Name: mls_group_member_client; Type: TABLE; Schema: public; Owner: wire-server
+--
+
+CREATE TABLE public.mls_group_member_client (
+    group_id bytea NOT NULL,
+    user_domain text NOT NULL,
+    "user" uuid NOT NULL,
+    client text NOT NULL,
+    leaf_node_index integer NOT NULL,
+    removal_pending boolean NOT NULL
+);
+
+
+ALTER TABLE public.mls_group_member_client OWNER TO "wire-server";
+
+--
+-- Name: remote_conversation_local_member; Type: TABLE; Schema: public; Owner: wire-server
+--
+
+CREATE TABLE public.remote_conversation_local_member (
+    "user" uuid NOT NULL,
+    conv_remote_domain text NOT NULL,
+    conv_remote_id uuid NOT NULL,
+    hidden boolean,
+    hidden_ref text,
+    otr_archived boolean,
+    otr_archived_ref text,
+    otr_muted_ref text,
+    otr_muted_status integer
+);
+
+
+ALTER TABLE public.remote_conversation_local_member OWNER TO "wire-server";
+
 --
 -- Name: schema_migrations; Type: TABLE; Schema: public; Owner: wire-server
 --
@@ -81,6 +183,23 @@ CREATE TABLE public.schema_migrations (
 
 ALTER TABLE public.schema_migrations OWNER TO "wire-server";
 
+--
+-- Name: subconversation; Type: TABLE; Schema: public; Owner: wire-server
+--
+
+CREATE TABLE public.subconversation (
+    conv_id uuid NOT NULL,
+    subconv_id text NOT NULL,
+    cipher_suite integer,
+    epoch bigint NOT NULL,
+    epoch_timestamp timestamp with time zone NOT NULL,
+    group_id bytea NOT NULL,
+    public_group_state bytea
+);
+
+
+ALTER TABLE public.subconversation OWNER TO "wire-server";
+
 --
 -- Name: user_group; Type: TABLE; Schema: public; Owner: wire-server
 --
@@ -136,6 +255,54 @@ ALTER TABLE ONLY public.collaborators
     ADD CONSTRAINT collaborators_pkey PRIMARY KEY (user_id, team_id);
 
 
+--
+-- Name: conversation_member conversation_member_pkey; Type: CONSTRAINT; Schema: public; Owner: wire-server
+--
+
+ALTER TABLE ONLY public.conversation_member
+    ADD CONSTRAINT conversation_member_pkey PRIMARY KEY (conv, "user");
+
+
+--
+-- Name: conversation conversation_pkey; Type: CONSTRAINT; Schema: public; Owner: wire-server
+--
+
+ALTER TABLE ONLY public.conversation
+    ADD CONSTRAINT conversation_pkey PRIMARY KEY (id);
+
+
+--
+-- Name: local_conversation_remote_member local_conversation_remote_member_pkey; Type: CONSTRAINT; Schema: public; Owner: wire-server
+--
+
+ALTER TABLE ONLY public.local_conversation_remote_member
+    ADD CONSTRAINT local_conversation_remote_member_pkey PRIMARY KEY (conv, user_remote_domain, user_remote_id);
+
+
+--
+-- Name: mls_group_member_client mls_group_member_client_pkey; Type: CONSTRAINT; Schema: public; Owner: wire-server
+--
+
+ALTER TABLE ONLY public.mls_group_member_client
+    ADD CONSTRAINT mls_group_member_client_pkey PRIMARY KEY (group_id, user_domain, "user", client);
+
+
+--
+-- Name: remote_conversation_local_member remote_conversation_local_member_pkey; Type: CONSTRAINT; Schema: public; Owner: wire-server
+--
+
+ALTER TABLE ONLY public.remote_conversation_local_member
+    ADD CONSTRAINT remote_conversation_local_member_pkey PRIMARY KEY ("user", conv_remote_domain, conv_remote_id);
+
+
+--
+-- Name: subconversation subconversation_pkey; Type: CONSTRAINT; Schema: public; Owner: wire-server
+--
+
+ALTER TABLE ONLY public.subconversation
+    ADD CONSTRAINT subconversation_pkey PRIMARY KEY (conv_id, subconv_id);
+
+
 --
 -- Name: user_group_channel user_group_channel_pkey; Type: CONSTRAINT; Schema: public; Owner: wire-server
 --
@@ -182,13 +349,43 @@ CREATE INDEX collaborators_team_id_idx ON public.collaborators USING btree (team
 CREATE INDEX collaborators_user_id_idx ON public.collaborators USING btree (user_id);
 
 
+--
+-- Name: conversation_member_user_idx; Type: INDEX; Schema: public; Owner: wire-server
+--
+
+CREATE INDEX conversation_member_user_idx ON public.conversation_member USING btree ("user");
+
+
+--
+-- Name: conversation_team_idx; Type: INDEX; Schema: public; Owner: wire-server
+--
+
+CREATE INDEX conversation_team_idx ON public.conversation USING btree (team);
+
+
 --
 -- Name: user_group_member_user_id_idx; Type: INDEX; Schema: public; Owner: wire-server
 --
 
 CREATE INDEX user_group_member_user_id_idx ON public.user_group_member USING btree (user_id);
 
 
+--
+-- Name: conversation_member conversation_member_conv_fkey; Type: FK CONSTRAINT; Schema: public; Owner: wire-server
+--
+
+ALTER TABLE ONLY public.conversation_member
+    ADD CONSTRAINT conversation_member_conv_fkey FOREIGN KEY (conv) REFERENCES public.conversation(id) ON DELETE CASCADE;
+
+
+--
+-- Name: conversation conversation_parent_conv_fkey; Type: FK CONSTRAINT; Schema: public; Owner: wire-server
+--
+
+ALTER TABLE ONLY public.conversation
+    ADD CONSTRAINT conversation_parent_conv_fkey FOREIGN KEY (parent_conv) REFERENCES public.conversation(id) ON DELETE CASCADE;
+
+
 --
 -- Name: user_group_member fk_user_group; Type: FK CONSTRAINT; Schema: public; Owner: wire-server
 --
@@ -205,6 +402,22 @@ ALTER TABLE ONLY public.user_group_channel
     ADD CONSTRAINT fk_user_group_channel FOREIGN KEY (user_group_id) REFERENCES public.user_group(id) ON DELETE CASCADE;
 
 
+--
+-- Name: local_conversation_remote_member local_conversation_remote_member_conv_fkey; Type: FK CONSTRAINT; Schema: public; Owner: wire-server
+--
+
+ALTER TABLE ONLY public.local_conversation_remote_member
+    ADD CONSTRAINT local_conversation_remote_member_conv_fkey FOREIGN KEY (conv) REFERENCES public.conversation(id) ON DELETE CASCADE;
+
+
+--
+-- Name: subconversation subconversation_conv_id_fkey; Type: FK CONSTRAINT; Schema: public; Owner: wire-server
+--
+
+ALTER TABLE ONLY public.subconversation
+    ADD CONSTRAINT subconversation_conv_id_fkey FOREIGN KEY (conv_id) REFERENCES public.conversation(id) ON DELETE CASCADE;
+
+
 --
 -- Name: SCHEMA public; Type: ACL; Schema: -; Owner: wire-server
 --
@@ -215,3 +428,5 @@ REVOKE USAGE ON SCHEMA public FROM PUBLIC;
 --
 -- PostgreSQL database dump complete
 --
+
+\unrestrict Hl9XxATRAdecxBiFt8PPZgKxbcBTtxdglRrKHEan0Af69hORYkknDeYWBzNNCd6