Kids First Release Coordinator

About

The Kids First Release Coordinator brings different services in the Kids First ecosystem together to release data in a synchronized manner.

Quickstart

Getting started is easy! To start running instance of the service complete with data, install Docker and Docker Compose then run:

git clone git@github.com:kids-first/kf-api-release-coordinator.git
cd kf-api-release-coordinator
docker network create kf-data-stack
docker-compose up -d

This will and run the release coordinator and supporting services with the code mounted into the containers for development. The api will be exposed at http://localhost:5000 by default.

Contents:

• Introduction
  • Background
  • Coordinator and Task Services
• Service Authentication
  • Identifying Outgoing Requests
  • Authenticating Incoming Requests

Release Coordinator:

• Introduction
• Release Coordinator API
• Resources and Endpoints
  • Tasks
  • Task Services
  • Releases
  • Release Notes
  • Events
  • Studies
• Permissions
  • Unauthorized and USER Role Permissions
  • ADMIN Role Permissions
• Development
  • Developing with Docker
  • Changing Settings
  • Generating Mock Data

Task Services:

• Introduction
  • Current Task Services
  • Examples
• Task Service API
  • Task Actions
  • Task States
  • Authentication