qpp-submissions-docs

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #ai #typescript #llm #go #golang #android #machine-learning #rust #deep-learning #linux

qpp-submissions-docs

★ 8 Open GitHub ↗

Developer documentation for building against the QPP Submissions API

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# QPP Submissions API Developer Documentation

Developer documentation for building against the QPP Submissions API. Accessible publicly at https://cmsgov.github.io/qpp-submissions-docs.

### API Tutorials

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.

### Data Schema

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.

References to [qpp-measures-data](https://github.com/CMSgov/qpp-measures-data), the [interactive API reference](https://preview.qpp.cms.gov/api/submissions/public/docs/).

## Development

We use [`vite`](https://vitejs.dev/guide/) to avoid having to make tooling decisions.

We also rely on the [CMSGov Design System](https://github.com/CMSgov/design-system) and the [U.S. Web Design Standards](https://standards.usa.gov/) to help ensure consistency with other government properties.

```bash
nvm use
npm install
npm start
```

## Testing

We use Jest for testing, but haven't fleshed out thorough unit tests for this repo.

## Deploy

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, and deploy the master branch with the following command:

```bash
git checkout master
git pull # make sure you've pulled the latest version of master
npm run deploy
```

Under the hood, the [gh-pages](https://github.com/tschaub/gh-pages) library is used for managing the gh-pages branch.

## Want to Contribute?

Want to file a bug or contribute some code? Read up on our guidelines for [contributing].

[contributing]: /.github/CONTRIBUTING.md

## Public Domain
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.

See the [formal LICENSE file](/LICENSE).

qpp-submissions-docs

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README