From 8f863087c557050633e240853022f44c64d6e92b Mon Sep 17 00:00:00 2001 From: Matthew Mauer Date: Tue, 3 Dec 2024 15:06:27 -0500 Subject: [PATCH] add missing notes on priced gated features to docs --- docs/resources/api_key_settings.md | 7 +++++-- docs/resources/basic_auth_configuration.md | 4 ++-- docs/resources/custom_domain.md | 2 +- docs/resources/user_property_settings.md | 2 +- internal/provider/api_key_settings_resource.go | 5 ++++- internal/provider/basic_auth_configuration_resource.go | 5 +++-- internal/provider/custom_domain_resource.go | 3 ++- internal/provider/user_property_settings_resource.go | 5 +++-- 8 files changed, 21 insertions(+), 12 deletions(-) diff --git a/docs/resources/api_key_settings.md b/docs/resources/api_key_settings.md index 7d26ed4..c69aebe 100644 --- a/docs/resources/api_key_settings.md +++ b/docs/resources/api_key_settings.md @@ -3,12 +3,15 @@ page_title: "propelauth_api_key_settings Resource - propelauth" subcategory: "" description: |- - Api Key Configurations. This is for configuring the API global settings for your project. + Api Key Configurations. API Key authentication allows you to create API Keys for your end users as well as your organizations in order to protect requests they make to your product. This resource is for configuring the API key settings in your project. + Note: API Keys are only available for use in non-test environments for some pricing plans. --- # propelauth_api_key_settings (Resource) -Api Key Configurations. This is for configuring the API global settings for your project. +Api Key Configurations. API Key authentication allows you to create API Keys for your end users as well as your organizations in order to protect requests they make to your product. This resource is for configuring the API key settings in your project. + +Note: API Keys are only available for use in non-test environments for some pricing plans. ## Example Usage diff --git a/docs/resources/basic_auth_configuration.md b/docs/resources/basic_auth_configuration.md index 687301a..7d79a28 100644 --- a/docs/resources/basic_auth_configuration.md +++ b/docs/resources/basic_auth_configuration.md @@ -29,8 +29,8 @@ resource "propelauth_basic_auth_configuration" "example" { - `has_password_login` (Boolean) If true, your users will be able to log in using their email and password. The default setting is true. - `has_passwordless_login` (Boolean) If true, your users will be able to log in using a magic link sent to their email. The default setting is false. - `include_login_method` (Boolean) If true, the login method will be included in the access token. The default setting is false.See `https://docs.propelauth.com/overview/user-management/user-properties#login-method-property` for more information. -- `signup_domain_allowlist` (List of String) A list of email domains that are allowed to sign up. -- `signup_domain_blocklist` (List of String) A list of email domains that are blocked from signing up. This is only used if `signup_domain_allowlist` is empty. +- `signup_domain_allowlist` (List of String) A list of email domains that are allowed to sign up. Note: This feature is only available on some pricing plans. +- `signup_domain_blocklist` (List of String) A list of email domains that are blocked from signing up. This is only used if `signup_domain_allowlist` is empty.Note: This feature is only available on some pricing plans. - `user_autologout_seconds` (Number) The number of seconds before a user is automatically logged out. The default setting is 1209600 (14 days).See also "user_autologout_type" for more information. - `user_autologout_type` (String) This sets the behavior for when the counting for "user_autologout_seconds" starts. Valid values are "AfterInactivity" and the stricter "AfterLogin". The default setting is "AfterInactivity". - `users_can_change_email` (Boolean) If true, your users will be able to change their email address. The default setting is true. diff --git a/docs/resources/custom_domain.md b/docs/resources/custom_domain.md index 7e476e5..6accf9d 100644 --- a/docs/resources/custom_domain.md +++ b/docs/resources/custom_domain.md @@ -28,7 +28,7 @@ resource "propelauth_custom_domain" "my_custom_domain" { ### Required - `domain` (String) The domain name for the custom domain. Your resulting auth domain will be `auth.`. You can also specify a subdomain like prod.example.com which will result in auth.prod.example.com -- `environment` (String) The environment for which you are configuring the custom domain. Accepted values are `Staging` and `Prod`. +- `environment` (String) The environment for which you are configuring the custom domain. Accepted values are `Staging` and `Prod`. Note: Staging environments are only available on some pricing plans. ### Optional diff --git a/docs/resources/user_property_settings.md b/docs/resources/user_property_settings.md index 178198f..153dfdd 100644 --- a/docs/resources/user_property_settings.md +++ b/docs/resources/user_property_settings.md @@ -113,7 +113,7 @@ resource "propelauth_user_property_settings" "example" { ### Optional -- `custom_properties` (Attributes List) Custom properties for the user. If no blocks are provided, no custom properties will be enabled. (see [below for nested schema](#nestedatt--custom_properties)) +- `custom_properties` (Attributes List) Custom properties for the user. If no blocks are provided, no custom properties will be enabled. Note: Custom properties are only available on some pricing plans. (see [below for nested schema](#nestedatt--custom_properties)) - `metadata_property` (Attributes) Settings for the user's metadata property. If no block is provided, the metadata property will be disabled. (see [below for nested schema](#nestedatt--metadata_property)) - `name_property` (Attributes) Settings for the user's name property. If no block is provided, the name property will be disabled. (see [below for nested schema](#nestedatt--name_property)) - `phone_number_property` (Attributes) Settings for the user's phone number property. If no block is provided, the phone number property will be disabled. (see [below for nested schema](#nestedatt--phone_number_property)) diff --git a/internal/provider/api_key_settings_resource.go b/internal/provider/api_key_settings_resource.go index ab108ad..cf3ad88 100644 --- a/internal/provider/api_key_settings_resource.go +++ b/internal/provider/api_key_settings_resource.go @@ -49,7 +49,10 @@ func (r *apiKeySettingsResource) Metadata(ctx context.Context, req resource.Meta func (r *apiKeySettingsResource) Schema(ctx context.Context, req resource.SchemaRequest, resp *resource.SchemaResponse) { resp.Schema = schema.Schema{ - Description: "Api Key Configurations. This is for configuring the API global settings for your project.", + Description: "Api Key Configurations. API Key authentication allows you to create API Keys for your end users as well as " + + "your organizations in order to protect requests they make to your product. This resource is for configuring the API " + + "key settings in your project.\n\nNote: API Keys are only available for use in non-test environments for some " + + "pricing plans.", Attributes: map[string]schema.Attribute{ "personal_api_keys_enabled": schema.BoolAttribute{ Optional: true, diff --git a/internal/provider/basic_auth_configuration_resource.go b/internal/provider/basic_auth_configuration_resource.go index 53a45d0..ad20936 100644 --- a/internal/provider/basic_auth_configuration_resource.go +++ b/internal/provider/basic_auth_configuration_resource.go @@ -62,12 +62,13 @@ func (r *basicAuthConfigurationResource) Schema(ctx context.Context, req resourc "signup_domain_allowlist": schema.ListAttribute{ ElementType: types.StringType, Optional: true, - Description: "A list of email domains that are allowed to sign up.", + Description: "A list of email domains that are allowed to sign up. Note: This feature is only available on some pricing plans.", }, "signup_domain_blocklist": schema.ListAttribute{ ElementType: types.StringType, Optional: true, - Description: "A list of email domains that are blocked from signing up. This is only used if `signup_domain_allowlist` is empty.", + Description: "A list of email domains that are blocked from signing up. This is only used if `signup_domain_allowlist` is empty." + + "Note: This feature is only available on some pricing plans.", }, "has_password_login": schema.BoolAttribute{ Optional: true, diff --git a/internal/provider/custom_domain_resource.go b/internal/provider/custom_domain_resource.go index 6f985a5..98c7e6a 100644 --- a/internal/provider/custom_domain_resource.go +++ b/internal/provider/custom_domain_resource.go @@ -63,7 +63,8 @@ func (r *customDomainResource) Schema(ctx context.Context, req resource.SchemaRe PlanModifiers: []planmodifier.String{ stringplanmodifier.RequiresReplace(), }, - Description: "The environment for which you are configuring the custom domain. Accepted values are `Staging` and `Prod`.", + Description: "The environment for which you are configuring the custom domain. Accepted values are `Staging` and `Prod`. " + + "Note: Staging environments are only available on some pricing plans.", }, "domain": schema.StringAttribute{ Required: true, diff --git a/internal/provider/user_property_settings_resource.go b/internal/provider/user_property_settings_resource.go index 9934080..bf21f7b 100644 --- a/internal/provider/user_property_settings_resource.go +++ b/internal/provider/user_property_settings_resource.go @@ -221,8 +221,9 @@ func (r *userPropertySettingsResource) Schema(ctx context.Context, req resource. }, }, "custom_properties": schema.ListNestedAttribute{ - Optional: true, - Description: "Custom properties for the user. If no blocks are provided, no custom properties will be enabled.", + Optional: true, + Description: "Custom properties for the user. If no blocks are provided, no custom properties will be enabled. " + + "Note: Custom properties are only available on some pricing plans.", NestedObject: schema.NestedAttributeObject{ Attributes: map[string]schema.Attribute{ "name": schema.StringAttribute{