Skip to content

Commit

Permalink
refactor: add authHeaderName to zaak-dms endpoints
Browse files Browse the repository at this point in the history
  • Loading branch information
MLenterman committed Oct 29, 2024
1 parent 7c6909b commit 97becf8
Show file tree
Hide file tree
Showing 5 changed files with 45 additions and 16 deletions.
6 changes: 3 additions & 3 deletions charts/openforms2xxllnc/Chart.lock
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
dependencies:
- name: ff-common
repository: https://frankframework.github.io/charts/
version: 0.1.23
digest: sha256:e67ce36ad46eb71980444486049c60cca10d0239f08382f443ff0272a3c6276e
generated: "2024-08-02T11:20:30.8207808+02:00"
version: 0.1.24
digest: sha256:afb8e8490d3986457eb76ec6b20dfc44cb83866895195548abe245c09b270b65
generated: "2024-10-29T12:18:37.9252747+01:00"
14 changes: 9 additions & 5 deletions charts/openforms2xxllnc/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -197,13 +197,17 @@ Otherwise, they can be found at `/usr/local/tomcat/logs`
| ------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------- | ------------- |
| `openforms2xxllnc.connections.beantwoordVraag.endpoint` | Endpoint at which the zs-dms BeantwoordVraag binding is served. | `""` |
| `openforms2xxllnc.connections.beantwoordVraag.timeout` | Timeout used zs-dms BeantwoordVraag calls. | `60000` |
| `openforms2xxllnc.connections.beantwoordVraag.authAlias` | AuthAlias used zs-dms BeantwoordVraag calls. | `zaakdms-api` |
| `openforms2xxllnc.connections.beantwoordVraag.authAlias` | Reference to an auth alias to be used as credentials for communication with this endpoint. | `""` |
| `openforms2xxllnc.connections.beantwoordVraag.authHeaderName` | Name of the HTTP request header to provide authentication credentials in. | `""` |
| `openforms2xxllnc.connections.ontvangAsynchroon.endpoint` | Endpoint at which the zs-dms OntvangAsynchroon binding is served. | `""` |
| `openforms2xxllnc.connections.ontvangAsynchroon.timeout` | Timeout used zs-dms OntvangAsynchroon calls. | `60000` |
| `openforms2xxllnc.connections.ontvangAsynchroon.authAlias` | AuthAlias used zs-dms OntvangAsynchroon calls. | `zaakdms-api` |
| `openforms2xxllnc.connections.ontvangAsynchroon.authAlias` | Reference to an auth alias to be used as credentials for communication with this endpoint. | `""` |
| `openforms2xxllnc.connections.ontvangAsynchroon.authHeaderName` | Name of the HTTP request header to provide authentication credentials in. | `""` |
| `openforms2xxllnc.connections.vrijeBerichten.endpoint` | Endpoint at which the zs-dms VrijBericht binding is served. | `""` |
| `openforms2xxllnc.connections.vrijeBerichten.timeout` | Timeout used zs-dms VrijBericht calls. | `60000` |
| `openforms2xxllnc.connections.vrijeBerichten.authAlias` | AuthAlias used zs-dms VrijBericht calls. | `zaakdms-api` |
| `openforms2xxllnc.connections.vrijeBerichten.authAlias` | Reference to an auth alias to be used as credentials for communication with this endpoint. | `""` |
| `openforms2xxllnc.connections.vrijeBerichten.authHeaderName` | Name of the HTTP request header to provide authentication credentials in. | `""` |
| `openforms2xxllnc.connections.notificatiesApi.rootUrl` | Root url of the 'Notificaties API' that is used to subscribe at. | `""` |
| `openforms2xxllnc.connections.notificatiesApi.timeout` | Timeout used in 'Notificaties API' calls. | `60000` |
| `openforms2xxllnc.connections.notificatiesApi.authType` | Options: 'jwt', 'basic', 'value'. 'value' uses the password field of the given authAlias as Authorization header. | `""` |
Expand Down Expand Up @@ -263,11 +267,11 @@ Otherwise, they can be found at `/usr/local/tomcat/logs`
| `openforms2xxllnc.workflows.scheduledStartReceiver.workflowSelector.cronExpression` | Cron expression used to schedule starting the receiver of this specific workflow. | `""` |
| `openforms2xxllnc.workflows.scheduledStopReceiver.workflowSelector.enabled` | Enable scheduled stop the receiver of this specific workflow. | `false` |
| `openforms2xxllnc.workflows.scheduledStopReceiver.workflowSelector.cronExpression` | Cron expression used to schedule stopping the receiver of this specific workflow. | `""` |
| `openforms2xxllnc.workflows.onErrorActions.onCaseNotFound.sendEmail` | Enable sending a mail to the form initiator when this specific error occurs. | `false` |
| `openforms2xxllnc.workflows.onErrorActions.onCaseNotFound.sendMail` | Enable sending a mail to the form initiator when this specific error occurs. | `false` |
| `openforms2xxllnc.workflows.onErrorActions.onCaseNotFound.templateName` | Name of the mail template to be used when this specific error occurs. | `""` |
| `openforms2xxllnc.workflows.onErrorActions.onSubjectNotEqualsCaseSubject.sendEmail` | Enable sending a mail to the form initiator when this specific error occurs. | `false` |
| `openforms2xxllnc.workflows.onErrorActions.onSubjectNotEqualsCaseSubject.sendMail` | Enable sending a mail to the form initiator when this specific error occurs. | `false` |
| `openforms2xxllnc.workflows.onErrorActions.onSubjectNotEqualsCaseSubject.templateName` | Name of the mail template to be used when this specific error occurs. | `""` |
| `openforms2xxllnc.workflows.onErrorActions.onCaseClosed.sendEmail` | Enable sending a mail to the form initiator when this specific error occurs. | `false` |
| `openforms2xxllnc.workflows.onErrorActions.onCaseClosed.sendMail` | Enable sending a mail to the form initiator when this specific error occurs. | `false` |
| `openforms2xxllnc.workflows.onErrorActions.onCaseClosed.templateName` | Name of the mail template to be used when this specific error occurs. | `""` |

