Skip to content

docs: add missing SDK operations to README#785

Merged
james-rl merged 1 commit into
mainfrom
james/sdk-docs-add-missing-ops
Apr 27, 2026
Merged

docs: add missing SDK operations to README#785
james-rl merged 1 commit into
mainfrom
james/sdk-docs-add-missing-ops

Conversation

@james-rl

@james-rl james-rl commented Apr 27, 2026

Copy link
Copy Markdown
Contributor

User description

Summary

  • Add runloop.axon (AxonOps) to the Available Resources section
  • Add runloop.networkPolicy (NetworkPolicyOps) to the Available Resources section
  • Add runloop.gatewayConfig (GatewayConfigOps) to the Available Resources section
  • Add runloop.mcpConfig (McpConfigOps) to the Available Resources section

These SDK operations exist in src/sdk.ts but were missing from the README documentation.

Test plan

  • Verify markdown renders correctly on GitHub
  • Links to TypeDoc pages resolve correctly

Made with Cursor


CodeAnt-AI Description

Document the full list of SDK resource operations in the README

What Changed

  • Added the missing SDK resources to the README so the documented list matches what the SDK actually exposes
  • Included Axon, Network Policy, Gateway Config, and MCP Config entries with links to their API docs
  • Marked Axon as beta and briefly described each new resource’s purpose

Impact

✅ Easier SDK discovery
✅ Fewer missing-reference surprises
✅ Clearer docs for available resources

🔄 Retrigger CodeAnt AI Review

Details

💡 Usage Guide

Checking Your Pull Request

Every time you make a pull request, our system automatically looks through it. We check for security issues, mistakes in how you're setting up your infrastructure, and common code problems. We do this to make sure your changes are solid and won't cause any trouble later.

Talking to CodeAnt AI

Got a question or need a hand with something in your pull request? You can easily get in touch with CodeAnt AI right here. Just type the following in a comment on your pull request, and replace "Your question here" with whatever you want to ask:

@codeant-ai ask: Your question here

This lets you have a chat with CodeAnt AI about your pull request, making it easier to understand and improve your code.

Example

@codeant-ai ask: Can you suggest a safer alternative to storing this secret?

Preserve Org Learnings with CodeAnt

You can record team preferences so CodeAnt AI applies them in future reviews. Reply directly to the specific CodeAnt AI suggestion (in the same thread) and replace "Your feedback here" with your input:

@codeant-ai: Your feedback here

This helps CodeAnt AI learn and adapt to your team's coding style and standards.

Example

@codeant-ai: Do not flag unused imports.

Retrigger review

Ask CodeAnt AI to review the PR again, by typing:

@codeant-ai: review

Check Your Repository Health

To analyze the health of your code repository, visit our dashboard at https://app.codeant.ai. This tool helps you identify potential issues and areas for improvement in your codebase, ensuring your repository maintains high standards of code health.

Add axon, networkPolicy, gatewayConfig, and mcpConfig to the Available
Resources section of the README to match the actual SDK exports.

Made-with: Cursor
@codeant-ai

codeant-ai Bot commented Apr 27, 2026

Copy link
Copy Markdown
Contributor

CodeAnt AI is reviewing your PR.


Thanks for using CodeAnt! 🎉

We're free for open-source projects. if you're enjoying it, help us grow by sharing.

Share on X ·
Reddit ·
LinkedIn

@codeant-ai codeant-ai Bot added the size:XS This PR changes 0-9 lines, ignoring generated files label Apr 27, 2026
@codeant-ai

codeant-ai Bot commented Apr 27, 2026

Copy link
Copy Markdown
Contributor

CodeAnt AI finished reviewing your PR.

@james-rl
james-rl requested review from dines-rl and tode-rl April 27, 2026 20:06
@james-rl
james-rl enabled auto-merge (squash) April 27, 2026 20:07
@james-rl
james-rl merged commit 128b60b into main Apr 27, 2026
8 checks passed
@james-rl
james-rl deleted the james/sdk-docs-add-missing-ops branch April 27, 2026 21:00
@stainless-app stainless-app Bot mentioned this pull request Apr 27, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

size:XS This PR changes 0-9 lines, ignoring generated files

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants