QPP Submissions API Developer Documentation
Developer documentation for building against the QPP Submissions API. Accessible publicly at https://cmsgov.github.io/qpp-submissions-docs.
These are static tutorials designed to illustrate some common workflows when composing API requests together to submit and score performance data. The sample request and response data may be out of date as the API changes, but the workflows must remain valid.
It's also useful to describe the data being submitted and updated through the API, so these data schemas list the fields belonging to each resource type as well as some supplementary details about concepts like scoring.
create-react-app to avoid having to make tooling decisions.
npm install npm start
We use Travis CI for testing - add a test if it makes sense, and make sure the build is green before merging.
Read about how tests are written and run. Following the linked recommendations, we use Enzyme for testing components in isolation and put test files alongside app files - see app.test.js and api-reference.test.js for examples.
These docs are hosted on GitHub Pages.
To deploy changes, you'll need to be a collaborator on the GitHub repo, merge a feature branch into to the master branch (see CONTRIBUTING.md#merging-to-master), and deploy the master branch with the following command:
git checkout master git pull # make sure you've pulled the latest version of master npm run deploy
Under the hood, the gh-pages library is used for managing the gh-pages branch.
This project is in the public domain within the United States, and copyright and related rights in the work worldwide are waived through the CC0 1.0 Universal public domain dedication.
All contributions to this project will be released under the CC0 dedication. By submitting a pull request, you are agreeing to comply with this waiver of copyright interest.