Skip to content

Commit

Permalink
docs(generic): add documentation about GenericModel
Browse files Browse the repository at this point in the history
  • Loading branch information
b1rger committed Feb 23, 2024
1 parent a74d445 commit 54fbb09
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions docs/source/customization.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,21 @@
Customization
=============

The core of the logic described here is based on the :mod:`apis_core.generic`.
It provides generic CRUD views and API views for all models that are configured
to use it. To make a model use the generic functionality, it has to inherit from
:class:`apis_core.generic.abc.GenericModel`.
In standard APIS those models are

* :class:`apis_core.apis_metainfo.models.RootObject`
* :class:`apis_core.apis_metainfo.models.Uri`
* :class:`apis_core.apis_relations.models.Triple`
* :class:`apis_core.collections.models.SkosCollection`
* :class:`apis_core.collections.models.SkosCollectionContentObject`

If you want to use the generic app for your own model, simple make your model
inherit from :class:`apis_core.generic.abc.GenericModel`.

List views
----------

Expand Down

0 comments on commit 54fbb09

Please sign in to comment.