fixes documentation for remove a provider

[akshaydeo]

Summary

Clarify that the Delete Provider API endpoint is only supported for custom providers, not built-in providers.

Changes

• Added a description to the Delete Provider endpoint explaining that it's only for custom providers
• Updated the parameter description to specify "custom provider" instead of just "provider"
• Suggested using Update Provider as an alternative for non-custom providers

Type of change

• Bug fix
• Feature
• Refactor
• Documentation
• Chore/CI

Affected areas

• Core (Go)
• Transports (HTTP)
• Providers/Integrations
• Plugins
• UI (Next.js)
• Docs

How to test

Verify the updated OpenAPI documentation renders correctly:

# If using a documentation preview tool
cd docs
# Run your documentation preview command

Breaking changes

• No
• Yes

Related issues

N/A

Security considerations

N/A

Checklist

• I read docs/contributing/README.md and followed the guidelines
• I added/updated tests where appropriate
• I updated documentation where needed
• I verified builds succeed (Go and UI)
• I verified the CI pipeline passes locally if applicable

[coderabbitai]

Caution

Review failed

The pull request is closed.

📝 Walkthrough

Summary by CodeRabbit

• Documentation
  • Enhanced OpenAPI documentation for the Providers API with clearer descriptions regarding provider removal capabilities and limitations.
  • Clarified that the delete provider operation applies only to custom providers, with guidance on using the Update Provider operation for other provider types.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

Walkthrough

OpenAPI specification updated to clarify that the delete provider operation only supports custom providers. Tag description added, operation description clarified, and parameter naming updated to specify "custom provider" instead of generic "provider."

Changes

Cohort / File(s)	Summary
OpenAPI specification documentation docs/apis/openapi.json	Updated Providers tag with description; added operation-level description to delete provider endpoint; changed parameter description from "The name of the provider to delete" to "The name of the custom provider to delete"

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

• Review consists solely of documentation/specification clarifications in OpenAPI schema with no functional code changes

Poem

🐰 Our custom providers now shine so clear,
In the OpenAPI docs, the truth is here!
Delete only custom—the spec does say,
No more confusion in the provider's way! ✨

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch 12-16-fixes_documentation_for_remove_a_provider

---

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 991b5aa and 0891208.

📒 Files selected for processing (1)

• docs/apis/openapi.json (1 hunks)

---

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

[akshaydeo]

• fixes documentation for remove a provider #1109 👈 (View in Graphite)
• main

This stack of pull requests is managed by Graphite. Learn more about stacking.

[github-actions]

🧪 Test Suite Available

This PR can be tested by a repository admin.

Run tests for PR #1109