Merge pull request #53 from alrayyes/feat/implement-mockoon

docs: add package docs

internal/core/domain/dedicated_server/doc.go

@@ -0,0 +1,2 @@
+// Package dedicated_server implements domain entities for dedicated_servers
+package dedicated_server

internal/core/domain/public_cloud/doc.go

@@ -0,0 +1,2 @@
+// Package public_cloud implements domain entities for public_cloud.
+package public_cloud

internal/core/ports/doc.go

@@ -0,0 +1,2 @@
+// Package ports contains exposed ports.
+package ports

internal/core/services/dedicated_server/service.go

@@ -1,3 +1,4 @@
+// Package dedicated_server implements services related to dedicated_servers
 package dedicated_server
 
 import (

internal/core/services/errors/error.go

@@ -1,3 +1,4 @@
+// Package errors implements errors related to core services.
 package errors
 
 import (

internal/core/services/public_cloud/service.go

@@ -1,3 +1,4 @@
+// Package public_cloud implements services related to public_cloud instances
 package public_cloud
 
 import (

internal/core/shared/enum/doc.go

@@ -0,0 +1,2 @@
+// Package enum implements enum value objects used by public_cloud
+package enum

internal/core/shared/enum_utils/doc.go

@@ -0,0 +1,2 @@
+// Package enum_utils implements generic utils to be used in enum value objects.
+package enum_utils

internal/core/shared/synced_map/synced_map.go

@@ -1,3 +1,4 @@
+// Package synced_map implements a thread safe map with generics support.
 package synced_map
 
 import (

internal/core/shared/value_object/go.doc.go

@@ -0,0 +1,2 @@
+// Package value_object implements value objects used by public_cloud.
+package value_object

internal/facades/dedicated_server/data_adapters/to_data_source_model/adapter.go

@@ -1,3 +1,4 @@
+// Package to_data_source_model implements adapters to convert domain entities to sdk models.
 package to_data_source_model
 
 import (

internal/facades/dedicated_server/facade.go

@@ -1,3 +1,4 @@
+// Package dedicated_server implements the dedicated_server facade.
 package dedicated_server
 
 import (

internal/facades/public_cloud/data_adapters/to_data_source_model/adapter.go

@@ -1,3 +1,4 @@
+// Package to_data_source_model implements adapters to convert domain entities to sdk models.
 package to_data_source_model
 
 import (

internal/facades/public_cloud/data_adapters/to_domain_entity/adapter.go

@@ -1,3 +1,4 @@
+// Package to_domain_entity implements adapters to convert resource models to domain entities.
 package to_domain_entity
 
 import (

internal/facades/public_cloud/data_adapters/to_resource_model/to_resource_model.go

@@ -1,3 +1,4 @@
+// Package to_resource_model implements adapters to convert domain entities to resource models.
 package to_resource_model
 
 import (

internal/facades/public_cloud/facade.go

@@ -1,3 +1,4 @@
+// Package public_cloud implements the public_cloud facade.
 package public_cloud
 
 import (

internal/facades/shared/doc.go

@@ -0,0 +1,2 @@
+// Package shared implements utils that facades use.
+package shared

internal/provider/client/client.go

@@ -1,3 +1,4 @@
+// Package client implements access to facades.
 package client
 
 import (

internal/provider/data_sources/dedicated_server/dedicated_servers/doc.go

@@ -0,0 +1,2 @@
+// Package dedicated_servers implements functionality for dedicated_server data sources.
+package dedicated_servers

internal/provider/data_sources/dedicated_server/model/doc.go

@@ -0,0 +1,2 @@
+// Package model implements data models for dedicated_server data sources.
+package model

internal/provider/data_sources/public_cloud/instances/doc.go

@@ -0,0 +1,2 @@
+// Package instances implements functionality for public_cloud data sources.
+package instances

internal/provider/data_sources/public_cloud/model/doc.go

@@ -0,0 +1,2 @@
+// Package model implements data models for public_cloud data sources.
+package model

internal/provider/doc.go

@@ -0,0 +1,2 @@
+// Package provider implements the Leaseweb Terraform provider.
+package provider

internal/provider/logging/facade_error.go

@@ -1,3 +1,4 @@
+// Package logging implements logging that the end user sees.
 package logging
 
 import (

internal/provider/resources/public_cloud/instance/doc.go

@@ -0,0 +1,2 @@
+// Package instance implements functionality for public_cloud resources.
+package instance

internal/provider/resources/public_cloud/instance/validator/doc.go

@@ -0,0 +1,2 @@
+// Package validator implements validators used by public_cloud resources.
+package validator

internal/provider/resources/public_cloud/model/doc.go

@@ -0,0 +1,2 @@
+// Package model implements models for public_cloud resources.
+package model

internal/provider/shared_schemas/public_cloud/schemas.go

@@ -1,3 +1,4 @@
+// Package public_cloud implements schemas used multiple times in public_cloud data sources & resources.
 package public_cloud
 
 import (

internal/repositories/dedicated_server_repository/data_adapters/to_domain_entity/adapter.go

@@ -1,11 +1,12 @@
+// Package to_domain_entity implements adapters to convert dedicated_server sdk models to domain entities.
 package to_domain_entity
 
 import (
 	"github.com/leaseweb/leaseweb-go-sdk/dedicatedServer"
 	domain "github.com/leaseweb/terraform-provider-leaseweb/internal/core/domain/dedicated_server"
 )
 
-// AdaptDedicatedServer adapts an dedicatedServer domain entity to an sdk dedicatedServer model.
+// AdaptDedicatedServer adapts dedicatedServer.Server to dedicated_server.DedicatedServer.
 func AdaptDedicatedServer(sdkDedicatedServer dedicatedServer.Server) domain.DedicatedServer {
 	return domain.NewDedicatedServer(
 		sdkDedicatedServer.GetId(),

internal/repositories/dedicated_server_repository/dedicated_server_repository.go

@@ -1,3 +1,5 @@
+// Package dedicated_server_repository implements repository logic
+// to access the dedicated_server sdk.
 package dedicated_server_repository
 
 import (

internal/repositories/public_cloud_repository/data_adapters/to_domain_entity/adapter.go

@@ -1,3 +1,4 @@
+// Package to_domain_entity implements adapters to convert public_cloud sdk models to domain entities.
 package to_domain_entity
 
 import (

internal/repositories/public_cloud_repository/data_adapters/to_sdk_model/adapter.go

@@ -1,3 +1,4 @@
+// Package to_sdk_model implements adapters to convert public_cloud domain entities to sdk models.
 package to_sdk_model
 
 import (

internal/repositories/public_cloud_repository/public_cloud_repository.go

@@ -1,3 +1,5 @@
+// Package public_cloud_repository implements repository logic
+// to access the public_cloud sdk.
 package public_cloud_repository
 
 import (

internal/repositories/sdk/doc.go

@@ -0,0 +1,2 @@
+// Package sdk implements interfaces related to the sdk.
+package sdk