From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from fhigh2-smtp.messagingengine.com (fhigh2-smtp.messagingengine.com [103.168.172.153]) by mail.toke.dk (Postfix) with ESMTPS id BCD92A63CCD for ; Wed, 10 Apr 2024 22:47:59 +0200 (CEST) Authentication-Results: mail.toke.dk; dkim=pass (2048-bit key; unprotected) header.d=kerneis.info header.i=@kerneis.info header.a=rsa-sha256 header.s=fm3 header.b=fpcvwkDR; dkim=pass (2048-bit key; unprotected) header.d=messagingengine.com header.i=@messagingengine.com header.a=rsa-sha256 header.s=fm2 header.b=TtOk/gIn Received: from compute5.internal (compute5.nyi.internal [10.202.2.45]) by mailfhigh.nyi.internal (Postfix) with ESMTP id 75D571140106 for ; Wed, 10 Apr 2024 16:47:57 -0400 (EDT) Received: from imap43 ([10.202.2.93]) by compute5.internal (MEProxy); Wed, 10 Apr 2024 16:47:57 -0400 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=kerneis.info; h= cc:content-transfer-encoding:content-type:content-type:date:date :from:from:in-reply-to:in-reply-to:message-id:mime-version :references:reply-to:subject:subject:to:to; s=fm3; t=1712782077; x=1712868477; bh=mlYUJnGVgB2GrA68dFqsalwDwN5GlZ+zlz8d4i9DMsw=; b= fpcvwkDRRYNuTpjKhFbskFnf1+hjf3t6XNm4fp4jRkk5/Ki+ZwyOK+M3frASOmy+ bi0nvc1CAiTFtJ2pBUKIamohQ64W2f3apoUo44SFb5Ixo57GwATDz6rcEq6TATpq qRp3nOfAMMrbMaB3UnYd2Jr6ojKpv9B+ImY2mli+lC3nxYCmZoKWBGBqbFz84Foc tAWNc5guVy32YeYdm6QfWTETEd5lv6Lck93LoPLDl7BCq4s3ySLiZxyhjsHny17O 5aoq0LDdpWzCumBF+Ar/QnU4IgNVmKGDKPghevhxfMBbzQzLvzE/DorWJLDKVF6m +qcyAhF8RibltMukXygEvg== DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d= messagingengine.com; h=cc:content-transfer-encoding:content-type :content-type:date:date:feedback-id:feedback-id:from:from :in-reply-to:in-reply-to:message-id:mime-version:references :reply-to:subject:subject:to:to:x-me-proxy:x-me-proxy :x-me-sender:x-me-sender:x-sasl-enc; s=fm2; t=1712782077; x= 1712868477; bh=mlYUJnGVgB2GrA68dFqsalwDwN5GlZ+zlz8d4i9DMsw=; b=T tOk/gInmdClycwgT/MFxhDaQtrVI01RVYXUkiu77sg3mXPeP4dcrvK+EIh4uFfpS 7qS0zsYYOu0+0tiLwdH3wRK3m9TTOwdIDKR0l1i6+wVejcJg2A6Xv2eqtkvBtcH5 XszjW2RJvjXkqQylBkxdq1xDSW6EVKecPYgKkWpNwxJOE4v9xYoN8nOW5R70k3Hr XJaX1JuVTy4u6CC3Kxr7OiXCxEjQTXbuSiJv4dCV+ERC2jNuBZn/WVpU2bkU9lKZ lTm/4s9ytilqow9p3Pr8paLv/ceLqfL2TJgfSYLUpRWra5OgkTe824798X1fhVL9 QiaQj6685B0W/6AYX+JBw== X-ME-Sender: X-ME-Proxy-Cause: gggruggvucftvghtrhhoucdtuddrgedvledrudehiedgudehudcutefuodetggdotefrod ftvfcurfhrohhfihhlvgemucfhrghsthforghilhdpqfgfvfdpuffrtefokffrpgfnqfgh necuuegrihhlohhuthemuceftddtnecunecujfgurhepofgfggfkjghffffhvffutgfgse htqhertderreejnecuhfhrohhmpedfifgrsghrihgvlhcumfgvrhhnvghishdfuceoghgr sghrihgvlheskhgvrhhnvghishdrihhnfhhoqeenucggtffrrghtthgvrhhnpeeggffhle fhudegveetueduudfhieelfffhvddugeehgefguedvhefhgfetleegheenucffohhmrghi nhepghgrlhgvnhgvrdhorhhgnecuvehluhhsthgvrhfuihiivgeptdenucfrrghrrghmpe hmrghilhhfrhhomhepghgrsghrihgvlheskhgvrhhnvghishdrihhnfhho X-ME-Proxy: Feedback-ID: id9f34325:Fastmail Received: by mailuser.nyi.internal (Postfix, from userid 501) id 2374E2D4007D; Wed, 10 Apr 2024 16:47:57 -0400 (EDT) X-Mailer: MessagingEngine.com Webmail Interface User-Agent: Cyrus-JMAP/3.11.0-alpha0-379-gabd37849b7-fm-20240408.001-gabd37849 MIME-Version: 1.0 Message-Id: <32abf60e-fc7c-45cc-81d4-2c08feb16a04@app.fastmail.com> In-Reply-To: <877ch5uhul.wl-jch@irif.fr> References: <877ch5uhul.wl-jch@irif.fr> Date: Wed, 10 Apr 2024 22:47:36 +0200 From: "Gabriel Kerneis" To: galene@lists.galene.org Content-Type: text/plain;charset=utf-8 Content-Transfer-Encoding: quoted-printable Message-ID-Hash: UAMLE7F5USSLD53LNFDZFXYDVLNQ6XO2 X-Message-ID-Hash: UAMLE7F5USSLD53LNFDZFXYDVLNQ6XO2 X-MailFrom: gabriel@kerneis.info X-Mailman-Rule-Misses: dmarc-mitigation; no-senders; approved; emergency; loop; banned-address; member-moderation; nonmember-moderation; administrivia; implicit-dest; max-recipients; max-size; news-moderation; no-subject; digests; suspicious-header X-Mailman-Version: 3.3.9 Precedence: list Subject: [Galene] Re: API documentation List-Id: =?utf-8?q?Gal=C3=A8ne_videoconferencing_server_discussion_list?= Archived-At: List-Archive: List-Help: List-Owner: List-Post: List-Subscribe: List-Unsubscribe: I liked the fact that you explained in a recent email the purpose of ETa= g, by giving an example of a failing PUT due to concurrent updates. I th= ink you should keep this in the API documentation. The /0/ is intriguing, but maybe just because I'm not used to REST API d= esign. I'd add a sentence explaining its versioning purpose anyway. I would format groupname and username (and other API parameters) in ital= ics to have them stand out, eg. in `/galene-api/0/.groups/groupname/.use= rs/username`. Explain the format of the stats endpoint. Idem for group and user defini= tion (is it json, is it compatible with on-disk format, etc.). Maybe als= o specify the Content-Type for each endpoint? Passwords: what do you mean exactly by "full password definition"? If th= is refers to the on-disk format, again, I=C2=A0think you should explicit= ly cross-reference it. --=20 Gabriel On Wed, 10 Apr 2024, at 21:40, Juliusz Chroboczek wrote: > https://galene.org/README.API.html > > Please review. > > -- Juliusz > _______________________________________________ > Galene mailing list -- galene@lists.galene.org > To unsubscribe send an email to galene-leave@lists.galene.org