OPS-39709: document PrepaidOrVcc billing automation prepayment value - #74
Conversation
Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
|
✅ Review posted. View review · run |
moxly
left a comment
There was a problem hiding this comment.
Risk Assessment
Score: 2/10 — low
Documentation-only change to a docs repository — no runtime code, so there is no direct production-incident path. The residual risk is integrator-facing and modest: the docs publish PrepaidOrVcc as an accepted request value before the contract change (mews#86733) has shipped, and the hand-written descriptions live in a generated file that the next regeneration reverts.
Review Summary
Verdict: COMMENT
2 warnings, 2 nits.
The changelog entry matches repository conventions closely: single {% updates format="full" %} wrapper, one {% update %} block, level-2 heading, three operation bullets followed by one shared detail bullet (CONTRIBUTING.md:118-127), and the additive-enum wording mirrors the existing Counter type discriminator entry at line 31. All four anchors resolve (#get-all-billing-automations → line 4, #add-billing-automations → line 221, #update-billing-automations → line 377, #billing-automation-prepayment-type → line 150). No **Breaking:** / **Deprecated** label is needed, so the deprecations table correctly stays untouched. The PR body's three claims — enum value added, the three Prepayment objects annotated, changelog entry added — are all present in the diff.
The PR template is fully filled in, with n/a rationale on the non-applicable checklist items. Both self-flagged reviewer notes are real and are addressed in the inline comments below.
I checked whether the sibling Applicability enum in routingrules.md:118-121 needed the same treatment — its values are Always / PrepaidOnly, a different contract enum, so it is correctly out of scope.
Fix All — prompt for AI agent
Fix the following issues in this PR:
- In
connector-api/operations/billingautomations.md(lines 152-154, plus the property rows at 124, 287, 429): these descriptions are hand-written into a generated file (<!-- AUTOMATICALLY GENERATED, DO NOT MODIFY -->, and_generatorreads descriptions straight from the upstream swagger with no local override), so the next regeneration reverts them. Extend the mews#86733 follow-up to cover both the enum[Description]attributes onBillingAutomationPrepaymentand thePrepaymentproperty descriptions onBillingAutomation,BillingAutomationAddParameters, andBillingAutomationUpdateParameters— otherwise the property-row sentences vanish entirely and the enum bullets regress toPrepaidOrVcc - PrepaidOrVcc. - In
connector-api/changelog/README.md(line 4): move the{% update date %}to the mews#86733 release date and hold the merge until that contract change ships. Until then,Add billing automationsandUpdate billing automationsdocumentPrepaidOrVccas an accepted request value that the API will reject. - In
connector-api/changelog/README.md(line 11): optionally add a detail bullet for theAll/Prepaiddescription clarifications endingDocumentation-only, no change to API.perCONTRIBUTING.md:134. - In
connector-api/operations/billingautomations.md(line 153): expandOTAon first use in the page (online travel agency (OTA)), matchingroutingrules.md:342— best done in the upstream mews#86733 wording.
After all changes, run the project's linter/formatter.
Addresses PR #74 review: the entry covered the enum extension but not the description clarifications the same change makes. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Addresses PR #74 review: the entry must not publish PrepaidOrVcc as an accepted request value before the contract change ships. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
|
✅ Review posted. View review · run |
moxly
left a comment
There was a problem hiding this comment.
Risk Assessment
Score: 1/10 — low
Documentation-only change in a docs repository, and the one integrator-facing risk from the previous round — publishing PrepaidOrVcc as an accepted request value ahead of the contract change — is now closed by moving the entry to the mews#86733 release date (2026-08-11, a Tuesday, matching the PR's hold note) and keeping the PR in draft until that ships.
Review Summary
Verdict: APPROVE
Re-review scoped to changes since commit 9b8cb57 — no new issues.
4 prior findings resolved — 2 fixed, 2 dismissed; 0 carried forward. The changelog date now sits in the future per CONTRIBUTING.md:141, and the added detail bullet at connector-api/changelog/README.md:12 accurately covers the Prepayment property and All / Prepaid value clarifications, ending with the required Documentation-only, no change to API. per CONTRIBUTING.md:134. I verified the generator trace behind the dismissed regeneration finding: propertyDescription returns firstLine(description) only for enum schemas (_generator/jsonschema.js:101-106, _generator/utils.js:25-27) and the full trimmed description otherwise, so the single-line property-row sentences survive as the author described — the follow-up correctly stays scoped to the BillingAutomationPrepayment [Description] attributes. The OTA-expansion nit is likewise accepted as belonging in the upstream mews#86733 wording.
…butes The enum descriptions were added upstream, so the hand-written bullets now mirror the spec verbatim and regeneration after the release is a no-op instead of a reworded diff. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
…86733 The three [SwaggerSchema] changes on BillingAutomation, BillingAutomationAddParameters and BillingAutomationUpdateParameters were taken out of the contract PR, so the rows documenting them described text the spec will never contain. Only the enum block remains, which matches the [Description] attributes verbatim. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
billingautomations.md is generated from the production swagger, so the enum block lands on its own in the regeneration that follows the mews#86733 release. Hand-editing it here only risked drift. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Regeneration is manual, so a changelog-only PR would merge announcing the value while the reference page still showed the old enum. Output of _generator run against the mews#86733 build; to be re-verified against production after the release before merge. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Summary
OPS-39709:
PrepaidOrVccwas added toRoutingRulePrepaymentin mews#86308 but left out of the Connector API contract, so a billing automation holding the value madebillingAutomations/getAllthrow for the whole enterprise. mews#86733 closes that gap and ships with the Tuesday 11 August 2026 release. This PR documents the new value: the changelog entry, and theBilling automation prepayment typeenum on the billing automations reference page.Important
Do not merge before Tuesday 11 August 2026. Until mews#86733 ships, this documents
PrepaidOrVccas an accepted request value that the API still rejects.Checklist
SUMMARY.mdupdated if new pages added — n/a, no new pagesAPI
🤖 Generated with Claude Code