docs(api): remove request access text #3363
Conversation
📝 WalkthroughWalkthroughReplaces embedded swaggerSpec blobs in generated Go files and updates the Subscriptions tag description across OpenAPI YAML and TSP spec files. No code structure, control flow, or public API signatures changed; updates are content/text replacements only. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
Pre-merge checks (3 passed)✅ Passed checks (3 passed)
Tip 👮 Agentic pre-merge checks are now available in preview!Pro plan users can now enable pre-merge checks in their settings to enforce checklists before merging PRs.
Please see the documentation for more information. Example: reviews:
pre_merge_checks:
custom_checks:
- name: "Undocumented Breaking Changes"
mode: "warning"
instructions: |
Pass/fail criteria: All breaking changes to public APIs, CLI flags, environment variables, configuration keys, database schemas, or HTTP/GraphQL endpoints must be documented in the "Breaking Change" section of the PR description and in CHANGELOG.md. Exclude purely internal or private changes (e.g., code not exported from package entry points or explicitly marked as internal).Please share your feedback with us on this Discord post. ✨ Finishing Touches
🧪 Generate unit tests
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. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (6)
api/spec/src/cloud/main.tsp (1)
101-101: Optional copy tweak: remove “easily” and tighten phrasing.Keeps a neutral tone and parallel structure.
- description: "With Subscriptions, you can easily start, cancel, and manage customer subscriptions. For example, provisioning them on a specific plan or assigning custom rate cards.", + description: "With Subscriptions, you can start, cancel, and manage customer subscriptions—for example, provision them on a specific plan or assign custom rate cards.",api/openapi.cloud.yaml (1)
14-14: Polish the example sentence to avoid a fragment and pronoun ambiguity.Consider making the example a full sentence and replacing “them” with “customers.”
Apply:
- description: With Subscriptions, you can easily start, cancel, and manage customer subscriptions. For example, provisioning them on a specific plan or assigning custom rate cards. + description: With Subscriptions, you can easily start, cancel, and manage customer subscriptions. For example, you can provision customers on a specific plan or assign custom rate cards.api/spec/src/main.tsp (1)
109-109: Tone/grammar nit: tighten phrasing to match other tags.Drop “easily” and fix the non-parallel “For example, provisioning…”.
- description: "With Subscriptions, you can easily start, cancel, and manage customer subscriptions. For example, provisioning them on a specific plan or assigning custom rate cards.", + description: "Start, cancel, and manage customer subscriptions. For example, provision subscriptions on a specific plan or assign custom rate cards.",Optional: mirror Notifications by adding a doc link if one exists (e.g., “Read more”).
api/openapi.yaml (1)
15-15: Wording nit: remove pronoun ambiguity and keep tone neutral.“provisioning them” is ambiguous (subscriptions vs. customers). Suggest tightening.
- description: With Subscriptions, you can easily start, cancel, and manage customer subscriptions. For example, provisioning them on a specific plan or assigning custom rate cards. + description: Manage customer subscriptions: start, cancel, and modify. For example, provision subscriptions on a specific plan or assign custom rate cards.api/client/go/client.gen.go (1)
43117-43377: Reduce diff noise in future: prefer go:embed over base64 blobs.If feasible in your generator pipeline, embed the OpenAPI JSON/YAML via Go 1.16+ //go:embed (or ship the spec as a separate asset). This keeps PRs readable and minimizes churn.
api/api.gen.go (1)
20636-20645: Optional: switch from huge string-literals to go:embed for smaller diffsEmbedding the raw YAML/JSON via go:embed (and gzip at build or serve time) reduces churn in PRs and keeps diffs readable. This is a non-blocking, future-facing improvement.
Example (outside this PR):
//go:generate oapi-codegen -generate types,server -o api.gen.go -package api api/openapi.yaml //go:embed openapi.yaml var openapiYAML []byte func GetSwagger() []byte { return openapiYAML } // or gzip-compress once in init()
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (6)
api/api.gen.go(1 hunks)api/client/go/client.gen.go(1 hunks)api/openapi.cloud.yaml(1 hunks)api/openapi.yaml(1 hunks)api/spec/src/cloud/main.tsp(1 hunks)api/spec/src/main.tsp(1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (5)
- GitHub Check: Test
- GitHub Check: Build
- GitHub Check: Code Generators
- GitHub Check: Lint
- GitHub Check: Analyze (go)
🔇 Additional comments (11)
api/spec/src/cloud/main.tsp (2)
99-103: Request-access text removed — looks good and aligns with PR intent.No API/signature impact; doc copy reflects capabilities without gating language.
99-103: Specs updated — no stale references found
No occurrences of “Request access” or contact@openmeter.cloud remain; the@tagMetadata("Subscriptions")description is present inapi/spec/src/cloud/main.tsp, and no stale Swagger/OpenAPI blobs reference the old text.api/openapi.cloud.yaml (2)
14-14: Removal of “request access” language looks good.This aligns the docs with self-serve onboarding and avoids funneling users to support.
11-17: Subscriptions description consistency verified
The description text is identical in api/openapi.yaml, api/openapi.cloud.yaml, api/spec/src/main.tsp, and api/spec/src/cloud/main.tsp, and no stale “Request access” remains.api/spec/src/main.tsp (1)
107-111: Docs copy cleanup is good.Removing the “request access” language aligns the tag with GA availability.
api/openapi.yaml (2)
15-15: Change aligns with PR goal (removes request-access prompt).This updates the Subscriptions tag description without altering API semantics. LGTM.
15-15: No leftover “Request access” or contact email references found
Verified a repo-wide search for “Request access”, “request access”, and “contact@openmeter.cloud” returned no matches.api/client/go/client.gen.go (2)
43117-43377: Regenerated swaggerSpec blob — LGTM.Only the embedded data changed; the slice literal structure and GetSwagger entry point remain intact. Safe to merge from a code perspective.
43117-43377: Approved swaggerSpec doc-only update
Decoded swaggerSpec (OpenAPI 3.0.0), confirmed the updated Subscriptions tag description, and found no added or removed paths compared to api/openapi.yaml.api/api.gen.go (2)
20398-20410: LGTM: spec payload updated, code shape untouchedThe change is confined to the embedded swaggerSpec string literals. No exported APIs or control flow altered. Safe doc-only refresh.
20599-20610: Embedded swaggerSpec contains no “request access” text – After decoding and scanning the gzip/base64 payload, no banned phrases were found.
hekike
added
the
release-note/ignore
2 participants
Overview
Fixes #(issue)
Notes for reviewer
Summary by CodeRabbit
Documentation
Chores