maxio-com/api-docs

Chargify API Documentation

api-docs's Issues

Invoice.status is not an enum but appears to be

The status property on the invoice object appears to be an enum by reading the page on invoice statuses but is not specified as one in the OpenAPI yaml. The requestBody specification for createInvoice also has a status which is probably the same enum as the Invoice object and should also be documented as an enum.

Support for other languages (Golang in our case)

I see there is an sdk-generator repo that is private. We've had significant hurdles trying to get OpenAPI Generator to play nicely with your OpenAPI YAML and have written preprocessing scripts to get the YAML into a form that can be fed into the Swagger code generator in order to produce a Golang SDK with strong typing. This is working well for us, but I think it would be very helpful if you could either open up the sdk-generator repo so others can see how you are generating your SDKs, or give some concrete examples for Maxio customers to generate SDKs in the language of their choice.

Thoughts?

Alternate Create Subscription request types not shown on documentation

See Create Subscription, the "Components By Handle (Quantity-Based)" is referenced in the docs (and appears to be in the YAML) but is not actually visible on the page.

Not all vault types in Payment-Profile-Vault.yaml enum

https://github.com/maxio-com/api-docs/blob/27cc148825d18af54941ed4b578fb50077155e49/components/schemas/Payment-Profile-Vault.yaml

There are some valid vault types not listed in there

Not all event types in Event-Type.yaml

e.g. pending_cancellation_change is one of them and is missing

Note that it is present in Webhook-Subscription.yaml so maybe the two are supposed to be in sync?