Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

👷 [#501] Make sure docs are built in CI #502

Merged
merged 1 commit into from
Dec 19, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,7 @@ jobs:
- store-reusable-workflow-vars
with:
main-branch: 'master'
run-docs: true
python-version: '3.11'
docker-image-name: ${{ needs.store-reusable-workflow-vars.outputs.image-name }}

Expand Down
12 changes: 6 additions & 6 deletions docs/api/compliancy/vng.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,12 @@ VNG compliancy
==============

The Objects and Objecttypes API specifications are proposed by the `municipality
of Utrecht`_ and submitted to the `VNG`_ for to become a Dutch national
standard. The VNG (Vereniging van Nederlandse Gemeenten) is the Association of
of Utrecht`_ and submitted to the `VNG`_ for to become a Dutch national
standard. The VNG (Vereniging van Nederlandse Gemeenten) is the Association of
Dutch Municipalities.

The VNG has drafted an initial checklist for new API standards which is shown
in the table below. The table below also shows the compliancy to this checklist
The VNG has drafted an initial checklist for new API standards which is shown
in the table below. The table below also shows the compliancy to this checklist
for both APIs. This checklist is only available in Dutch.

.. csv-table:: 1. Stakeholder documentatie
Expand Down Expand Up @@ -58,7 +58,7 @@ for both APIs. This checklist is only available in Dutch.
1;Opgesteld in Open API Specification 3.x;`Yes <https://objects-and-objecttypes-api.readthedocs.io/en/latest/api/index.html>`__;
2;Gepubliceerd op VNG-Realisatie Github omgeving en beschikbaar via Redoc en Swagger;No [1]_;
3;Ontwerpbeslissing zijn vertaald naar (aanvullende) specificaties;`Yes <https://github.com/maykinmedia/objects-api/issues>`_;
4;Voldoet aan landelijke API strategie, in het bijzonder de core design rules;`Yes <https://objects-and-objecttypes-api.readthedocs.io/en/latest/api/principles.html>`__;
4;Voldoet aan landelijke API strategie, in het bijzonder de core design rules;`Yes <https://objects-and-objecttypes-api.readthedocs.io/en/latest/api/compliancy/api-strategy.html>`__;
5;Informatiebeveiliging en privacy best practices (IBD) worden gevolgd;No;Unclear
6;Aanvullende specificaties die het gedrag van de API specificeren voor de provider.;No;TODO
7;De OAS3-specificatie is getest voor toepasbaarheid in de mainstream code-generatoren;Yes (`1 <https://github.com/maykinmedia/objects-api/actions?query=workflow%3Agenerate-sdks>`__, `2 <https://github.com/maykinmedia/objecttypes-api/actions?query=workflow%3Agenerate-sdks>`__);
Expand All @@ -70,7 +70,7 @@ for both APIs. This checklist is only available in Dutch.
:delim: ;

1;API-standaard is geïmplementeerd in een referentieimplementatie indien voor de standaard meerdere providers van toepassing kunnen zijn;Yes (`1 <https://github.com/maykinmedia/objects-api/>`__, `2 <https://github.com/maykinmedia/objecttypes-api/>`__);
2;Testgevallen zijn beschreven voor elke service/operatie en aanvullende specificaties, zowel voor de happy als de unhappy flows;Yes (`1 <https://travis-ci.com/maykinmedia/objects-api>`__, `2 <https://travis-ci.com/maykinmedia/objecttypes-api>`__);
2;Testgevallen zijn beschreven voor elke service/operatie en aanvullende specificaties, zowel voor de happy als de unhappy flows;Yes (`1 <https://github.com/maykinmedia/objects-api/actions>`__, `2 <https://github.com/maykinmedia/objecttypes-api/actions>`__);
3;Elk testgeval beschrijft het logische testgeval, de teststap(pen) (wat wordt gedaan) en het verwachte resultaat;No;Unclear
4;Er zijn compliancy tests beschikbaar voor elke referentie-component (consumers en providers) en alle betreffende services en operaties, zodat leveranciers kunnen testen en aantonen dat hun applicatie voldoet aan de standaard;No;TODO
5;Voor zover nodig is ook de testdata beschreven die wordt gebruikt in de testgevallen;No;See 5.4.
Expand Down
4 changes: 2 additions & 2 deletions docs/api/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
API-specifications
==================

The Objects API and Objecttypes API are scheduled to be a `recommended standard
The Objects API and Objecttypes API are scheduled to be a `recommended standard
as of March 1, 2022`_. Their specifications can be found below.

====================== ==========================================
Expand All @@ -22,7 +22,7 @@ API Specification version(s)

See their respective repositories for the latest and previous versions.

.. _`recommended standard as of March 1, 2022`: https://www.vngrealisatie.nl/nieuws/twee-nieuwe-standaardverklaringen-deze-apis-maken-het-samenwerken-makkelijker-2022
.. _`recommended standard as of March 1, 2022`: https://commonground.nl/news/view/0d7ff0a6-e960-412b-9a83-33bb1810c67d/twee-nieuwe-standaardverklaringen-deze-apis-maken-het-samenwerken-makkelijker-in-2022
.. _`Objecttypes API`: https://github.com/maykinmedia/objecttypes-api
.. _`Objects API`: https://github.com/maykinmedia/objects-api

Expand Down
4 changes: 4 additions & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -79,8 +79,12 @@

todo_include_todos = True

linkcheck_timeout = 10
linkcheck_ignore = [
r"https?://.*\.gemeente.nl",
r"http://localhost:\d+/",
r"https://.*sentry.*",
"https://github.com/maykinmedia/objects-api-performance",
"https://objects.municipality.nl/admin/",
"https://sparxsystems.com/products/ea/trial/request.html", # this raises 403 for crawlers probably?
]
26 changes: 13 additions & 13 deletions docs/examples/objecttype-vordering.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,13 @@ Vordering (Debt claim)
======================

The "Vordering" objecttype is converted from an existing information model from
the `Gemeentelijke Basisprocessen Inkomen`_ (GBI). The GBI gemeenten work
the `Gemeentelijke Basisprocessen Inkomen`_ (GBI). The GBI gemeenten work
together to create common proceses and models for the work-and-income domain.

As a test, they created a JSON schema for debt claims from their (huge)
As a test, they created a JSON schema for debt claims from their (huge)
:download:`ontology <_assets/vordering-ontology.png>`.

.. _`Gemeentelijke Basisprocessen Inkomen`: https://gbi-gemeenten.nl/
.. _`Gemeentelijke Basisprocessen Inkomen`: https://commonground.nl/groups/view/ea69810c-b776-489d-ae9b-8f0722db54fd/team-gemeentelijke-basisprocessen-inkomen-gbi

Metadata
========
Expand All @@ -21,27 +21,27 @@ Attribute Value
======================== ==========================
name vordering
namePlural vorderingen
description
labels
description
labels
maintainerOrganization GBI
maintainerDepartment
maintainerDepartment
contactPerson Geurt-jan van Renswoude
contactEmail [email protected]
providerOrganization
source
providerOrganization
source
status draft
dataClassification open
createdAt August 27, 2020
modifiedAt
publishedAt
updateFrequency
documentationUrl
modifiedAt
publishedAt
updateFrequency
documentationUrl
======================== ==========================

Schema
======

You can download the JSON schema
You can download the JSON schema
:download:`vordering.json <_assets/vordering.json>` or view it below:

.. include:: _assets/vordering.json
Expand Down
76 changes: 32 additions & 44 deletions docs/installation/config_cli.rst
Original file line number Diff line number Diff line change
Expand Up @@ -37,38 +37,37 @@ Objecttypes configuration
To configure objecttypes the following configuration could be used:

.. code-block:: yaml

...
zgw_consumers_config_enable: true
zgw_consumers:
services:
- identifier: objecttypen-foo
label: Objecttypen API Foo
api_root: http://objecttypen.foo/api/v1/
api_type: orc
auth_type: api_key
header_key: Authorization
header_value: Token ba9d233e95e04c4a8a661a27daffe7c9bd019067

- identifier: objecttypen-bar
label: Objecttypen API Bar
api_root: http://objecttypen.bar/api/v1/
api_type: orc
auth_type: api_key
header_key: Authorization
header_value: Token b9f100590925b529664ed9d370f5f8da124b2c20

objecttypes_config_enable: true
objecttypes:
items:
- uuid: b427ef84-189d-43aa-9efd-7bb2c459e281
name: Object Type 1
service_identifier: objecttypen-foo

- uuid: b0e8553f-8b1a-4d55-ab90-6d02f1bcf2c2
name: Object Type 2
service_identifier: objecttypen-bar
...

zgw_consumers_config_enable: true
zgw_consumers:
services:
- identifier: objecttypen-foo
label: Objecttypen API Foo
api_root: http://objecttypen.foo/api/v1/
api_type: orc
auth_type: api_key
header_key: Authorization
header_value: Token ba9d233e95e04c4a8a661a27daffe7c9bd019067

- identifier: objecttypen-bar
label: Objecttypen API Bar
api_root: http://objecttypen.bar/api/v1/
api_type: orc
auth_type: api_key
header_key: Authorization
header_value: Token b9f100590925b529664ed9d370f5f8da124b2c20

objecttypes_config_enable: true
objecttypes:
items:
- uuid: b427ef84-189d-43aa-9efd-7bb2c459e281
name: Object Type 1
service_identifier: objecttypen-foo

- uuid: b0e8553f-8b1a-4d55-ab90-6d02f1bcf2c2
name: Object Type 2
service_identifier: objecttypen-bar
...

.. note:: The ``uuid`` field will be used to lookup existing ``ObjectType``'s.

Expand All @@ -84,7 +83,6 @@ created. An example of a configuration could be seen below:

.. code-block:: yaml

...
zgw_consumers_config_enable: true
zgw_consumers:
services:
Expand All @@ -104,16 +102,14 @@ created. An example of a configuration could be seen below:
auth_type: api_key
header_key: Authorization
header_value: Token b9f100590925b529664ed9d370f5f8da124b2c20
...


Tokens configuration
--------------------
Create or update the (single) YAML configuration file with your settings:

.. code-block:: yaml

...

tokenauth_config_enable: true
tokenauth:
items:
Expand All @@ -140,7 +136,6 @@ Create or update the (single) YAML configuration file with your settings:
'1':
- record__data__leeftijd
- record__data__kiemjaar
...

.. note:: To ensure the proper functioning of the tokens, it is essential to first configure the ``objecttypes``.
Then, the token configuration must be completed to guarantee the correct configuration of the ``Permissions``.
Expand All @@ -153,7 +148,6 @@ Create or update the (single) YAML configuration file with your settings:

.. code-block:: yaml

...
oidc_db_config_enable: true
oidc_db_config_admin_auth:
items:
Expand All @@ -167,7 +161,6 @@ Create or update the (single) YAML configuration file with your settings:

# workaround for https://github.com/maykinmedia/django-setup-configuration/issues/27
userinfo_claims_source: id_token
...

More details about configuring mozilla-django-oidc-db through ``setup_configuration``
can be found at the _`documentation`: https://mozilla-django-oidc-db.readthedocs.io/en/latest/setup_configuration.html.
Expand All @@ -177,15 +170,13 @@ Sites configuration

.. code-block:: yaml

...
sites_config_enable: true
sites_config:
items:
- domain: example.com
name: Example site
- domain: test.example.com
name: Test site
...

More details about sites configuration through ``setup_configuration``
can be found at the _`site documentation`: https://github.com/maykinmedia/django-setup-configuration/blob/main/docs/sites_config.rst
Expand All @@ -200,7 +191,6 @@ item present that matches the ``notifications_api_service_identifier`` in the

.. code-block:: yaml

...
zgw_consumers_config_enable: true
zgw_consumers:
services:
Expand All @@ -217,8 +207,6 @@ item present that matches the ``notifications_api_service_identifier`` in the
notification_delivery_max_retries: 1
notification_delivery_retry_backoff: 2
notification_delivery_retry_backoff_max: 3
...


Execution
=========
Expand Down
4 changes: 2 additions & 2 deletions docs/introduction/information-model.rst
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,9 @@ changing the material history.
Links
=====

* `Enterprise Architect (lite) <https://www.sparxsystems.eu/enterprise-architect/ea-lite-edition/>`__
* `Enterprise Architect (lite) <https://sparxsystems.com/products/ea/trial/request.html>`__
* :download:`Object and Objecttypes information model <_assets/information-model.zip>`
* `MIM-files <https://register.geostandaarden.nl/informatiemodel/mim/>`__

.. _`Metamodel Informatiemodellering`: https://www.geonovum.nl/geo-standaarden/metamodel-informatiemodellering-mim
.. _`StUF`: https://www.gemmaonline.nl/images/gemmaonline/f/fa/Stuf0301.pdf
.. _`StUF`: https://vng-realisatie.github.io/StUF-onderlaag/documenten/Stuf0301.pdf
6 changes: 6 additions & 0 deletions requirements/ci.in
Original file line number Diff line number Diff line change
@@ -1,2 +1,8 @@
codecov
pytest

# Documentation
sphinx
sphinx-rtd-theme
sphinx-tabs
recommonmark
Loading
Loading