CON-10547: Regenerate docs with, deprecate external payment types#43
Merged
CON-10547: Regenerate docs with, deprecate external payment types#43
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Regenerates Mews Connector API reference docs to reflect recent Payments and Payment Requests schema updates, and updates the generator’s cross-page type registry accordingly.
Changes:
- Extended Payments documentation with
Payment.Data.Alternativeand new “Alternative payment” type details (including an enum for method type). - Extended Add payment requests parameters with optional
BillId. - Updated
_generator/types.yamlto register the new schema anchors for cross-linking.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| connector-api/operations/payments.md | Documents alternative payment data on Payment responses and updates examples/enums accordingly. |
| connector-api/operations/paymentrequests.md | Documents new optional BillId parameter for creating payment requests and updates request example. |
| connector-api/_generator/types.yaml | Adds discovered type mappings for the newly documented schema sections to enable cross-page links. |
jnv
force-pushed
the
CON-10547-deprecate-depositcc
branch
from
616349e to
002cb8e
Compare
jnv
force-pushed
the
CON-10547-deprecate-depositcc
branch
from
002cb8e to
0b347d0
Compare
jnv
changed the title
jonas-paul
approved these changes
Apr 7, 2026
| | `DinersClub` value in [External payment type](../operations/payments.md#external-payment-type) | Only supported for existing partners. | 14 Jul 2025 | - | | ||
| | `Jcb` value in [External payment type](../operations/payments.md#external-payment-type) | Only supported for existing partners. | 14 Jul 2025 | - | | ||
| | `UnionPay` value in [External payment type](../operations/payments.md#external-payment-type) | Only supported for existing partners. | 14 Jul 2025 | - | | ||
| | `DepositCreditCard` value in [External payment type](../operations/payments.md#external-payment-type) | Only supported for existing partners. | 3 Apr 2026 | - | |
There was a problem hiding this comment.
The deprecation date for DepositCreditCard is listed as 3 Apr 2026, but this PR’s changelog entry is dated 2026-04-08. If the deprecation is being introduced/communicated as part of this update, consider aligning the date (or adding a brief clarification if the API was deprecated earlier than the documentation update) to avoid confusion for readers.
Suggested change
| | `DepositCreditCard` value in [External payment type](../operations/payments.md#external-payment-type) | Only supported for existing partners. | 3 Apr 2026 | - | | |
| | `DepositCreditCard` value in [External payment type](../operations/payments.md#external-payment-type) | Only supported for existing partners. Deprecated on 3 Apr 2026; documented in the changelog on 2026-04-08. | 3 Apr 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
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
DepositCreditCardin external payments as deprecated + introduce deprecation table for enum values (with previous deprecations for this enum)Checklist
SUMMARY.mdupdated if new pages addedAPI