Merge pull request #553 from labd/550-broken-referenced-docs-links

fix: fixed broken links
labd · Dec 20, 2024 · e669a42 · e669a42
2 parents 05271ce + 9d12a82
commit e669a42
Show file tree

Hide file tree

Showing 7 changed files with 23 additions and 20 deletions.
diff --git a/.changes/unreleased/Fixed-20241220-101846.yaml b/.changes/unreleased/Fixed-20241220-101846.yaml
@@ -0,0 +1,3 @@
+kind: Fixed
+body: Fixed broken links in documentation
+time: 2024-12-20T10:18:46.54681776+01:00
diff --git a/commercetools/provider.go b/commercetools/provider.go
@@ -31,13 +31,13 @@ func New(version string) func() *schema.Provider {
 				"client_id": {
 					Type:        schema.TypeString,
 					Optional:    true,
-					Description: "The OAuth Client ID for a commercetools platform project. https://docs.commercetools.com/http-api-authorization",
+					Description: "The OAuth Client ID for a commercetools platform project. https://docs.commercetools.com/api/authorization",
 					Sensitive:   true,
 				},
 				"client_secret": {
 					Type:        schema.TypeString,
 					Optional:    true,
-					Description: "The OAuth Client Secret for a commercetools platform project. https://docs.commercetools.com/http-api-authorization",
+					Description: "The OAuth Client Secret for a commercetools platform project. https://docs.commercetools.com/api/authorization",
 					Sensitive:   true,
 				},
 				"project_key": {
@@ -49,17 +49,17 @@ func New(version string) func() *schema.Provider {
 				"scopes": {
 					Type:        schema.TypeString,
 					Optional:    true,
-					Description: "A list as string of OAuth scopes assigned to a project key, to access resources in a commercetools platform project. https://docs.commercetools.com/http-api-authorization",
+					Description: "A list as string of OAuth scopes assigned to a project key, to access resources in a commercetools platform project. https://docs.commercetools.com/api/authorization",
 				},
 				"api_url": {
 					Type:        schema.TypeString,
 					Optional:    true,
-					Description: "The API URL of the commercetools platform. https://docs.commercetools.com/http-api",
+					Description: "The API URL of the commercetools platform. https://docs.commercetools.com/api/general-concepts#hosts",
 				},
 				"token_url": {
 					Type:        schema.TypeString,
 					Optional:    true,
-					Description: "The authentication URL of the commercetools platform. https://docs.commercetools.com/http-api-authorization",
+					Description: "The authentication URL of the commercetools platform. https://docs.commercetools.com/api/authorization",
 				},
 			},
 			ResourcesMap: map[string]*schema.Resource{

diff --git a/docs/index.md b/docs/index.md
@@ -60,12 +60,12 @@ provider "commercetools" {
 
 ### Optional
 
-- `api_url` (String) The API URL of the commercetools platform. https://docs.commercetools.com/http-api
-- `client_id` (String, Sensitive) The OAuth Client ID for a commercetools platform project. https://docs.commercetools.com/http-api-authorization
-- `client_secret` (String, Sensitive) The OAuth Client Secret for a commercetools platform project. https://docs.commercetools.com/http-api-authorization
+- `api_url` (String) The API URL of the commercetools platform. https://docs.commercetools.com/api/general-concepts#hosts
+- `client_id` (String, Sensitive) The OAuth Client ID for a commercetools platform project. https://docs.commercetools.com/api/authorization
+- `client_secret` (String, Sensitive) The OAuth Client Secret for a commercetools platform project. https://docs.commercetools.com/api/authorization
 - `project_key` (String, Sensitive) The project key of commercetools platform project. https://docs.commercetools.com/getting-started
-- `scopes` (String) A list as string of OAuth scopes assigned to a project key, to access resources in a commercetools platform project. https://docs.commercetools.com/http-api-authorization
-- `token_url` (String) The authentication URL of the commercetools platform. https://docs.commercetools.com/http-api-authorization
+- `scopes` (String) A list as string of OAuth scopes assigned to a project key, to access resources in a commercetools platform project. https://docs.commercetools.com/api/authorization
+- `token_url` (String) The authentication URL of the commercetools platform. https://docs.commercetools.com/api/authorization
 
 ## Using with docker
 

diff --git a/docs/resources/project_settings.md b/docs/resources/project_settings.md
@@ -50,7 +50,7 @@ resource "commercetools_project_settings" "my-project" {
 ### Optional
 
 - `business_units` (Block List) Holds configuration specific to [Business Units](https://docs.commercetools.com/api/projects/business-units#ctp:api:type:BusinessUnit). (see [below for nested schema](#nestedblock--business_units))
-- `carts` (Block List) [Carts Configuration](https://docs.commercetools.com/api/projects/project#carts-configuration) (see [below for nested schema](#nestedblock--carts))
+- `carts` (Block List) [Carts Configuration](https://docs.commercetools.com/api/projects/project#cartsconfiguration) (see [below for nested schema](#nestedblock--carts))
 - `countries` (List of String) A two-digit country code as per [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)
 - `currencies` (List of String) A three-digit currency code as per [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)
 - `enable_search_index_customers` (Boolean) Enable the Search Indexing of customers
@@ -112,7 +112,7 @@ Optional:
 
 Required:
 
-- `key` (String) [Resource Type ID](https://docs.commercetools.com/api/projects/Projects#changeProject)
+- `key` (String)
 
 Optional:
 

diff --git a/docs/resources/shipping_method.md b/docs/resources/shipping_method.md
@@ -42,6 +42,7 @@ resource "commercetools_shipping_method" "standard" {
 
 ### Optional
 
+- `active` (Boolean) Activate or deactivate a shipping method. Default is active.
 - `custom` (Block List, Max: 1) (see [below for nested schema](#nestedblock--custom))
 - `description` (String)
 - `is_default` (Boolean) One shipping method in a project can be default

diff --git a/internal/provider/provider.go b/internal/provider/provider.go
@@ -66,12 +66,12 @@ func (p *ctProvider) Schema(_ context.Context, _ provider.SchemaRequest, resp *p
 		Attributes: map[string]schema.Attribute{
 			"client_id": schema.StringAttribute{
 				Optional:            true,
-				MarkdownDescription: "The OAuth Client ID for a commercetools platform project. https://docs.commercetools.com/http-api-authorization",
+				MarkdownDescription: "The OAuth Client ID for a commercetools platform project. https://docs.commercetools.com/api/authorization",
 				Sensitive:           true,
 			},
 			"client_secret": schema.StringAttribute{
 				Optional:            true,
-				MarkdownDescription: "The OAuth Client Secret for a commercetools platform project. https://docs.commercetools.com/http-api-authorization",
+				MarkdownDescription: "The OAuth Client Secret for a commercetools platform project. https://docs.commercetools.com/api/authorization",
 				Sensitive:           true,
 			},
 			"project_key": schema.StringAttribute{
@@ -81,15 +81,15 @@ func (p *ctProvider) Schema(_ context.Context, _ provider.SchemaRequest, resp *p
 			},
 			"scopes": schema.StringAttribute{
 				Optional:            true,
-				MarkdownDescription: "A list as string of OAuth scopes assigned to a project key, to access resources in a commercetools platform project. https://docs.commercetools.com/http-api-authorization",
+				MarkdownDescription: "A list as string of OAuth scopes assigned to a project key, to access resources in a commercetools platform project. https://docs.commercetools.com/api/authorization",
 			},
 			"api_url": schema.StringAttribute{
 				Optional:            true,
-				MarkdownDescription: "The API URL of the commercetools platform. https://docs.commercetools.com/http-api",
+				MarkdownDescription: "The API URL of the commercetools platform. https://docs.commercetools.com/api/general-concepts#hosts",
 			},
 			"token_url": schema.StringAttribute{
 				Optional:            true,
-				MarkdownDescription: "The authentication URL of the commercetools platform. https://docs.commercetools.com/http-api-authorization",
+				MarkdownDescription: "The authentication URL of the commercetools platform. https://docs.commercetools.com/api/authorization",
 			},
 		},
 	}

diff --git a/internal/resources/project/resource.go b/internal/resources/project/resource.go
@@ -161,7 +161,7 @@ func (r *projectResource) Schema(_ context.Context, _ resource.SchemaRequest, re
 		},
 		Blocks: map[string]schema.Block{
 			"carts": schema.ListNestedBlock{
-				MarkdownDescription: "[Carts Configuration](https://docs.commercetools.com/api/projects/project#carts-configuration)",
+				MarkdownDescription: "[Carts Configuration](https://docs.commercetools.com/api/projects/project#cartsconfiguration)",
 				NestedObject: schema.NestedBlockObject{
 					Attributes: map[string]schema.Attribute{
 						"country_tax_rate_fallback_enabled": schema.BoolAttribute{
@@ -251,8 +251,7 @@ func (r *projectResource) Schema(_ context.Context, _ resource.SchemaRequest, re
 				NestedObject: schema.NestedBlockObject{
 					Attributes: map[string]schema.Attribute{
 						"key": schema.StringAttribute{
-							MarkdownDescription: "[Resource Type ID](https://docs.commercetools.com/api/projects/Projects#changeProject)",
-							Required:            true,
+							Required: true,
 						},
 						"label": customtypes.LocalizedString(customtypes.LocalizedStringOpts{
 							Optional: true,