Skip to content

Latest commit

 

History

History
525 lines (338 loc) · 18.2 KB

File metadata and controls

525 lines (338 loc) · 18.2 KB

\ApplicationsBetaApi

All URIs are relative to https://app.launchdarkly.com

Method HTTP request Description
DeleteApplication Delete /api/v2/applications/{applicationKey} Delete application
DeleteApplicationVersion Delete /api/v2/applications/{applicationKey}/versions/{versionKey} Delete application version
GetApplication Get /api/v2/applications/{applicationKey} Get application by key
GetApplicationVersions Get /api/v2/applications/{applicationKey}/versions Get application versions by application key
GetApplications Get /api/v2/applications Get applications
PatchApplication Patch /api/v2/applications/{applicationKey} Update application
PatchApplicationVersion Patch /api/v2/applications/{applicationKey}/versions/{versionKey} Update application version

DeleteApplication

DeleteApplication(ctx, applicationKey).Execute()

Delete application

Example

package main

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

func main() {
	applicationKey := "applicationKey_example" // string | The application key

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.ApplicationsBetaApi.DeleteApplication(context.Background(), applicationKey).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ApplicationsBetaApi.DeleteApplication``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
applicationKey string The application key

Other Parameters

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

Name Type Description Notes

Return type

(empty response body)

Authorization

ApiKey

HTTP request headers

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

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

DeleteApplicationVersion

DeleteApplicationVersion(ctx, applicationKey, versionKey).Execute()

Delete application version

Example

package main

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

func main() {
	applicationKey := "applicationKey_example" // string | The application key
	versionKey := "versionKey_example" // string | The application version key

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.ApplicationsBetaApi.DeleteApplicationVersion(context.Background(), applicationKey, versionKey).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ApplicationsBetaApi.DeleteApplicationVersion``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
applicationKey string The application key
versionKey string The application version key

Other Parameters

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

Name Type Description Notes

Return type

(empty response body)

Authorization

ApiKey

HTTP request headers

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

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

GetApplication

ApplicationRep GetApplication(ctx, applicationKey).Expand(expand).Execute()

Get application by key

Example

package main

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

func main() {
	applicationKey := "applicationKey_example" // string | The application key
	expand := "expand_example" // string | A comma-separated list of properties that can reveal additional information in the response. Options: `flags`. (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.ApplicationsBetaApi.GetApplication(context.Background(), applicationKey).Expand(expand).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ApplicationsBetaApi.GetApplication``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetApplication`: ApplicationRep
	fmt.Fprintf(os.Stdout, "Response from `ApplicationsBetaApi.GetApplication`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
applicationKey string The application key

Other Parameters

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

Name Type Description Notes

expand | string | A comma-separated list of properties that can reveal additional information in the response. Options: `flags`. |

Return type

ApplicationRep

Authorization

ApiKey

HTTP request headers

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

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

GetApplicationVersions

ApplicationVersionsCollectionRep GetApplicationVersions(ctx, applicationKey).Filter(filter).Limit(limit).Offset(offset).Sort(sort).Execute()

Get application versions by application key

Example

package main

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

func main() {
	applicationKey := "applicationKey_example" // string | The application key
	filter := "filter_example" // string | Accepts filter by `key`, `name`, `supported`, and `autoAdded`. To learn more about the filter syntax, read [Filtering applications and application versions](https://launchdarkly.com/docs/api/applications-beta#filtering-applications-and-application-versions). (optional)
	limit := int64(789) // int64 | The number of versions to return. Defaults to 50. (optional)
	offset := int64(789) // int64 | Where to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query `limit`. (optional)
	sort := "sort_example" // string | Accepts sorting order and fields. Fields can be comma separated. Possible fields are `creationDate`, `name`. Examples: `sort=name` sort by names ascending, `sort=-name,creationDate` sort by names descending and creationDate ascending. (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.ApplicationsBetaApi.GetApplicationVersions(context.Background(), applicationKey).Filter(filter).Limit(limit).Offset(offset).Sort(sort).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ApplicationsBetaApi.GetApplicationVersions``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetApplicationVersions`: ApplicationVersionsCollectionRep
	fmt.Fprintf(os.Stdout, "Response from `ApplicationsBetaApi.GetApplicationVersions`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
applicationKey string The application key

Other Parameters

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

Name Type Description Notes

filter | string | Accepts filter by `key`, `name`, `supported`, and `autoAdded`. To learn more about the filter syntax, read Filtering applications and application versions. | limit | int64 | The number of versions to return. Defaults to 50. | offset | int64 | Where to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query `limit`. | sort | string | Accepts sorting order and fields. Fields can be comma separated. Possible fields are `creationDate`, `name`. Examples: `sort=name` sort by names ascending, `sort=-name,creationDate` sort by names descending and creationDate ascending. |

Return type

ApplicationVersionsCollectionRep

Authorization

ApiKey

HTTP request headers

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

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

GetApplications

ApplicationCollectionRep GetApplications(ctx).Filter(filter).Limit(limit).Offset(offset).Sort(sort).Expand(expand).Execute()

Get applications

Example

package main

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

func main() {
	filter := "filter_example" // string | Accepts filter by `key`, `name`, `kind`, and `autoAdded`. To learn more about the filter syntax, read [Filtering applications and application versions](https://launchdarkly.com/docs/api/applications-beta#filtering-applications-and-application-versions). (optional)
	limit := int64(789) // int64 | The number of applications to return. Defaults to 10. (optional)
	offset := int64(789) // int64 | Where to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query `limit`. (optional)
	sort := "sort_example" // string | Accepts sorting order and fields. Fields can be comma separated. Possible fields are `creationDate`, `name`. Examples: `sort=name` sort by names ascending, `sort=-name,creationDate` sort by names descending and creationDate ascending. (optional)
	expand := "expand_example" // string | A comma-separated list of properties that can reveal additional information in the response. Options: `flags`. (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.ApplicationsBetaApi.GetApplications(context.Background()).Filter(filter).Limit(limit).Offset(offset).Sort(sort).Expand(expand).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ApplicationsBetaApi.GetApplications``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetApplications`: ApplicationCollectionRep
	fmt.Fprintf(os.Stdout, "Response from `ApplicationsBetaApi.GetApplications`: %v\n", resp)
}

Path Parameters

Other Parameters

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

Name Type Description Notes
filter string Accepts filter by `key`, `name`, `kind`, and `autoAdded`. To learn more about the filter syntax, read Filtering applications and application versions.
limit int64 The number of applications to return. Defaults to 10.
offset int64 Where to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query `limit`.
sort string Accepts sorting order and fields. Fields can be comma separated. Possible fields are `creationDate`, `name`. Examples: `sort=name` sort by names ascending, `sort=-name,creationDate` sort by names descending and creationDate ascending.
expand string A comma-separated list of properties that can reveal additional information in the response. Options: `flags`.

Return type

ApplicationCollectionRep

Authorization

ApiKey

HTTP request headers

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

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

PatchApplication

ApplicationRep PatchApplication(ctx, applicationKey).PatchOperation(patchOperation).Execute()

Update application

Example

package main

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

func main() {
	applicationKey := "applicationKey_example" // string | The application key
	patchOperation := []openapiclient.PatchOperation{*openapiclient.NewPatchOperation("replace", "/exampleField")} // []PatchOperation | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.ApplicationsBetaApi.PatchApplication(context.Background(), applicationKey).PatchOperation(patchOperation).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ApplicationsBetaApi.PatchApplication``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `PatchApplication`: ApplicationRep
	fmt.Fprintf(os.Stdout, "Response from `ApplicationsBetaApi.PatchApplication`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
applicationKey string The application key

Other Parameters

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

Name Type Description Notes

patchOperation | []PatchOperation | |

Return type

ApplicationRep

Authorization

ApiKey

HTTP request headers

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

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

PatchApplicationVersion

ApplicationVersionRep PatchApplicationVersion(ctx, applicationKey, versionKey).PatchOperation(patchOperation).Execute()

Update application version

Example

package main

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

func main() {
	applicationKey := "applicationKey_example" // string | The application key
	versionKey := "versionKey_example" // string | The application version key
	patchOperation := []openapiclient.PatchOperation{*openapiclient.NewPatchOperation("replace", "/exampleField")} // []PatchOperation | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.ApplicationsBetaApi.PatchApplicationVersion(context.Background(), applicationKey, versionKey).PatchOperation(patchOperation).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ApplicationsBetaApi.PatchApplicationVersion``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `PatchApplicationVersion`: ApplicationVersionRep
	fmt.Fprintf(os.Stdout, "Response from `ApplicationsBetaApi.PatchApplicationVersion`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
applicationKey string The application key
versionKey string The application version key

Other Parameters

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

Name Type Description Notes

patchOperation | []PatchOperation | |

Return type

ApplicationVersionRep

Authorization

ApiKey

HTTP request headers

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

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