From 6aa6471b7c2b34067addc19397992fb2148d1412 Mon Sep 17 00:00:00 2001 From: Jeff Bradberry Date: Fri, 27 Sep 2019 11:28:42 -0400 Subject: [PATCH] Add help_text to the new fields --- awx/main/migrations/0092_v360_webhook_mixin.py | 12 ++++++------ .../migrations/0094_v360_webhook_mixin2.py | 12 ++++++------ awx/main/models/credential/__init__.py | 2 ++ awx/main/models/mixins.py | 18 ++++++++++++------ 4 files changed, 26 insertions(+), 18 deletions(-) diff --git a/awx/main/migrations/0092_v360_webhook_mixin.py b/awx/main/migrations/0092_v360_webhook_mixin.py index 201fa5456a..8549cd06f9 100644 --- a/awx/main/migrations/0092_v360_webhook_mixin.py +++ b/awx/main/migrations/0092_v360_webhook_mixin.py @@ -14,32 +14,32 @@ class Migration(migrations.Migration): migrations.AddField( model_name='jobtemplate', name='webhook_credential', - field=models.ForeignKey(blank=True, null=True, on_delete=django.db.models.deletion.SET_NULL, related_name='jobtemplates', to='main.Credential'), + field=models.ForeignKey(blank=True, help_text='Personal Access Token for posting back the status to the service API', null=True, on_delete=django.db.models.deletion.SET_NULL, related_name='jobtemplates', to='main.Credential'), ), migrations.AddField( model_name='jobtemplate', name='webhook_key', - field=models.CharField(blank=True, max_length=64), + field=models.CharField(blank=True, help_text='Shared secret that the webhook service will use to sign requests', max_length=64), ), migrations.AddField( model_name='jobtemplate', name='webhook_service', - field=models.CharField(blank=True, choices=[('github', 'Github'), ('gitlab', 'Gitlab')], max_length=16), + field=models.CharField(blank=True, choices=[('github', 'Github'), ('gitlab', 'Gitlab')], help_text='Service that webhook requests will be accepted from', max_length=16), ), migrations.AddField( model_name='workflowjobtemplate', name='webhook_credential', - field=models.ForeignKey(blank=True, null=True, on_delete=django.db.models.deletion.SET_NULL, related_name='workflowjobtemplates', to='main.Credential'), + field=models.ForeignKey(blank=True, help_text='Personal Access Token for posting back the status to the service API', null=True, on_delete=django.db.models.deletion.SET_NULL, related_name='workflowjobtemplates', to='main.Credential'), ), migrations.AddField( model_name='workflowjobtemplate', name='webhook_key', - field=models.CharField(blank=True, max_length=64), + field=models.CharField(blank=True, help_text='Shared secret that the webhook service will use to sign requests', max_length=64), ), migrations.AddField( model_name='workflowjobtemplate', name='webhook_service', - field=models.CharField(blank=True, choices=[('github', 'Github'), ('gitlab', 'Gitlab')], max_length=16), + field=models.CharField(blank=True, choices=[('github', 'Github'), ('gitlab', 'Gitlab')], help_text='Service that webhook requests will be accepted from', max_length=16), ), migrations.AlterField( model_name='unifiedjob', diff --git a/awx/main/migrations/0094_v360_webhook_mixin2.py b/awx/main/migrations/0094_v360_webhook_mixin2.py index 9e93d27e20..133cab8c92 100644 --- a/awx/main/migrations/0094_v360_webhook_mixin2.py +++ b/awx/main/migrations/0094_v360_webhook_mixin2.py @@ -14,31 +14,31 @@ class Migration(migrations.Migration): migrations.AddField( model_name='job', name='webhook_credential', - field=models.ForeignKey(blank=True, null=True, on_delete=django.db.models.deletion.SET_NULL, related_name='jobs', to='main.Credential'), + field=models.ForeignKey(blank=True, help_text='Personal Access Token for posting back the status to the service API', null=True, on_delete=django.db.models.deletion.SET_NULL, related_name='jobs', to='main.Credential'), ), migrations.AddField( model_name='job', name='webhook_guid', - field=models.CharField(blank=True, max_length=128), + field=models.CharField(blank=True, help_text='Unique identifier of the event that triggered this webhook', max_length=128), ), migrations.AddField( model_name='job', name='webhook_service', - field=models.CharField(blank=True, choices=[('github', 'Github'), ('gitlab', 'Gitlab')], max_length=16), + field=models.CharField(blank=True, choices=[('github', 'Github'), ('gitlab', 'Gitlab')], help_text='Service that webhook requests will be accepted from', max_length=16), ), migrations.AddField( model_name='workflowjob', name='webhook_credential', - field=models.ForeignKey(blank=True, null=True, on_delete=django.db.models.deletion.SET_NULL, related_name='workflowjobs', to='main.Credential'), + field=models.ForeignKey(blank=True, help_text='Personal Access Token for posting back the status to the service API', null=True, on_delete=django.db.models.deletion.SET_NULL, related_name='workflowjobs', to='main.Credential'), ), migrations.AddField( model_name='workflowjob', name='webhook_guid', - field=models.CharField(blank=True, max_length=128), + field=models.CharField(blank=True, help_text='Unique identifier of the event that triggered this webhook', max_length=128), ), migrations.AddField( model_name='workflowjob', name='webhook_service', - field=models.CharField(blank=True, choices=[('github', 'Github'), ('gitlab', 'Gitlab')], max_length=16), + field=models.CharField(blank=True, choices=[('github', 'Github'), ('gitlab', 'Gitlab')], help_text='Service that webhook requests will be accepted from', max_length=16), ), ] diff --git a/awx/main/models/credential/__init__.py b/awx/main/models/credential/__init__.py index 939f824f25..042700b270 100644 --- a/awx/main/models/credential/__init__.py +++ b/awx/main/models/credential/__init__.py @@ -980,6 +980,7 @@ ManagedCredentialType( 'label': ugettext_noop('Token'), 'type': 'string', 'secret': True, + 'help_text': ugettext_noop('This token needs to come from your profile settings in Github') }], 'required': ['token'], }, @@ -996,6 +997,7 @@ ManagedCredentialType( 'label': ugettext_noop('Token'), 'type': 'string', 'secret': True, + 'help_text': ugettext_noop('This token needs to come from your profile settings in Gitlab') }], 'required': ['token'], }, diff --git a/awx/main/models/mixins.py b/awx/main/models/mixins.py index ff499c4f66..ed3e033af5 100644 --- a/awx/main/models/mixins.py +++ b/awx/main/models/mixins.py @@ -503,18 +503,21 @@ class WebhookTemplateMixin(models.Model): webhook_service = models.CharField( max_length=16, choices=SERVICES, - blank=True + blank=True, + help_text=_('Service that webhook requests will be accepted from') ) webhook_key = prevent_search(models.CharField( max_length=64, - blank=True + blank=True, + help_text=_('Shared secret that the webhook service will use to sign requests') )) webhook_credential = models.ForeignKey( 'Credential', blank=True, null=True, on_delete=models.SET_NULL, - related_name='%(class)ss' + related_name='%(class)ss', + help_text=_('Personal Access Token for posting back the status to the service API') ) def rotate_webhook_key(self): @@ -544,18 +547,21 @@ class WebhookMixin(models.Model): webhook_service = models.CharField( max_length=16, choices=SERVICES, - blank=True + blank=True, + help_text=_('Service that webhook requests will be accepted from') ) webhook_credential = models.ForeignKey( 'Credential', blank=True, null=True, on_delete=models.SET_NULL, - related_name='%(class)ss' + related_name='%(class)ss', + help_text=_('Personal Access Token for posting back the status to the service API') ) webhook_guid = models.CharField( blank=True, - max_length=128 + max_length=128, + help_text=_('Unique identifier of the event that triggered this webhook') ) def update_webhook_status(self, status):