Galène videoconferencing server discussion list archives
 help / color / mirror / Atom feed
From: Juliusz Chroboczek <>
To: "Gabriel Kerneis" <>
Subject: [Galene] Re: API documentation
Date: Thu, 11 Apr 2024 01:09:43 +0200	[thread overview]
Message-ID: <> (raw)
In-Reply-To: <>

Hi Gabriel!

> I think you should keep [the ETag explanation] in the API documentation.


> I would format groupname and username (and other API parameters) in
> italics to have them stand out, eg. in
> `/galene-api/0/.groups/groupname/.users/username`.

I'm not sure how to do that in a Markdown code block.

> Explain the format of the stats endpoint.

Clarified that the format is undocumented, and might change between
versions.  (If you're curious, see static/stats.js, but don't rely on it.)

> Idem for group and user definition (is it json, is it compatible with
> on-disk format, etc.). Maybe also specify the Content-Type for each
> endpoint?

Done and done, thanks.

> Passwords: what do you mean exactly by "full password definition"? If
> this refers to the on-disk format, again, I think you should explicitly
> cross-reference it.


Thanks again,

-- Juliusz

  reply	other threads:[~2024-04-10 23:09 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-04-10 19:40 [Galene] " Juliusz Chroboczek
2024-04-10 20:47 ` [Galene] " Gabriel Kerneis
2024-04-10 23:09   ` Juliusz Chroboczek [this message]
2024-04-11  0:02   ` [Galene] API versioning (was Re: Re: API documentation) Dianne Skoll
     [not found]   ` <171279372600.1000.262671797887854827@gauss.local>
2024-04-11 12:55     ` [Galene] " Juliusz Chroboczek

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:

  List information:

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \ \ \ \ \
    --subject='[Galene] Re: API documentation' \

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox