valitydev/swag-webhook-events
14
0
Fork 0
mirror of https://github.com/valitydev/swag-webhook-events.git synced 2024-11-07 02:45:19 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
2 Commits 20 Branches 0 Tags 978 KiB
JavaScript 72.1%
HTML 27.9%
630d1e7cb8
Go to file
Anton Kuranda 630d1e7cb8 Redoc ready fix (#2) 
* HOOK-11: Initial webhook events swagger commit

* fix .gitignore

* hotfix

* added signature header

* fix

* fix

* fixed after some comments (not at all)

* fixed after other comments

* fixed doc about retry policy

* Fixed camelCase

* Fixed

* fixed

* added amount minimum

* removed host

* fixed minor bug

* added payload to required fields

* added partyId

* added description about queue policy

* fix resend policy depends of http-code

* removed x-request-id header

* -added ReDoc infrastructure
- completely reformat spec structure

* added gitignore

* forgot to add gitignore, removed node_modules

* readme fix

* removed web_deploy

* removed unnecessary wsd

* changed eventid type

* review fix #1

* wording fix, build fix
2017-04-25 17:44:38 +03:00
scripts Redoc ready fix (#2) 2017-04-25 17:44:38 +03:00
spec Redoc ready fix (#2) 2017-04-25 17:44:38 +03:00
web Redoc ready fix (#2) 2017-04-25 17:44:38 +03:00
.gitignore Redoc ready fix (#2) 2017-04-25 17:44:38 +03:00
gulpfile.js Redoc ready fix (#2) 2017-04-25 17:44:38 +03:00
LICENSE Redoc ready fix (#2) 2017-04-25 17:44:38 +03:00
Makefile Redoc ready fix (#2) 2017-04-25 17:44:38 +03:00
package.json Redoc ready fix (#2) 2017-04-25 17:44:38 +03:00
README.md Redoc ready fix (#2) 2017-04-25 17:44:38 +03:00
wercker.yml Redoc ready fix (#2) 2017-04-25 17:44:38 +03:00

README.md

RBKmoney Webhooks Events API Specification

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://github.com/antonlva/swag-webhook-events.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 😄