From: Juliusz Chroboczek <jch@irif.fr> To: "Gabriel Kerneis" <gabriel@kerneis.info> Cc: galene@lists.galene.org Subject: [Galene] Re: API documentation Date: Thu, 11 Apr 2024 01:09:43 +0200 [thread overview] Message-ID: <87y19ku85k.wl-jch@irif.fr> (raw) In-Reply-To: <32abf60e-fc7c-45cc-81d4-2c08feb16a04@app.fastmail.com> Hi Gabriel! > I think you should keep [the ETag explanation] in the API documentation. Done. > 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. Done. Thanks again, -- Juliusz
next prev parent 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: https://en.wikipedia.org/wiki/Posting_style#Interleaved_style List information: https://lists.galene.org/postorius/lists/galene.lists.galene.org/ * Reply using the --to, --cc, and --in-reply-to switches of git-send-email(1): git send-email \ --in-reply-to=87y19ku85k.wl-jch@irif.fr \ --to=jch@irif.fr \ --cc=gabriel@kerneis.info \ --cc=galene@lists.galene.org \ --subject='[Galene] Re: API documentation' \ /path/to/YOUR_REPLY https://kernel.org/pub/software/scm/git/docs/git-send-email.html * 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