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.

Sign up for GitHub

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

Jump to bottom

ODRC: add Documenten API to the stack #18

Closed
3 tasks done
Tracked by #1
sergei-maertens opened this issue Sep 3, 2024 · 0 comments · Fixed by #42
Closed
3 tasks done
Tracked by #1

ODRC: add Documenten API to the stack #18

sergei-maertens opened this issue Sep 3, 2024 · 0 comments · Fixed by #42
Milestone
Plateau 0 (MVP)

Comments

@sergei-maertens
Copy link
Contributor

sergei-maertens commented Sep 3, 2024 •
edited
Loading

It was decided we will store the document data (and a bunch of metadata) in the existing VNG Documenten API. For local development/testing, we can use Open Zaak for this, for production usage this is also possible but other implementations exist.

This makes it possible for us to support large file uploads (chunks) out of the box, and we will also design the interaction from ODPC -> ODRC -> Documenten API around the large file uploads mechanism from the get-go.

The biggest challenge this poses, is implementing the Catalogi API parts in ODRC to be consumed by the Documenten API.

Tasks

  • Add Open Zaak (pre-configured with Documenten API) to the docker compose stack
  • Implement the /catalogi/api/v1/informatieobjecttypen/:uuid detail endpoint for each informatiecategorie exposed by the ODRC
    • include the properties url, catalogus (can be fixed/dummy), omschrijving, vertrouwelijkheidaanduiding (set to openbaar, by definition of WOO), beginGeldigheid, informatieobjectcategorie - these are the required properties
    • decide on authentication requirements
  • Ensure this setup works with http://localhost:800x (host system) URLs but also with internal docker hosts
@RutgerICATT RutgerICATT added this to the ODRC: Basis milestone Sep 3, 2024
@sergei-maertens sergei-maertens self-assigned this Sep 3, 2024
@MarcoKlerks MarcoKlerks moved this to Ready in GPP-Woo Sep 11, 2024
@sergei-maertens sergei-maertens mentioned this issue Sep 18, 2024
Closed
4 tasks
sergei-maertens added a commit that referenced this issue Sep 18, 2024
@sergei-maertens
🐳 [#18] Expose host.docker.internal inside containers
acbab87
sergei-maertens added a commit that referenced this issue Sep 18, 2024
@sergei-maertens
🐳 [#18] Add Open Zaak to compose stack
5d2c15a 
* Switched DB image to a version with postgis for Open Zaak
* Added (default) Open Zaak 1.14 to compose (web, celery)
* Wired up the DB initialiation scripts to create the OZ
  db
* Set up dependencies with redis/DB
* Added host.docker.internal gateway to extra hosts
sergei-maertens added a commit that referenced this issue Sep 18, 2024
@sergei-maertens
🍱 [#18] Dump Open Zaak configuration fixture
0e6b65d 
The configuration includes:

* Disabled all APIs that are not relevant (only Documenten API is
  relevant)
* Added API client/application for WOO Publications to use
* Added service definition from OZ -> WooP, currently without credentials
sergei-maertens added a commit that referenced this issue Sep 18, 2024
@sergei-maertens
🐳 [#18] Add WooP fixture so it can talk to Open Zaak
10028fd
sergei-maertens added a commit that referenced this issue Sep 18, 2024
@sergei-maertens
🧑‍💻 [#18] Add system check for host.docker.internal DNS name
6098f11
@sergei-maertens sergei-maertens mentioned this issue Sep 18, 2024
Merged
sergei-maertens added a commit that referenced this issue Sep 18, 2024
@sergei-maertens
🧑‍💻 [#18] Add system check for host.docker.internal DNS name
d95348b
sergei-maertens added a commit that referenced this issue Sep 18, 2024
@sergei-maertens
🍱 [#18] Dump Open Zaak configuration fixture
e49de12 
The configuration includes:

* Disabled all APIs that are not relevant (only Documenten API is
  relevant)
* Added API client/application for WOO Publications to use
* Added service definition from OZ -> WooP, currently without credentials
sergei-maertens added a commit that referenced this issue Sep 18, 2024
@sergei-maertens
🐳 [#18] Add WooP fixture so it can talk to Open Zaak
38309e5
sergei-maertens added a commit that referenced this issue Sep 18, 2024
@sergei-maertens
🧑‍💻 [#18] Add system check for host.docker.internal DNS name
75dd4c9
sergei-maertens added a commit that referenced this issue Sep 18, 2024
@sergei-maertens
➕ [#18] Ensure that the zgw-consumers testutils extra is installed
0988071 
Otherwise importing zgw_consumers.test fails in CI due to missing
dependencies
sergei-maertens added a commit that referenced this issue Sep 18, 2024
@sergei-maertens
🤡 [#18] Set up dummy API endpoint for informatieobjecttype
2377bc9
sergei-maertens added a commit that referenced this issue Sep 19, 2024
@sergei-maertens
🐳 [#18] Fix docker setup with Open Zaak hostname
4e06d8e 
Open Zaak and WooP can't share the host.docker.internal hostname in
ALLOWED_HOSTS, as that makes Open Zaak treat the
host.docker.internal:8000 URLs as internal (while they are external
and provided by the WooP backend).

The simplest workaround for this is to add an additional network alias
pointing to the same IP address, and expect developers to set up the
host name in their /etc/hosts file.
sergei-maertens added a commit that referenced this issue Sep 19, 2024
@sergei-maertens
🤡 [#18] Set up dummy API endpoint for informatieobjecttype
e7c1253
sergei-maertens added a commit that referenced this issue Sep 19, 2024
@sergei-maertens
👽 [#18] Patch broken envvar settings in Open Zaak 1.14
e66c9e7 
See upstream issue: open-zaak/open-zaak#1780
sergei-maertens added a commit that referenced this issue Sep 19, 2024
@sergei-maertens
🍱 [#18] Update generated API schema
60f210d
@sergei-maertens sergei-maertens moved this from In progress to In review in GPP-Woo Sep 19, 2024
sergei-maertens added a commit that referenced this issue Sep 20, 2024
@sergei-maertens
🤡 [#18] Set up dummy API endpoint for informatieobjecttype
372595a
sergei-maertens added a commit that referenced this issue Sep 20, 2024
@sergei-maertens
👽 [#18] Patch broken envvar settings in Open Zaak 1.14
545834a 
See upstream issue: open-zaak/open-zaak#1780
sergei-maertens added a commit that referenced this issue Sep 20, 2024
@sergei-maertens
🍱 [#18] Update generated API schema
b12858d
@github-project-automation github-project-automation bot moved this from In review to Done in GPP-Woo Sep 20, 2024
@MarcoKlerks MarcoKlerks added this to the Plateau 0 (MVP) milestone Dec 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
GPP-Woo
Status: Done
Milestone
Plateau 0 (MVP)
Development

Successfully merging a pull request may close this issue.

Add Documenten API to compose stack GPP-Woo/GPP-publicatiebank
3 participants
@sergei-maertens @MarcoKlerks @RutgerICATT