mirror/netbox-community-netbox
1
0
Fork 0
mirror of https://github.com/netbox-community/netbox.git synced 2024-05-10 07:54:54 +00:00
Code Activity

Miscellaneous cleanup of the Webhook model

Browse Source
This commit is contained in:
Jeremy Stretch
2018-05-30 13:59:00 -04:00
parent 8762f1314d
commit 503efe2d9d
2 changed files with 23 additions and 21 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
netbox/extras/migrations/0012_webhooks.py
View File

@ -1,5 +1,5 @@
# -*- coding: utf-8 -*- # -*- coding: utf-8 -*-
# Generated by Django 1.11.10 on 2018-05-23 16:35 # Generated by Django 1.11.12 on 2018-05-30 17:55
from __future__ import unicode_literals from __future__ import unicode_literals
from django.db import migrations, models from django.db import migrations, models
@ -18,15 +18,15 @@ class Migration(migrations.Migration):
fields=[ fields=[
('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')), ('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
('name', models.CharField(max_length=150, unique=True)), ('name', models.CharField(max_length=150, unique=True)),
('type_create', models.BooleanField(default=False, help_text='A POST will be sent to the URL when the object type(s) is created.')), ('type_create', models.BooleanField(default=False, help_text='Call this webhook when a matching object is created.')),
('type_update', models.BooleanField(default=False, help_text='A POST will be sent to the URL when the object type(s) is updated.')), ('type_update', models.BooleanField(default=False, help_text='Call this webhook when a matching object is updated.')),
('type_delete', models.BooleanField(default=False, help_text='A POST will be sent to the URL when the object type(s) is deleted.')), ('type_delete', models.BooleanField(default=False, help_text='Call this webhook when a matching object is deleted.')),
('payload_url', models.CharField(max_length=500, verbose_name='A POST will be sent to this URL based on the webhook criteria.')), ('payload_url', models.CharField(help_text='A POST will be sent to this URL when the webhook is called.', max_length=500, verbose_name='URL')),
('http_content_type', models.PositiveSmallIntegerField(choices=[(1, 'application/json'), (2, 'application/x-www-form-urlencoded')], default=1)), ('http_content_type', models.PositiveSmallIntegerField(choices=[(1, 'application/json'), (2, 'application/x-www-form-urlencoded')], default=1)),
('secret', models.CharField(blank=True, help_text="When provided the request will include a 'X-Hook-Signature' header which is a HMAC hex digest of the payload body using the secret as the key. The secret is not transmitted in the request.", max_length=255)), ('secret', models.CharField(blank=True, help_text="When provided, the request will include a 'X-Hook-Signature' header containing a HMAC hex digest of the payload body using the secret as the key. The secret is not transmitted in the request.", max_length=255)),
('enabled', models.BooleanField(default=True)), ('enabled', models.BooleanField(default=True)),
('ssl_verification', models.BooleanField(default=True, help_text='By default, use of proper SSL is verified. Disable with caution!')), ('ssl_verification', models.BooleanField(default=True, help_text='Enable SSL certificate verification. Disable with caution!')),
('obj_type', models.ManyToManyField(help_text='The object(s) to which this Webhook applies.', related_name='webhooks', to='contenttypes.ContentType', verbose_name='Object(s)')), ('obj_type', models.ManyToManyField(help_text='The object(s) to which this Webhook applies.', related_name='webhooks', to='contenttypes.ContentType', verbose_name='Object types')),
], ],
), ),
migrations.AlterUniqueTogether( migrations.AlterUniqueTogether(

28
netbox/extras/models.py
View File

@ -25,16 +25,18 @@ from .constants import *
# Webhooks # Webhooks
# #
@python_2_unicode_compatible
class Webhook(models.Model): class Webhook(models.Model):
""" """
Webhook model that represents all the details for an endoint and how to make a request to A Webhook defines a request that will be sent to a remote application when an object is created, updated, and/or
that endpoint with the configured payload. delete in NetBox. The request will contain a representation of the object, which the remote application can act on.
Each Webhook can be limited to firing only on certain actions or certain object types.
""" """
obj_type = models.ManyToManyField( obj_type = models.ManyToManyField(
ContentType, to=ContentType,
related_name='webhooks', related_name='webhooks',
verbose_name='Object(s)', verbose_name='Object types',
limit_choices_to={'model__in': WEBHOOK_MODELS}, limit_choices_to={'model__in': WEBHOOK_MODELS},
help_text="The object(s) to which this Webhook applies." help_text="The object(s) to which this Webhook applies."
) )
@ -44,19 +46,20 @@ class Webhook(models.Model):
) )
type_create = models.BooleanField( type_create = models.BooleanField(
default=False, default=False,
help_text="A POST will be sent to the URL when the object type(s) is created." help_text="Call this webhook when a matching object is created."
) )
type_update = models.BooleanField( type_update = models.BooleanField(
default=False, default=False,
help_text="A POST will be sent to the URL when the object type(s) is updated." help_text="Call this webhook when a matching object is updated."
) )
type_delete = models.BooleanField( type_delete = models.BooleanField(
default=False, default=False,
help_text="A POST will be sent to the URL when the object type(s) is deleted." help_text="Call this webhook when a matching object is deleted."
) )
payload_url = models.CharField( payload_url = models.CharField(
max_length=500, max_length=500,
verbose_name="A POST will be sent to this URL based on the webhook criteria." verbose_name='URL',
help_text="A POST will be sent to this URL when the webhook is called."
) )
http_content_type = models.PositiveSmallIntegerField( http_content_type = models.PositiveSmallIntegerField(
choices=WEBHOOK_CT_CHOICES, choices=WEBHOOK_CT_CHOICES,
@ -65,8 +68,8 @@ class Webhook(models.Model):
secret = models.CharField( secret = models.CharField(
max_length=255, max_length=255,
blank=True, blank=True,
help_text="When provided the request will include a 'X-Hook-Signature' " help_text="When provided, the request will include a 'X-Hook-Signature' "
"header which is a HMAC hex digest of the payload body using " "header containing a HMAC hex digest of the payload body using "
"the secret as the key. The secret is not transmitted in " "the secret as the key. The secret is not transmitted in "
"the request." "the request."
) )
@ -75,7 +78,7 @@ class Webhook(models.Model):
) )
ssl_verification = models.BooleanField( ssl_verification = models.BooleanField(
default=True, default=True,
help_text="By default, use of proper SSL is verified. Disable with caution!" help_text="Enable SSL certificate verification. Disable with caution!"
) )
class Meta: class Meta:
@ -88,10 +91,9 @@ class Webhook(models.Model):
""" """
Validate model Validate model
""" """
if not self.type_create and not self.type_delete and not self.type_update: if not self.type_create and not self.type_delete and not self.type_update:
raise ValidationError( raise ValidationError(
"You must select at least one type. Either create, update, or delete." "You must select at least one type: create, update, and/or delete."
) )