Skip to content

BlueprintCatalogAPI.md

Latest commit

 

History

History
168 lines (108 loc) · 5.95 KB

BlueprintCatalogAPI.md

File metadata and controls

168 lines (108 loc) · 5.95 KB
Raw

\BlueprintCatalogAPI

All URIs are relative to https://api.qovery.com

Method HTTP request Description
GetBlueprintCatalogServiceManifest Get /organization/{organizationId}/blueprint/catalog/{provider}/{serviceFamily}/{serviceVersion}/manifest Get the input fields to display for a blueprint catalog service
GetBlueprintCatalogServiceReadme Get /organization/{organizationId}/blueprint/catalog/{provider}/{serviceFamily}/{serviceVersion}/readme Get the README of a blueprint catalog service

GetBlueprintCatalogServiceManifest

BlueprintManifestResponse GetBlueprintCatalogServiceManifest(ctx, organizationId, provider, serviceFamily, serviceVersion).EnvironmentId(environmentId).Execute()

Get the input fields to display for a blueprint catalog service

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/qovery/qovery-client-go"
)

func main() {
	organizationId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | Organization ID
	provider := "provider_example" // string | Cloud provider (e.g. aws, gcp, azure)
	serviceFamily := "serviceFamily_example" // string | Service family (e.g. mysql, postgresql)
	serviceVersion := "serviceVersion_example" // string | Service version (e.g. 8, 14)
	environmentId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | Environment ID used to resolve context variables

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.BlueprintCatalogAPI.GetBlueprintCatalogServiceManifest(context.Background(), organizationId, provider, serviceFamily, serviceVersion).EnvironmentId(environmentId).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `BlueprintCatalogAPI.GetBlueprintCatalogServiceManifest``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetBlueprintCatalogServiceManifest`: BlueprintManifestResponse
	fmt.Fprintf(os.Stdout, "Response from `BlueprintCatalogAPI.GetBlueprintCatalogServiceManifest`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
organizationId string Organization ID
provider string Cloud provider (e.g. aws, gcp, azure)
serviceFamily string Service family (e.g. mysql, postgresql)
serviceVersion string Service version (e.g. 8, 14)

Other Parameters

Other parameters are passed through a pointer to a apiGetBlueprintCatalogServiceManifestRequest struct via the builder pattern

Name Type Description Notes

environmentId | string | Environment ID used to resolve context variables |

Return type

BlueprintManifestResponse

Authorization

ApiKeyAuth, bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetBlueprintCatalogServiceReadme

BlueprintReadmeResponse GetBlueprintCatalogServiceReadme(ctx, organizationId, provider, serviceFamily, serviceVersion).Execute()

Get the README of a blueprint catalog service

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/qovery/qovery-client-go"
)

func main() {
	organizationId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | Organization ID
	provider := "provider_example" // string | Cloud provider (e.g. aws, gcp, azure)
	serviceFamily := "serviceFamily_example" // string | Service family (e.g. mysql, postgresql)
	serviceVersion := "serviceVersion_example" // string | Service version (e.g. 8, 14)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.BlueprintCatalogAPI.GetBlueprintCatalogServiceReadme(context.Background(), organizationId, provider, serviceFamily, serviceVersion).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `BlueprintCatalogAPI.GetBlueprintCatalogServiceReadme``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetBlueprintCatalogServiceReadme`: BlueprintReadmeResponse
	fmt.Fprintf(os.Stdout, "Response from `BlueprintCatalogAPI.GetBlueprintCatalogServiceReadme`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
organizationId string Organization ID
provider string Cloud provider (e.g. aws, gcp, azure)
serviceFamily string Service family (e.g. mysql, postgresql)
serviceVersion string Service version (e.g. 8, 14)

Other Parameters

Other parameters are passed through a pointer to a apiGetBlueprintCatalogServiceReadmeRequest struct via the builder pattern

Name Type Description Notes

Return type

BlueprintReadmeResponse

Authorization

ApiKeyAuth, bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]