FINTECH-18408: Remove reservation-based paymentPlans/add from docs#63
Open
stepan-stanc-mews wants to merge 3 commits into
Open
FINTECH-18408: Remove reservation-based paymentPlans/add from docs#63stepan-stanc-mews wants to merge 3 commits into
stepan-stanc-mews wants to merge 3 commits into
Conversation
The v1 reservation-based Add payment plan operation was hidden from the OpenAPI document (MewsSystems/mews#82259) in favor of billingAutomationPaymentPlans/add. Regenerated paymentplans.md from the production spec, removed the operation from the operations index, and added a changelog entry. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
jnv
reviewed
Jun 12, 2026
Co-authored-by: Jan Vlnas <jan.vlnas@mews.com>
Co-authored-by: Jan Vlnas <jan.vlnas@mews.com>
Author
|
Thanks @jnv agree with the notes, the original endpoint was used just by a single property |
jonas-paul
approved these changes
Jun 12, 2026
jnv
approved these changes
Jun 12, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
The reservation-based v1
paymentPlans/addoperation was hidden from the OpenAPI document via theInternalImplementationattribute in MewsSystems/mews#82259, since it is superseded bybillingAutomationPaymentPlans/add(GA since 4 June 2026). The published docs were never regenerated after that change, so the operation was still showing on the public site.This PR:
operations/paymentplans.mdwith the OAS-to-MD generator (connector-api/_generator, default config against the production spec) — the v1 Add payment plan operation drops out, Add billing automation payment plan stays.operations/README.md), which is not generator-maintained.The endpoint itself remains functional for existing integrations; this is a documentation-only change.
Notes for reviewers
The generator run also produced an unrelated diff in
operations/orderitems.md(the production spec now has a simplifiedorderItems/getAllrequest example). That drift is intentionally not included here to keep this PR focused — it should be picked up by the owning team or in the next full regeneration.🤖 Generated with Claude Code