swag-webhook-events/README.md

[![wercker status](https://app.wercker.com/status/ad4c9babc69725d9d19ff2df29ac85bf/s/master "wercker status")](https://app.wercker.com/project/byKey/ad4c9babc69725d9d19ff2df29ac85bf)

# RBKmoney Webhooks Events API 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://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 :smile:

### Generate java-client code

1. Install swagger-codegen with brew `brew install swagger-codegen`
2. Run `npm start`
3. Run `npm run build`
4. Use this command 
`swagger-codegen generate -i web_deploy/swagger.json -l java -o ./java --api-package "com.rbkmoney.swag_webhook_events" --artifact-id "swag-webhook-events" --artifact-version "1.0.8-SNAPSHOT" --group-id "com.rbkmoney" --model-package "com.rbkmoney.swag_webhook_events" --library resttemplate --additional-properties dateLibrary=java8`
added wercher build badge (#5) 2017-05-17 14:12:14 +00:00			`[![wercker status](https://app.wercker.com/status/ad4c9babc69725d9d19ff2df29ac85bf/s/master "wercker status")](https://app.wercker.com/project/byKey/ad4c9babc69725d9d19ff2df29ac85bf)`

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 14:44:38 +00:00			`# RBKmoney Webhooks Events API 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://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 :smile:`
Instruction for generation of java-client code 2018-04-12 09:24:43 +00:00
			`### Generate java-client code`

			1. Install swagger-codegen with brew `brew install swagger-codegen`
			2. Run `npm start`
fixed command 2019-03-20 13:25:22 +00:00			3. Run `npm run build`
			`4. Use this command`
			`swagger-codegen generate -i web_deploy/swagger.json -l java -o ./java --api-package "com.rbkmoney.swag_webhook_events" --artifact-id "swag-webhook-events" --artifact-version "1.0.8-SNAPSHOT" --group-id "com.rbkmoney" --model-package "com.rbkmoney.swag_webhook_events" --library resttemplate --additional-properties dateLibrary=java8`