adyen-postman/README.md

Adyen Postman

This repository contains declaration files in the Postman format. The files are automatically generated based on the latest adyen-openapi definition files. They are then uploaded on our AdyenDev Postman space and you can fork it from there. You can also directly pick the .json files available here and upload them if you prefer.

Usage

The preferred way to use these files is to fork the Adyen APIs Postman workspace. This way you will be notified of new versions and changes. However, in case you want to experiment, or simply want to keep your experiments private, you can also take any of the json files in this repository and upload them yourself.

Contributing

We encourage you to contribute to our repository. Find out more in our contribution guidelines. However, for anything related to our APIs, the correct repository to contribute to would be adyen-openapi.

Setup

• generateAll.sh generates all postman API collection files for all versions of the OpenAPI definitions and places them in the postman folder. It is meant to run inside the dedicated docker image.
• runDocker.sh is the script that actually runs generateAll.sh inside the docker image.

This step should only be done for initial setup, or if something goes wrong. Most work should be automated in the GitHub workflows.

Documentation

Link to relevant documentation and next steps that have to be taken.

Support

If you have a feature request, or spotted a bug or a technical problem, create a GitHub issue. For other questions, contact our support team.

License

MIT license. For more information, see the LICENSE file.