Skip to content

docs: applications and authorization - #5477

Merged
mtojek merged 15 commits into
coder:mainfrom
mtojek:3522-document-more-methods
Dec 21, 2022
Merged

mtojek merged 15 commits into
coder:mainfrom
mtojek:3522-document-more-methods

Conversation

@mtojek

@mtojek mtojek commented Dec 20, 2022 •

Copy link
Copy Markdown
Member

Related: #3522

Changes:

  • Documented: Applications, Authorization
  • Fix: missing description for structures (fixed with @Description)
  • Fix: replace @Consume with @Accept

Question:
* What quality level of documentation do we want to achieve? (description: none vs. DisplayName is the displayed name) Fix: s/none//g

@mtojek mtojek self-assigned this Dec 20, 2022
@mtojek mtojek changed the title 3522 document more methods docs: applications and authorization Dec 20, 2022
@mtojek
mtojek marked this pull request as ready for review December 20, 2022 19:13
@mtojek
mtojek requested review from bpmct and mafredri December 20, 2022 19:21

@mafredri mafredri left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • What quality level of documentation do we want to achieve? (description: none vs. DisplayName is the displayed name)

Instead of none, we could omit the text entirely (empty). I think it's fine not to document all obvious things for now. But ultimately I'd like for us to have very good coverage in codersdk/API docs with explanations for most fields.

Comment thread coderd/authorize.go Resolved
Comment thread codersdk/parameters.go Resolved
Comment thread docs/api/schemas.md Resolved
Comment thread docs/api/applications.md Resolved
Comment thread docs/api/schemas.md Resolved
@mtojek

mtojek commented Dec 21, 2022

Copy link
Copy Markdown
Member Author

Thanks for the review, @mafredri! All comments addressed. It's interesting that we can continuously improve the rendering procedure to achieve better results!

@mtojek
mtojek requested a review from mafredri December 21, 2022 14:26

@mafredri mafredri left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice work!

It's interesting that we can continuously improve the rendering procedure to achieve better results!

I agree! It's nice to have bite-sized pieces, easier to catch oddities. 😄

@mtojek
mtojek merged commit 2bbeff5 into coder:main Dec 21, 2022
@github-actions github-actions Bot locked and limited conversation to collaborators Dec 21, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants