iarbackend

Contents

  • Getting started
  • Administrator’s Guide
  • Developer’s guide
  • Configuration
  • The iar-backend Project
  • The assets Application
iarbackend
  • Docs »
  • Information Asset Register - API backend
  • View page source

Information Asset Register - API backend¶

This is the documentation for the iar-backend project which provides a RESTFul API backend supporting the iar-frontend applcation. The body of the reference material can be found in the section on the assets application.

If you don’t know where to start then the getting started guide is a good bet.

Contents

  • Getting started
    • Fork the upstream repository
    • Set up cloud integrations
    • Clone the repository locally
    • Install any requirements
    • Set up local configuration
    • Start the development server
    • Next steps
  • Administrator’s Guide
    • Data migration from initial data
  • Developer’s guide
    • Local development
    • Docker images
    • Using an external OAuth2 endpoint
    • Cloud infrastructure
  • Configuration
    • Specifying the database
    • Default settings
  • The iar-backend Project
    • Settings
    • Custom test suite runner
  • The assets Application
    • Installation
    • Default settings
    • Views and serializers
    • Permissions
    • Extensions to drf-yasg
    • Default URL routing
    • Application configuration
Next

© Copyright 2017, University of Cambridge Information Services.

Built with Sphinx using a theme provided by Read the Docs.