Doc: API Docs review (reminder)

[chenilim]

Summary

Filing an issue as a reminder for a review of the API docs before releasing.

Link to documentation page

https://github.com/mattermost/focalboard/tree/main/server/swagger

(Optional) Additional context and/or screenshot

Note that the docs are generated from code via the make swagger command. They are not currently up-to-date in the repo, but can be generated manually in a local clone. They can also be reviewed in the source comments, (e.g. here).

[wuwinson]

Will sync with @justinegeffen this Wednesday.

[justinegeffen]

Hi @chenilim and @wuwinson! From what I understand, these are for personal server only? Could you point me to the source for the API doc content - i.e., the content that's used to generate the API docs. Thank you!

Happy to sync up about this this week, @wuwinson.

[chenilim]

Hi @justinegeffen, sorry for the delay - just got back from PTO. The API docs are generated in the server/swagger folder.

[justinegeffen]

Just following up on this to confirm what, if anything, is needed from me. Happy to review as needed!

[chenilim]

Hi @justinegeffen, the Swagger API docs are generated from code comments, mainly in api.go. Please review the wording and descriptions, and make any edits as a PR to the code comments. Thanks.

[justinegeffen]

Gotcha! Will do. :) Thanks.