Skip to content

Latest commit

 

History

History
388 lines (251 loc) · 11.3 KB

NewReleaseManagementApi.md

File metadata and controls

388 lines (251 loc) · 11.3 KB
Raw

\NewReleaseManagementApi

All URIs are relative to http://localhost

Method HTTP request Description
CreateNewRelease Post /api/v1/customers/{cUUID}/ybdb_release Create a release
DeleteNewRelease Delete /api/v1/customers/{cUUID}/ybdb_release/{rUUID} delete a release
GetNewRelease Get /api/v1/customers/{cUUID}/ybdb_release/{rUUID} Get a release
ListNewReleases Get /api/v1/customers/{cUUID}/ybdb_release List releases
UpdateNewRelease Put /api/v1/customers/{cUUID}/ybdb_release/{rUUID} Update a release

CreateNewRelease

YBPCreateSuccess CreateNewRelease(ctx, cUUID).Release(release).Request(request).Execute()

Create a release

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    cUUID := TODO // string | 
    release := *openapiclient.NewCreateRelease([]openapiclient.Artifact{*openapiclient.NewArtifact("Architecture_example", "PackageFileId_example", "PackageUrl_example", "Platform_example", "Sha256_example")}, int64(123), "ReleaseNotes_example", "ReleaseTag_example", "ReleaseType_example", "ReleaseUuid_example", "Version_example", "YbType_example") // CreateRelease | Release data to be created
    request := TODO // interface{} |  (optional)

    configuration := openapiclient.NewConfiguration()
    api_client := openapiclient.NewAPIClient(configuration)
    resp, r, err := api_client.NewReleaseManagementApi.CreateNewRelease(context.Background(), cUUID).Release(release).Request(request).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `NewReleaseManagementApi.CreateNewRelease``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `CreateNewRelease`: YBPCreateSuccess
    fmt.Fprintf(os.Stdout, "Response from `NewReleaseManagementApi.CreateNewRelease`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
cUUID string

Other Parameters

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

Name Type Description Notes

release | CreateRelease | Release data to be created | request | interface{} | |

Return type

YBPCreateSuccess

Authorization

apiKeyAuth

HTTP request headers

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

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

DeleteNewRelease

YBPSuccess DeleteNewRelease(ctx, cUUID, rUUID).Request(request).Execute()

delete a release

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    cUUID := TODO // string | 
    rUUID := TODO // string | 
    request := TODO // interface{} |  (optional)

    configuration := openapiclient.NewConfiguration()
    api_client := openapiclient.NewAPIClient(configuration)
    resp, r, err := api_client.NewReleaseManagementApi.DeleteNewRelease(context.Background(), cUUID, rUUID).Request(request).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `NewReleaseManagementApi.DeleteNewRelease``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `DeleteNewRelease`: YBPSuccess
    fmt.Fprintf(os.Stdout, "Response from `NewReleaseManagementApi.DeleteNewRelease`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
cUUID string
rUUID string

Other Parameters

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

Name Type Description Notes

request | interface{} | |

Return type

YBPSuccess

Authorization

apiKeyAuth

HTTP request headers

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

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

GetNewRelease

ResponseRelease GetNewRelease(ctx, cUUID, rUUID).Request(request).Execute()

Get a release

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    cUUID := TODO // string | 
    rUUID := TODO // string | 
    request := TODO // interface{} |  (optional)

    configuration := openapiclient.NewConfiguration()
    api_client := openapiclient.NewAPIClient(configuration)
    resp, r, err := api_client.NewReleaseManagementApi.GetNewRelease(context.Background(), cUUID, rUUID).Request(request).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `NewReleaseManagementApi.GetNewRelease``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetNewRelease`: ResponseRelease
    fmt.Fprintf(os.Stdout, "Response from `NewReleaseManagementApi.GetNewRelease`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
cUUID string
rUUID string

Other Parameters

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

Name Type Description Notes

request | interface{} | |

Return type

ResponseRelease

Authorization

apiKeyAuth

HTTP request headers

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

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

ListNewReleases

[]ResponseRelease ListNewReleases(ctx, cUUID).DeploymentType(deploymentType).Request(request).Execute()

List releases

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    cUUID := TODO // string | 
    deploymentType := "deploymentType_example" // string |  (optional) (default to "null")
    request := TODO // interface{} |  (optional)

    configuration := openapiclient.NewConfiguration()
    api_client := openapiclient.NewAPIClient(configuration)
    resp, r, err := api_client.NewReleaseManagementApi.ListNewReleases(context.Background(), cUUID).DeploymentType(deploymentType).Request(request).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `NewReleaseManagementApi.ListNewReleases``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ListNewReleases`: []ResponseRelease
    fmt.Fprintf(os.Stdout, "Response from `NewReleaseManagementApi.ListNewReleases`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
cUUID string

Other Parameters

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

Name Type Description Notes

deploymentType | string | | [default to "null"] request | interface{} | |

Return type

[]ResponseRelease

Authorization

apiKeyAuth

HTTP request headers

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

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

UpdateNewRelease

YBPSuccess UpdateNewRelease(ctx, cUUID, rUUID).Release(release).Request(request).Execute()

Update a release

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    cUUID := TODO // string | 
    rUUID := TODO // string | 
    release := *openapiclient.NewUpdateRelease([]openapiclient.Artifact{*openapiclient.NewArtifact("Architecture_example", "PackageFileId_example", "PackageUrl_example", "Platform_example", "Sha256_example")}, int64(123), "ReleaseNotes_example", "ReleaseTag_example", "State_example") // UpdateRelease | Release data to be updated
    request := TODO // interface{} |  (optional)

    configuration := openapiclient.NewConfiguration()
    api_client := openapiclient.NewAPIClient(configuration)
    resp, r, err := api_client.NewReleaseManagementApi.UpdateNewRelease(context.Background(), cUUID, rUUID).Release(release).Request(request).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `NewReleaseManagementApi.UpdateNewRelease``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `UpdateNewRelease`: YBPSuccess
    fmt.Fprintf(os.Stdout, "Response from `NewReleaseManagementApi.UpdateNewRelease`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
cUUID string
rUUID string

Other Parameters

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

Name Type Description Notes

release | UpdateRelease | Release data to be updated | request | interface{} | |

Return type

YBPSuccess

Authorization

apiKeyAuth

HTTP request headers

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

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