chore(api): remove x-internal from addon endpoints

[tothandras]

Summary by CodeRabbit

• Documentation
  • Updated API documentation to remove internal-only markers from various Product Catalog and Subscription endpoints, making these endpoints visible in public API docs.
• Chores
  • Refreshed embedded API specification data to reflect documentation changes in both server and client components.

[coderabbitai]

📝 Walkthrough

Walkthrough

This change removes the x-internal: true annotation from multiple API endpoints related to product catalog and subscriptions across the OpenAPI specification, TypeSpec route definitions, and regenerates the embedded Swagger specification data in both server and client Go files. No changes are made to API signatures or logic.

Changes

File(s)	Change Summary
api/openapi.yaml, api/openapi.cloud.yaml	Removed all x-internal: true annotations from various API endpoint definitions, especially in product catalog and subscriptions. No other changes to API structure.
api/spec/src/productcatalog/routes.tsp	Removed @extension("x-internal", true) from all operations in PlanAddons, Addons, and SubscriptionAddons interfaces. No changes to method signatures or logic.
api/api.gen.go, api/client/go/client.gen.go	Updated the embedded base64-encoded, gzipped Swagger specification data to reflect the removal of x-internal flags. No code or logic changes.

Possibly related PRs

• chore(api): remove x-internal from /api/v2/events #2717: Removes x-internal: true annotations and updates embedded Swagger specs, but for /api/v2/events endpoints instead of product catalog or subscription APIs. Both PRs modify embedded Swagger data and internal flags for different domains.

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 golangci-lint (1.64.8)

Error: you are using a configuration file for golangci-lint v2 with golangci-lint v1: please use golangci-lint v2
Failed executing command with error: you are using a configuration file for golangci-lint v2 with golangci-lint v1: please use golangci-lint v2

Note

⚡️ AI Code Reviews for VS Code, Cursor, Windsurf

CodeRabbit now has a plugin for VS Code, Cursor and Windsurf. This brings AI code reviews directly in the code editor. Each commit is reviewed immediately, finding bugs before the PR is raised. Seamless context handoff to your AI code agent ensures that you can easily incorporate review feedback.
Learn more here.

---

Note

⚡️ Faster reviews with caching

CodeRabbit now supports caching for code and dependencies, helping speed up reviews. This means quicker feedback, reduced wait times, and a smoother review experience overall. Cached data is encrypted and stored securely. This feature will be automatically enabled for all accounts on May 16th. To opt out, configure Review - Disable Cache at either the organization or repository level. If you prefer to disable all data retention across your organization, simply turn off the Data Retention setting under your Organization Settings.
Enjoy the performance boost—your workflow just got faster.

---

📜 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 201274f and 43b910e.

📒 Files selected for processing (5)

• api/api.gen.go (1 hunks)
• api/client/go/client.gen.go (1 hunks)
• api/openapi.cloud.yaml (0 hunks)
• api/openapi.yaml (0 hunks)
• api/spec/src/productcatalog/routes.tsp (0 hunks)

💤 Files with no reviewable changes (3)

• api/openapi.yaml
• api/spec/src/productcatalog/routes.tsp
• api/openapi.cloud.yaml

⏰ Context from checks skipped due to timeout of 90000ms (13)

• GitHub Check: Artifacts / Container image
• GitHub Check: Artifacts / Benthos Collector Container image
• GitHub Check: Quickstart
• GitHub Check: E2E
• GitHub Check: CI
• GitHub Check: Developer environment
• GitHub Check: Test
• GitHub Check: Migration Checks
• GitHub Check: Lint
• GitHub Check: Commit hooks
• GitHub Check: Build
• GitHub Check: Analyze (javascript)
• GitHub Check: Analyze (go)

🔇 Additional comments (2)

api/client/go/client.gen.go (1)

39367-39645: Approve updating the embedded Swagger specification
The base64-encoded swaggerSpec blob has been regenerated to align with the updated OpenAPI specification (removal of x-internal: true extensions). Since this is machine-generated code and no API signatures or logic have changed, no further manual review of the blob is required.

api/api.gen.go (1)

18978-19251:

Details

✅ Verification successful

Auto-generated Swagger spec update – approved.

This change is limited to the embedded base64-encoded, gzipped OpenAPI JSON and aligns with the removal of all x-internal: true extensions as per the updated spec. No manual diff of the string is necessary. To be certain, run this quick check to ensure no "x-internal" fields remain in the decompressed swagger:

---

🏁 Script executed:

#!/bin/bash
# 1. Extract the base64 block for swaggerSpec
block=$(awk '/swaggerSpec = \[/,/\]/' api/api.gen.go \
  | sed -n 's/^[ \t]*//;s/[",]//g' \
  | tr -d '\n' \
  | sed 's/\[//;s/\]//')

# 2. Decode and decompress
echo "$block" | base64 -d | gunzip -c > /tmp/swagger.json

# 3. Verify absence of x-internal
if grep -R '"x-internal"' /tmp/swagger.json; then
  echo "❌ Found x-internal annotations in the updated spec"
  exit 1
else
  echo "✅ No x-internal annotations remain"
fi

Length of output: 417

---

To be certain we’re extracting the correct block and decoding it properly, let’s use Python to locate the swaggerSpec array, base64-decode and gunzip it, then search for any "x-internal" entries:

---

🏁 Script executed:

#!/usr/bin/env bash
python3 - << 'EOF'
import re, gzip, base64, sys

# Read the generated API file
with open('api/api.gen.go', 'r') as f:
    content = f.read()

# Extract the swaggerSpec string array contents
m = re.search(r'swaggerSpec\s*=\s*\[\]string\{(.*?)\n\}', content, re.S)
if not m:
    print("❌ Could not locate swaggerSpec array in api/api.gen.go")
    sys.exit(1)

block = m.group(1)
# Clean up: remove quotes, commas, and whitespace
cleaned = "".join(line.strip().strip('",') for line in block.splitlines() if line.strip())

# Decode from base64 and decompress
try:
    decoded = gzip.decompress(base64.b64decode(cleaned))
except Exception as e:
    print(f"❌ Decoding error: {e}")
    sys.exit(1)

# Search for any x-internal annotations
if b'"x-internal"' in decoded:
    print("❌ Found x-internal annotations in the updated spec")
    sys.exit(1)
print("✅ No x-internal annotations remain")
EOF

Length of output: 46

---

Auto-generated Swagger spec update – approved and verified

Verified by decoding and decompressing the embedded swaggerSpec; there are no remaining "x-internal" entries in the updated OpenAPI JSON.

✨ Finishing Touches

• 📝 Generate Docstrings

---

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

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Explain this complex logic.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai explain this code block.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and explain its main purpose.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.