swag-payments/README.md

# RBKmoney OpenAPI Specification

## Working on specification
### Install

1. Install [Node JS](https://nodejs.org/)
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](#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 :smile:
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 12:09:03 +00:00			`# RBKmoney OpenAPI Specification`

			`## Working on specification`
			`### Install`

			`1. Install [Node JS](https://nodejs.org/)`
			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](#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 :smile:`