Document announcement categories#8
Conversation
There was a problem hiding this comment.
Code Review
This pull request updates the documentation for the project announcements API by introducing a new category field. The changes include adding the field to the request example, defining it as a parameter with allowed values (announcement, event, new_feature), and updating the 422 error description. Feedback suggests that the category field should also be documented in the response fields and example response sections to maintain consistency, as the API returns this field upon successful creation.
| <ParamField body="category" type="string"> | ||
| The category to publish the announcement under. One of `announcement`, `event`, or `new_feature`. Defaults to `announcement` when omitted. | ||
| </ParamField> |
There was a problem hiding this comment.
The category field is currently only documented as a request parameter. To ensure the documentation is complete and consistent, please also add it to the Response fields section (lines 170-180) and update the Example response (lines 184-190) to include this new field, as the API returns the category in the response object upon successful creation.
There was a problem hiding this comment.
This is the developer docs repo, it does not contain code my friend
Summary
categoryrequest fieldannouncement,event, andnew_featureannouncementTests
npx mint broken-links(fails: existing broken links to/api/v1/introductioninapi/v0/introduction.mdxandindex.mdx)Related backend PR: https://github.com/top-gg/backend/pull/489