Update OpenAPI spec description with detailed info

[adamoutler]

Add helpful information to living docs.

Summary by CodeRabbit

• Documentation
  • Enhanced API specification with additional guidance on MCP endpoints, OpenAPI spec location, and API key authorization instructions to improve developer onboarding.

[coderabbitai]

📝 Walkthrough

Walkthrough

The description parameter default value in the generate_openapi_spec function was updated from a single-line string to a multiline Markdown-formatted string that includes MCP endpoint information, OpenAPI specification path, and API key authorization instructions.

Changes

Cohort / File(s)	Summary
API Documentation Parameter server/api_server/openapi/spec_generator.py	Updated the description parameter default value to include multiline Markdown formatting with MCP endpoint reference, OpenAPI spec path, and API key authorization guidance.

Poem

🐰 Hops with glee

The description now hops so bright,
With endpoints clear and auth made right,
MCP paths and specs align,
Documentation divine!
What a beautiful design ✨

🚥 Pre-merge checks | ✅ 3

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title clearly and specifically describes the main change: updating the OpenAPI spec's description parameter with more detailed information. It directly aligns with the changeset.
Docstring Coverage	✅ Passed	Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing touches

• 📝 Generate docstrings

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}