## Configuration and installation details
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,16 +11,19 @@ data:
openforms2xxllnc.connections.beantwoord-vraag.endpoint: "{{ .endpoint }}"
openforms2xxllnc.connections.beantwoord-vraag.timeout: "{{ .timeout }}"
openforms2xxllnc.connections.beantwoord-vraag.auth-alias: "{{ .authAlias }}"
openforms2xxllnc.connections.beantwoord-vraag.auth-header-name: "{{ .authHeaderName }}"
{{- end }}
{{- with .ontvangAsynchroon }}
openforms2xxllnc.connections.ontvang-asynchroon.endpoint: "{{ .endpoint }}"
openforms2xxllnc.connections.ontvang-asynchroon.timeout: "{{ .timeout }}"
openforms2xxllnc.connections.ontvang-asynchroon.auth-alias: "{{ .authAlias }}"
openforms2xxllnc.connections.ontvang-asynchroon.auth-header-name: "{{ .authHeaderName }}"
{{- end }}
{{- with .vrijeBerichten }}
openforms2xxllnc.connections.vrije-berichten.endpoint: "{{ .endpoint }}"
openforms2xxllnc.connections.vrije-berichten.timeout: "{{ .timeout }}"
openforms2xxllnc.connections.vrije-berichten.auth-alias: "{{ .authAlias }}"
openforms2xxllnc.connections.vrije-berichten.auth-header-name: "{{ .authHeaderName }}"
{{- end }}

