docs: sync API reference with latest OpenAPI spec#45
Merged
Conversation
Adopt all vatlify OpenAPI changes since the last sync:
- Customers: add `name` identity field + document PATCH /customers/{id}
- Subscriptions: document recurring `price` updates via the update API
- Webhook Endpoints: new REST resource page (CRUD) + guide pointer
- Webhooks: add subscription.updated and subscription.update_scheduled
events and the scheduledUpdate payload
- Remove the simulate-failure test helper (deleted upstream in
sandervanhooft/vatlify#1777) — it was the only public API surface
exposing a provider-native mandated-payment ID
Regenerate sitemap; refresh public/openapi.yaml.
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
1 participant
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
Syncs the docs to the latest Vatly OpenAPI spec (
sandervanhooft/vatlify@main) and closes the last public PSP leak. One PR covering both the additive sync and the removal.Adopted spec changes
nameidentity field (resource + examples), documentedPATCH /customers/{id}.priceupdates via the update API.content/2.api-reference/10.webhook-endpoints.md(list/create/get/update/delete) plus a pointer from the Webhooks guide.subscription.updatedandsubscription.update_scheduledevents, incl. theobject.scheduledUpdatepayload.PSP-leak removal
simulate-failuretest helper from the docs, following its deletion upstream in sandervanhooft/vatlify#1777. It was the only public API surface exposing a provider-native mandated-payment ID (mollie_mandated_payment_…, andadyen_…once Adyen ships). The bundled spec now has zeromollie/adyentokens.Verification
Follow-up (separate repos)
SDKs (
vatly-api-php,vatly-laravel) still need: customername+update(), subscriptionprice, the Webhook Endpoints resource, the two new events, and removal of thesimulate-failurehelper method. Not touched here.