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

document auth property in webhooks section of processing chain #411

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
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
7 changes: 7 additions & 0 deletions src/actinia_core/models/process_chain.py
Original file line number Diff line number Diff line change
Expand Up @@ -466,6 +466,11 @@ class Webhooks(Schema):
"""
type = 'object'
properties = {
'auth': {'type': 'string',
'description': 'Authentication information (username and password) '
'to authenticate to the webhook url. Given as '
'"username:password" string. The username and '
'password should not contain a ":".'},
'update': {'type': 'string',
'description': 'Specify a HTTP(S) GET/POST endpoint that should be '
'called when a status update is available while the '
Expand Down Expand Up @@ -496,6 +501,7 @@ class Webhooks(Schema):
'will be used to check if the webhooks endpoints are available.'
'The finished endpoint is mandatory, the update endpoint is optional.')
example = {
'auth': 'username:password',
'update': f'http://business-logic.company.com{URL_PREFIX}/'
'actinia-update-webhook',
'finished': f'http://business-logic.company.com{URL_PREFIX}/'
Expand Down Expand Up @@ -617,6 +623,7 @@ class ProcessChainModel(Schema):
}
],
'webhooks': {
'auth': 'username:password',
'update': f'http://business-logic.company.com{URL_PREFIX}/'
'actinia-update-webhook',
'finished': f'http://business-logic.company.com{URL_PREFIX}/'
Expand Down