- Documentation: https://api-reference.checkout.com
- SwaggerUI: https://api-reference.checkout.com/swagger-ui/
- Look full spec:
- Preview spec version for branch
[branch]: https://api-reference.checkout.com/preview/[branch]
NOTE: All above links are updated only after Travis CI finishes deployment
- Install Node JS
- Install dotnet cli
- Clone repo and inside the repo directory
- Run
npm install
- Run
- Run
npm run start - Check console output to see where local server is started
- Make changes using your favorite editor (or the
swagger-editorshipped with the project - look for the URL in the console output) - All changes are immediately propagated to your local server, moreover all documentation pages will be automagically refreshed in a browser after each change
TIP: you can openswagger-editor, documentation andswagger-uiin parallel - Once you finish with the changes you can run tests using:
npm run test
- Your contribution should have a JIRA ticket on the Documentation Board
- Name your branch
<type>/<JIRA-issue-key>-<JIRA-issue-title>
for example: "task/DOCS-534-add-oas3-operationid" - Work, commit, push
- Have a break, drink some coffee
- Repeat (3) through (4) until finished
- Create a PR and request review from
- a peer developer (if necessary)
- @Toby Knott, @Jack Hutchinson and @Chrisi Webster
- After merging the PR, please check if your branch can be deleted
- Verify if Node.js is installed
node --version - Verify if Gulp is installed
gulp --version - Verify if dotnet is installed
dotnet --version
If you are receiving the error message ReferenceError: primordials is not defined that's probably because you're using Node.js version >= 12 and Gulp version < 4. It's possible to overcome that by downgrading your Node.js version or by upgrading gulp on your machine. For more information, please check the issue gulpjs/gulp#2324.