{{- with .notificatiesApi }}
Expand Down
27 changes: 21 additions & 6 deletions charts/openforms2xxllnc/values.schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -556,8 +556,13 @@
},
"authAlias": {
"type": "string",
"description": "AuthAlias used zs-dms BeantwoordVraag calls.",
"description": "Reference to an auth alias to be used as credentials for communication with this endpoint.",
"default": "zaakdms-api"
},
"authHeaderName": {
"type": "string",
"description": "Name of the HTTP request header to provide authentication credentials in.",
"default": "Authorization"
}
}
},
Expand All @@ -576,8 +581,13 @@
},
"authAlias": {
"type": "string",
"description": "AuthAlias used zs-dms OntvangAsynchroon calls.",
"description": "Reference to an auth alias to be used as credentials for communication with this endpoint.",
"default": "zaakdms-api"
},
"authHeaderName": {
"type": "string",
"description": "Name of the HTTP request header to provide authentication credentials in.",
"default": "Authorization"
}
}
},
Expand All @@ -596,8 +606,13 @@
},
"authAlias": {
"type": "string",
"description": "AuthAlias used zs-dms VrijBericht calls.",
"description": "Reference to an auth alias to be used as credentials for communication with this endpoint.",
"default": "zaakdms-api"
},
"authHeaderName": {
"type": "string",
"description": "Name of the HTTP request header to provide authentication credentials in.",
"default": "Authorization"
}
}
},
Expand Down Expand Up @@ -923,7 +938,7 @@
"onCaseNotFound": {
"type": "object",
"properties": {
"sendEmail": {
"sendMail": {
"type": "boolean",
"description": "Enable sending a mail to the form initiator when this specific error occurs.",
"default": false
Expand All @@ -938,7 +953,7 @@
"onSubjectNotEqualsCaseSubject": {
"type": "object",
"properties": {
"sendEmail": {
"sendMail": {
"type": "boolean",
"description": "Enable sending a mail to the form initiator when this specific error occurs.",
"default": false
Expand All @@ -953,7 +968,7 @@
"onCaseClosed": {
"type": "object",
"properties": {
"sendEmail": {
"sendMail": {
"type": "boolean",
"description": "Enable sending a mail to the form initiator when this specific error occurs.",
"default": false
Expand Down
11 changes: 9 additions & 2 deletions charts/openforms2xxllnc/values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -449,30 +449,37 @@ openforms2xxllnc:
## @skip openforms2xxllnc.connections.beantwoordVraag [object]
## @param openforms2xxllnc.connections.beantwoordVraag.endpoint [string] Endpoint at which the zs-dms BeantwoordVraag binding is served.
## @param openforms2xxllnc.connections.beantwoordVraag.timeout Timeout used zs-dms BeantwoordVraag calls.
## @param openforms2xxllnc.connections.beantwoordVraag.authAlias AuthAlias used zs-dms BeantwoordVraag calls.
## @param openforms2xxllnc.connections.beantwoordVraag.authAlias [string] Reference to an auth alias to be used as credentials for communication with this endpoint.
## @param openforms2xxllnc.connections.beantwoordVraag.authHeaderName [string] Name of the HTTP request header to provide authentication credentials in.
##
beantwoordVraag:
endpoint: "https://zs-dms/generic/zds/BeantwoordVraag"
timeout: 60000
authAlias: "zaakdms-api"
authHeaderName: "Authorization"
## @skip openforms2xxllnc.connections.ontvangAsynchroon [object]
## @param openforms2xxllnc.connections.ontvangAsynchroon.endpoint [string] Endpoint at which the zs-dms OntvangAsynchroon binding is served.
## @param openforms2xxllnc.connections.ontvangAsynchroon.timeout Timeout used zs-dms OntvangAsynchroon calls.
## @param openforms2xxllnc.connections.ontvangAsynchroon.authAlias AuthAlias used zs-dms OntvangAsynchroon calls.
## @param openforms2xxllnc.connections.ontvangAsynchroon.authAlias [string] Reference to an auth alias to be used as credentials for communication with this endpoint.
## @param openforms2xxllnc.connections.ontvangAsynchroon.authHeaderName [string] Name of the HTTP request header to provide authentication credentials in.
##
ontvangAsynchroon:
endpoint: "https://zs-dms/generic/zds/OntvangAsynchroon"
timeout: 60000
authAlias: "zaakdms-api"
authHeaderName: "Authorization"
## @skip openforms2xxllnc.connections.vrijeBerichten [object]
## @param openforms2xxllnc.connections.vrijeBerichten.endpoint [string] Endpoint at which the zs-dms VrijBericht binding is served.
## @param openforms2xxllnc.connections.vrijeBerichten.timeout Timeout used zs-dms VrijBericht calls.
## @param openforms2xxllnc.connections.vrijeBerichten.authAlias AuthAlias used zs-dms VrijBericht calls.
## @param openforms2xxllnc.connections.vrijeBerichten.authAlias [string] Reference to an auth alias to be used as credentials for communication with this endpoint.
## @param openforms2xxllnc.connections.vrijeBerichten.authHeaderName [string] Name of the HTTP request header to provide authentication credentials in.
##
vrijeBerichten:
endpoint: "https://zs-dms/generic/zds/VrijBericht"
timeout: 60000
authAlias: "zaakdms-api"
authHeaderName: "Authorization"
## @skip openforms2xxllnc.connections.notificatiesApi [object]
## @param openforms2xxllnc.connections.notificatiesApi.rootUrl [string] Root url of the 'Notificaties API' that is used to subscribe at.
## @param openforms2xxllnc.connections.notificatiesApi.timeout Timeout used in 'Notificaties API' calls.
Expand Down

0 comments on commit 97becf8

Please sign in to comment.