Skip to content

Document announcement categories#8

Open
velddev wants to merge 1 commit into
mainfrom
codex/developer-api-announcement-category-docs
Open

Document announcement categories#8
velddev wants to merge 1 commit into
mainfrom
codex/developer-api-announcement-category-docs

Conversation

@velddev
Copy link
Copy Markdown
Contributor

@velddev velddev commented May 14, 2026

Summary

  • document the optional announcement category request field
  • list the supported category values: announcement, event, and new_feature
  • note that omitted categories default to announcement

Tests

  • npx mint broken-links (fails: existing broken links to /api/v1/introduction in api/v0/introduction.mdx and index.mdx)

Related backend PR: https://github.com/top-gg/backend/pull/489

Copy link
Copy Markdown

@gemini-code-assist gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

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

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.

Comment thread api/v1/projects.mdx
Comment on lines +164 to +166
<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>
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

medium

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.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

This is the developer docs repo, it does not contain code my friend

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant