RingCentral Engage API Docs

This repository is the home of the RingCentral Engage Developer Guide: a collection of materials, and documentation to help educate developers on how to build on top of the RingCentral Engage platform.

Visit a live preview of https://developers.ringcentral.com/engage/digital/guide

Contributing

If you would like to contribute to the RingCentral documentation effort, fork this repository, make your desired edits and contributions, and issue a pull request accordingly.

Running ReadTheDocs Locally

% git clone https://github.com/ringcentral/engage-digital-api-docs.git
% cd engage-digital-api-docs
% pip install mkdocs mkdocs-ringcentral mdx_include
% python3 -m mkdocs serve -a localhost:8000

Or with docker:

./preview.sh

Then you should be able to load http://localhost:8000 to view the documentation.

Generating OpenAPI doc

Go check specs/README.md

Testing OpenAPI Specs

This repo holds OpenAPI specs for Engage Digital.

You can preview the latest version of the swagger spec on the swagger preview

For each commit, tests are run on Travis CI to verify that the OpenAPI 3.0 specs validate.

• Engage Digital Spec: specs/digital/engage-digital_openapi3.yaml
• Tests: specs_test.go

You can verify the specs localy with the following if you have Go installed.

% git clone https://github.com/ringcentral/ringcentral-api-docs.git
% cd ringcentral-api-docs
% go test -v ./...

If you wish to change the specs being tested edit the specs_test.go file.