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

Help text cleanup #638

Open
wants to merge 1 commit into
base: devel
Choose a base branch
from

Conversation

dmzoneill
Copy link
Member

No description provided.

@dmzoneill dmzoneill marked this pull request as draft November 6, 2024 12:16
@dmzoneill dmzoneill changed the title Help text cleanup Help text cleanup (not for review) Nov 6, 2024
@@ -19,7 +19,7 @@ class AzureADConfiguration(BaseAuthenticatorConfiguration):

CALLBACK_URL = URLField(
help_text=_(
'Provide this URL as the callback URL for your application as part of your registration process. Refer to the documentation for more detail. '
'Provide this URL as the callback URL for your application as part of your registration process. Refer to the documentation for more detail.'
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Uniform Resource Locator (URL)

@@ -32,7 +32,7 @@ class AzureADConfiguration(BaseAuthenticatorConfiguration):
)

SECRET = CharField(
help_text=_("'The OIDC secret (Client Secret) from your IDP."),
help_text=_("The OIDC secret (Client Secret) from your IDP."),
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OpenID Connect (OIDC)
IDentity Provider (IDP)

@@ -39,7 +39,7 @@ class OpenIdConnectConfiguration(BaseAuthenticatorConfiguration):
#################################

OIDC_ENDPOINT = URLField(
help_text=_("The URL for your OIDC provider including the path up to /.well-known/openid-configuration"),
help_text=_("The URL for your OIDC provider including the path up to /.well-known/openid-configuration."),
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Uniform Resource Locator (URL)
OpenID Connect (OIDC)

@@ -122,7 +122,7 @@ class OpenIdConnectConfiguration(BaseAuthenticatorConfiguration):
)

JWT_DECODE_OPTIONS = DictField(
help_text=_("OIDC JWT decoding options for token validation and processing"),
help_text=_("OIDC JWT decoding options for token validation and processing."),
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OpenID Connection (OIDC)
JavScript Object Notation (JSON)
JSON Web Token (JWT)

@@ -165,7 +165,7 @@ class OpenIdConnectConfiguration(BaseAuthenticatorConfiguration):
)

RESPONSE_TYPE = CharField(
help_text=_("The reponse type the OIDC endpoint should return. Common values are 'code', 'id_token' and 'token'."),
help_text=_("The response type the OIDC endpoint should return. Common values are 'code', 'id_token' and 'token'."),
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OpenID Connect (OIDC)

Comment on lines 19 to 21
name='Authenticator',
fields=[
('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We don't want to change existing migration files. That could theoretically cause issues and will make it so that you likely can't create new migrations (because it won't detect changes).

Comment on lines 91 to 95
enabled = models.BooleanField(
null=False,
default=True,
help_text=_("Enables or disables this authentication map"),
)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this en erroneous commit? Looks like it affects a couple files.

@dmzoneill dmzoneill changed the title Help text cleanup (not for review) Help text cleanup Nov 7, 2024
@dmzoneill dmzoneill marked this pull request as ready for review November 15, 2024 10:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants