├── .github
    └── workflows
    │   └── optic.yml
├── LICENSE
├── README.md
├── openapi.json
└── openapi.yml


/.github/workflows/optic.yml:
--------------------------------------------------------------------------------
 1 | name: optic
 2 | on:
 3 |   push:
 4 |     branches:
 5 |       - main
 6 |   pull_request:
 7 | 
 8 | jobs:
 9 |   diff-all:
10 |     runs-on: ubuntu-latest
11 |     steps:
12 |       - name: Checkout
13 |         uses: actions/checkout@v3
14 | 
15 |       # 🔧 Uncomment to generate your specifications before running Optic:
16 |       # - name: Generate Spec
17 |       #   run: ./generate_spec.example.sh
18 | 
19 |       - uses: opticdev/action@v1
20 |         with:
21 |           # Your Optic Cloud Token
22 |           optic_token: ${{ secrets.OPTIC_TOKEN }}
23 | 
24 |           # A GitHub token with access to create comments on pull requests
25 |           github_token: ${{ secrets.GITHUB_TOKEN }}
26 | 
27 |           # 🔧 If true, standard check failures will cause this action to fail.
28 |           # If false, standard check failures will show in PR comments and in Optic Cloud but will not cause the action to fail.
29 |           standards_fail: true
30 | 
31 |           # 🔧 A glob pattern to find OpenAPI files in your repository. Leave "" to match all OpenAPI specs in repository.
32 |           # Examples of match: "openapi.yml" or "openapi.yml,other.yml" or "*.spec.yml"
33 |           # additional_args: --match ""
34 | 
35 |           # 🔧 Uncomment next two lines if you generate your specs and don't track them in Git. Requires Optic cloud.
36 |           # compare_from_pr: cloud:default
37 |           # compare_from_push: cloud:default
38 | 
39 | 


--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
 1 | MIT License
 2 | 
 3 | Copyright (c) 2023 Xflow
 4 | 
 5 | Permission is hereby granted, free of charge, to any person obtaining a copy
 6 | of this software and associated documentation files (the "Software"), to deal
 7 | in the Software without restriction, including without limitation the rights
 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 9 | copies of the Software, and to permit persons to whom the Software is
10 | furnished to do so, subject to the following conditions:
11 | 
12 | The above copyright notice and this permission notice shall be included in all
13 | copies or substantial portions of the Software.
14 | 
15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21 | SOFTWARE.
22 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | # Xflow's OpenAPI Specification
 2 | 
 3 | This repository contains [OpenAPI specifications][openapi] for Xflow's API.
 4 | 
 5 | [Changelog](https://github.com/xflowpay/openapi/releases/)
 6 | 
 7 | 
 8 | Files can be found in the `root` directory:
 9 | 
10 | * `openapi.{yml,json}` OpenAPI 3.0.0 spec matching the public Xflow API.
11 | 
12 | [openapi]: https://www.openapis.org/
13 | 


--------------------------------------------------------------------------------