valitydev/swag-analytics
14
0
Fork 0
mirror of https://github.com/valitydev/swag-analytics.git synced 2024-11-06 08:45:28 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
6d5fae7dce
swag-analytics/README.md
ndiezel0 6d5fae7dce
CAPI-381: Port SWAG CAPI V3 to SWAG Analytics API (#1) 
* CAPI-381: Port SWAG CAPI V3 to SWAG YAPI

* CAPI-381: Clean up unused definitions

* CAPI-381: Rename YAPI to Dashboard API

* CAPI-381: Remove wsd folder and review fixes

* Update spec/definitions/ContinuationToken.yaml

Co-Authored-By: Andrew Mayorov <a.mayorov@rbkmoney.com>

* CAPI-381: Update rebillyMerge script

* CAPI-381: Change copyright and remove wercker deploy

* CAPI-381: Fix `npm start`

* CAPI-381: Remove ExternalIDConflictError

* CAPI-381: Change error message example to one that can actually occur

* CAPI-381: Remove redundant error description

* CAPI-381: Rename x-rebillyMerge to x-merge-properties

* CAPI-381: Rename dashboard api to analytics api

* CAPI-381: Return copyright

* CAPI-381: Review fix

* CAPI-381: Remove ReadOnly fields

* CAPI-381: Remove `analytics` from paths

* CAPI-381: Correct API description
2019-09-06 17:43:30 +03:00

933 B
Raw Blame History

RBKmoney Analytics 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://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 😄