valitydev/swag-payments
14
0
Fork 0
mirror of https://github.com/valitydev/swag-payments.git synced 2024-11-07 09:58:57 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
29 Commits 19 Branches 0 Tags 3.9 MiB
JavaScript 81.9%
HTML 18.1%
27a8069f28
Go to file
Andrew Mayorov 27a8069f28 ITS-21: Prepare for the release (#31) 
* ITS-21: Make the spec ready for ReDoc

* ITS-21: Make it possible to define paths in subdirs

* ITS-21: Translate tags back to English + abuse x-displayName

* ITS-21: Introduce Makefile

* ITS-21: Describe analytics operations more

* ITS-21: Describe analytics definitions more

* ITS-21: Fix tag descriptions a bit

* ITS-21: Describe geo operations

* ITS-21: Translate common parameter descriptions

* ITS-21: Describe invoice/payments operations and definitions

* ITS-21 Make shop/party activation/suspension truly idempotent. Fix UpdateShopArgs definition

* ITS-21: Describe payments/tokens operations and definitions

* ITS-21: Describe invoice.reason property

* ITS-21: Describe user interactions

* ITS-21: Unskuccaite all the paths backs

* ITS-21: Fix warnings + use hack w/ allOf where applicable

* ITS-21 Rename all Args to Params

* ITS-21 Rename context to metadata
2017-02-06 15:09:03 +03:00
scripts ITS-21: Prepare for the release (#31) 2017-02-06 15:09:03 +03:00
spec ITS-21: Prepare for the release (#31) 2017-02-06 15:09:03 +03:00
web ITS-21: Prepare for the release (#31) 2017-02-06 15:09:03 +03:00
.gitignore ITS-21: Prepare for the release (#31) 2017-02-06 15:09:03 +03:00
gulpfile.js ITS-21: Prepare for the release (#31) 2017-02-06 15:09:03 +03:00
LICENSE ITS-21: Prepare for the release (#31) 2017-02-06 15:09:03 +03:00
Makefile ITS-21: Prepare for the release (#31) 2017-02-06 15:09:03 +03:00
package.json ITS-21: Prepare for the release (#31) 2017-02-06 15:09:03 +03:00
README.md ITS-21: Prepare for the release (#31) 2017-02-06 15:09:03 +03:00

README.md

RBKmoney OpenAPI Specification

Build Status

Steps to finish

  1. Enable Travis for your repository (note: you already have .travis.yml file)
  2. Create GitHub access token; check public_repo on Select scopes section.
  3. Use the token value as a value for Travis environment variable with the name GH_TOKEN
  4. Make a test commit to trigger CI: git commit --allow-empty -m "Test Travis CI" && git push
  5. Wait until Travis build is finished. You can check progress by clicking on the Build Status badge at the top
  6. If you did everything correct, https://git@github.com:antonlva.github.io/rbkmoney-api-docs.git/ will lead to your new docs
  7. [Optional] You can setup custom domain (just create web/CNAME file)
  8. Start writing/editing your OpenAPI spec: check out usage section below
  9. [Optional] If you document public API consider adding it into APIs.guru directory using this form.
  10. Delete this section 😄

Links

  • Documentation(ReDoc): https://git@github.com:antonlva.github.io/rbkmoney-api-docs.git/
  • SwaggerUI: https://git@github.com:antonlva.github.io/rbkmoney-api-docs.git/swagger-ui/
  • Look full spec:
    • JSON https://git@github.com:antonlva.github.io/rbkmoney-api-docs.git/swagger.json
    • YAML https://git@github.com:antonlva.github.io/rbkmoney-api-docs.git/swagger.yaml
  • Preview spec version for branch [branch]: https://git@github.com:antonlva.github.io/rbkmoney-api-docs.git/preview/[branch]

Warning: All above links are updated only after Travis CI finishes deployment

Working on specification

Install

  1. Install Node JS
  2. Clone repo and cd
    • Run npm install

Usage

  1. Run npm start
  2. Checkout console output to see where local server is started. You can use all links (except preview) by replacing https://git@github.com:antonlva.github.io/rbkmoney-api-docs.git/ with url from the message: Server started <url>
  3. Make changes using your favorite editor or swagger-editor (look for URL in console output)
  4. 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 open swagger-editor, documentation and swagger-ui in parallel
  5. Once you finish with the changes you can run tests using: npm test
  6. Share you changes with the rest of the world by pushing to GitHub 😄