.. vng-api-common documentation master file, created by startproject.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to VNG-API-common's documentation!
=================================================

|build-status| |code-quality| |coverage|

|python-versions| |django-versions| |pypi-version|

VNG-API-common implements generic tooling to implement and document RESTful
APIs in a Common Ground information architecture.

This package/tooling is used in the reference implementations in the ZGW-API
project, the reference lists and the Gemeentelijke Selectielijst.

VNG-API-common is a third party library for Django projects. It is based on
Django Rest Framework and drf-yasg for schema generation.

Features
========

* Custom field inspectors to generate the correct schema in the API spec
* Output to OAS 2 and OAS 3 format
* Custom model fields to encourage DRY
* Common validators for input validation
* Tooling for end-product unit-tests (mocks, custom clients)
* Optional support for notifications

.. toctree::
   :maxdepth: 2
   :caption: Contents:

   quickstart
   setup_config
   docs_helpers/index
   ref/index
   changelog


Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

.. |build-status| image:: https://github.com/maykinmedia/commonground-api-common/workflows/ci-build/badge.svg
    :alt: Build status
    :target: https://github.com/maykinmedia/commonground-api-common/actions?query=workflow%3A%22ci-build%22

.. |code-quality| image:: https://github.com/VNG-Realisatie/vng-api-common/workflows/Code%20quality%20checks/badge.svg
     :alt: Code quality checks
     :target: https://github.com/maykinmedia/commonground-api-common/actions?query=workflow%3A%22Code+quality+checks%22

.. |coverage| image:: https://codecov.io/gh/maykinmedia/commonground-api-common/branch/master/graph/badge.svg
    :target: https://app.codecov.io/gh/maykinmedia/commonground-api-common
    :alt: Coverage status

.. |python-versions| image:: https://img.shields.io/pypi/pyversions/commonground-api-common.svg

.. |django-versions| image:: https://img.shields.io/pypi/djversions/commonground-api-common.svg

.. |pypi-version| image:: https://img.shields.io/pypi/v/commonground-api-common.svg
    :target: https://pypi.org/project/commonground-api-common/