Skip to content

Conversation

@ethanpalm
Copy link
Collaborator

@ethanpalm ethanpalm commented Oct 22, 2025

Documentation changes

This PR fixes some inaccuracies in how to find project ID and domain parameters, removes deprecated endpoints, and removes unused endpoints from OpenAPI specs.

  • admin-openapi.json
    • Removes hallucinated endpoints
    • Clearer info to find and copy your project ID
  • /assistant
    • delete create-topic.mdx
    • delete generate-message.mdx
  • discovery-openapi.json
    • Accurate information on where to find {domain}
    • Remove deprecated /chat/topic and /chat/message paths
  • docs.json
    • Sentence case API reference group name
  • openapi.json
    • Clearer information on how to find {projectId}

For Reviewers

When reviewing documentation PRs, please consider:

✅ Technical accuracy

  • Code examples work as written
  • Commands and configurations are correct
  • Links resolve to the right destinations
  • Prerequisites and requirements are accurate

✅ Clarity and completeness

  • Instructions are clear and easy to follow
  • Steps are in logical order
  • Nothing important is missing
  • Examples help illustrate the concepts

✅ User experience

  • A new user could follow these docs successfully
  • Common gotchas or edge cases are addressed
  • Error messages or troubleshooting guidance is helpful

cursor[bot]

This comment was marked as outdated.

Copy link
Contributor

@mayankshouche mayankshouche left a comment

Choose a reason for hiding this comment

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

lgtm! thanks for adding clarity here!

@ethanpalm ethanpalm merged commit 8f3b5ea into main Oct 23, 2025
5 checks passed
@ethanpalm ethanpalm deleted the api-cleanup branch October 23, 2025 00:56
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.

2 participants