Skip to content

Latest commit

 

History

History
796 lines (512 loc) · 32.5 KB

VersionsAPI.md

File metadata and controls

796 lines (512 loc) · 32.5 KB

\VersionsAPI

All URIs are relative to http://localhost

Method HTTP request Description
AddArtifactVersionComment Post /groups/{groupId}/artifacts/{artifactId}/versions/{version}/comments Add new comment
CreateArtifactVersion Post /groups/{groupId}/artifacts/{artifactId}/versions Create artifact version
DeleteArtifactVersion Delete /groups/{groupId}/artifacts/{artifactId}/versions/{version} Delete artifact version
DeleteArtifactVersionComment Delete /groups/{groupId}/artifacts/{artifactId}/versions/{version}/comments/{commentId} Delete a single comment
GetArtifactVersion Get /groups/{groupId}/artifacts/{artifactId}/versions/{version} Get artifact version
GetArtifactVersionComments Get /groups/{groupId}/artifacts/{artifactId}/versions/{version}/comments Get artifact version comments
GetArtifactVersionReferences Get /groups/{groupId}/artifacts/{artifactId}/versions/{version}/references Get artifact version references
ListArtifactVersions Get /groups/{groupId}/artifacts/{artifactId}/versions List artifact versions
UpdateArtifactVersionComment Put /groups/{groupId}/artifacts/{artifactId}/versions/{version}/comments/{commentId} Update a comment
UpdateArtifactVersionState Put /groups/{groupId}/artifacts/{artifactId}/versions/{version}/state Update artifact version state

AddArtifactVersionComment

Comment AddArtifactVersionComment(ctx, groupId, artifactId, version).NewComment(newComment).Execute()

Add new comment

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Apicurio/apicurio-registry-client-sdk-go"
)

func main() {
    groupId := "groupId_example" // string | The artifact group ID.  Must be a string provided by the client, representing the name of the grouping of artifacts.
    artifactId := "artifactId_example" // string | The artifact ID.  Can be a string (client-provided) or UUID (server-generated), representing the unique artifact identifier.
    version := "version_example" // string | The unique identifier of a specific version of the artifact content.
    newComment := *openapiclient.NewNewComment("Value_example") // NewComment | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.VersionsAPI.AddArtifactVersionComment(context.Background(), groupId, artifactId, version).NewComment(newComment).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `VersionsAPI.AddArtifactVersionComment``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `AddArtifactVersionComment`: Comment
    fmt.Fprintf(os.Stdout, "Response from `VersionsAPI.AddArtifactVersionComment`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
groupId string The artifact group ID. Must be a string provided by the client, representing the name of the grouping of artifacts.
artifactId string The artifact ID. Can be a string (client-provided) or UUID (server-generated), representing the unique artifact identifier.
version string The unique identifier of a specific version of the artifact content.

Other Parameters

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

Name Type Description Notes

newComment | NewComment | |

Return type

Comment

Authorization

No authorization required

HTTP request headers

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

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

CreateArtifactVersion

VersionMetaData CreateArtifactVersion(ctx, groupId, artifactId).Body(body).XRegistryVersion(xRegistryVersion).XRegistryName(xRegistryName).XRegistryDescription(xRegistryDescription).XRegistryDescriptionEncoded(xRegistryDescriptionEncoded).XRegistryNameEncoded(xRegistryNameEncoded).Execute()

Create artifact version

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Apicurio/apicurio-registry-client-sdk-go"
)

func main() {
    groupId := "groupId_example" // string | The artifact group ID.  Must be a string provided by the client, representing the name of the grouping of artifacts.
    artifactId := "artifactId_example" // string | The artifact ID.  Can be a string (client-provided) or UUID (server-generated), representing the unique artifact identifier.
    body := os.NewFile(1234, "some_file") // *os.File | The content of the artifact version being created or the content and a set of references to other artifacts. This is often, but not always, JSON data representing one of the supported artifact types:  * Avro (`AVRO`) * Protobuf (`PROTOBUF`) * JSON Schema (`JSON`) * Kafka Connect (`KCONNECT`) * OpenAPI (`OPENAPI`) * AsyncAPI (`ASYNCAPI`) * GraphQL (`GRAPHQL`) * Web Services Description Language (`WSDL`) * XML Schema (`XSD`) 
    xRegistryVersion := "xRegistryVersion_example" // string | Specifies the version number of this new version of the artifact content.  This would typically be a simple integer or a SemVer value.  It must be unique within the artifact.  If this is not provided, the server will generate a new, unique version number for this new updated content. (optional)
    xRegistryName := "xRegistryName_example" // string | Specifies the artifact name of this new version of the artifact content. Name must be ASCII-only string. If this is not provided, the server will extract the name from the artifact content. (optional)
    xRegistryDescription := "xRegistryDescription_example" // string | Specifies the artifact description of this new version of the artifact content. Description must be ASCII-only string. If this is not provided, the server will extract the description from the artifact content. (optional)
    xRegistryDescriptionEncoded := "xRegistryDescriptionEncoded_example" // string | Specifies the artifact description of this new version of the artifact content. Value of this must be Base64 encoded string. If this is not provided, the server will extract the description from the artifact content. (optional)
    xRegistryNameEncoded := "xRegistryNameEncoded_example" // string | Specifies the artifact name of this new version of the artifact content. Value of this must be Base64 encoded string. If this is not provided, the server will extract the name from the artifact content. (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.VersionsAPI.CreateArtifactVersion(context.Background(), groupId, artifactId).Body(body).XRegistryVersion(xRegistryVersion).XRegistryName(xRegistryName).XRegistryDescription(xRegistryDescription).XRegistryDescriptionEncoded(xRegistryDescriptionEncoded).XRegistryNameEncoded(xRegistryNameEncoded).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `VersionsAPI.CreateArtifactVersion``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `CreateArtifactVersion`: VersionMetaData
    fmt.Fprintf(os.Stdout, "Response from `VersionsAPI.CreateArtifactVersion`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
groupId string The artifact group ID. Must be a string provided by the client, representing the name of the grouping of artifacts.
artifactId string The artifact ID. Can be a string (client-provided) or UUID (server-generated), representing the unique artifact identifier.

Other Parameters

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

Name Type Description Notes

body | *os.File | The content of the artifact version being created or the content and a set of references to other artifacts. This is often, but not always, JSON data representing one of the supported artifact types: * Avro (`AVRO`) * Protobuf (`PROTOBUF`) * JSON Schema (`JSON`) * Kafka Connect (`KCONNECT`) * OpenAPI (`OPENAPI`) * AsyncAPI (`ASYNCAPI`) * GraphQL (`GRAPHQL`) * Web Services Description Language (`WSDL`) * XML Schema (`XSD`) | xRegistryVersion | string | Specifies the version number of this new version of the artifact content. This would typically be a simple integer or a SemVer value. It must be unique within the artifact. If this is not provided, the server will generate a new, unique version number for this new updated content. | xRegistryName | string | Specifies the artifact name of this new version of the artifact content. Name must be ASCII-only string. If this is not provided, the server will extract the name from the artifact content. | xRegistryDescription | string | Specifies the artifact description of this new version of the artifact content. Description must be ASCII-only string. If this is not provided, the server will extract the description from the artifact content. | xRegistryDescriptionEncoded | string | Specifies the artifact description of this new version of the artifact content. Value of this must be Base64 encoded string. If this is not provided, the server will extract the description from the artifact content. | xRegistryNameEncoded | string | Specifies the artifact name of this new version of the artifact content. Value of this must be Base64 encoded string. If this is not provided, the server will extract the name from the artifact content. |

Return type

VersionMetaData

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/create.extended+json, application/vnd.create.extended+json
  • Accept: application/json

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

DeleteArtifactVersion

DeleteArtifactVersion(ctx, groupId, artifactId, version).Execute()

Delete artifact version

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Apicurio/apicurio-registry-client-sdk-go"
)

func main() {
    groupId := "groupId_example" // string | The artifact group ID.  Must be a string provided by the client, representing the name of the grouping of artifacts.
    artifactId := "artifactId_example" // string | The artifact ID.  Can be a string (client-provided) or UUID (server-generated), representing the unique artifact identifier.
    version := "version_example" // string | The unique identifier of a specific version of the artifact content.

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    r, err := apiClient.VersionsAPI.DeleteArtifactVersion(context.Background(), groupId, artifactId, version).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `VersionsAPI.DeleteArtifactVersion``: %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.
groupId string The artifact group ID. Must be a string provided by the client, representing the name of the grouping of artifacts.
artifactId string The artifact ID. Can be a string (client-provided) or UUID (server-generated), representing the unique artifact identifier.
version string The unique identifier of a specific version of the artifact content.

Other Parameters

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

Name Type Description Notes

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

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

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

DeleteArtifactVersionComment

DeleteArtifactVersionComment(ctx, groupId, artifactId, version, commentId).Execute()

Delete a single comment

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Apicurio/apicurio-registry-client-sdk-go"
)

func main() {
    groupId := "groupId_example" // string | The artifact group ID.  Must be a string provided by the client, representing the name of the grouping of artifacts.
    artifactId := "artifactId_example" // string | The artifact ID.  Can be a string (client-provided) or UUID (server-generated), representing the unique artifact identifier.
    version := "version_example" // string | The unique identifier of a specific version of the artifact content.
    commentId := "commentId_example" // string | The unique identifier of a single comment.

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    r, err := apiClient.VersionsAPI.DeleteArtifactVersionComment(context.Background(), groupId, artifactId, version, commentId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `VersionsAPI.DeleteArtifactVersionComment``: %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.
groupId string The artifact group ID. Must be a string provided by the client, representing the name of the grouping of artifacts.
artifactId string The artifact ID. Can be a string (client-provided) or UUID (server-generated), representing the unique artifact identifier.
version string The unique identifier of a specific version of the artifact content.
commentId string The unique identifier of a single comment.

Other Parameters

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

Name Type Description Notes

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

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

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

GetArtifactVersion

*os.File GetArtifactVersion(ctx, groupId, artifactId, version).References(references).Execute()

Get artifact version

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Apicurio/apicurio-registry-client-sdk-go"
)

func main() {
    groupId := "groupId_example" // string | The artifact group ID.  Must be a string provided by the client, representing the name of the grouping of artifacts.
    artifactId := "artifactId_example" // string | The artifact ID.  Can be a string (client-provided) or UUID (server-generated), representing the unique artifact identifier.
    version := "version_example" // string | The unique identifier of a specific version of the artifact content.
    references := openapiclient.HandleReferencesType("PRESERVE") // HandleReferencesType | Allows the user to specify how references in the content should be treated. (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.VersionsAPI.GetArtifactVersion(context.Background(), groupId, artifactId, version).References(references).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `VersionsAPI.GetArtifactVersion``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetArtifactVersion`: *os.File
    fmt.Fprintf(os.Stdout, "Response from `VersionsAPI.GetArtifactVersion`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
groupId string The artifact group ID. Must be a string provided by the client, representing the name of the grouping of artifacts.
artifactId string The artifact ID. Can be a string (client-provided) or UUID (server-generated), representing the unique artifact identifier.
version string The unique identifier of a specific version of the artifact content.

Other Parameters

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

Name Type Description Notes

references | HandleReferencesType | Allows the user to specify how references in the content should be treated. |

Return type

*os.File

Authorization

No authorization required

HTTP request headers

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

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

GetArtifactVersionComments

[]Comment GetArtifactVersionComments(ctx, groupId, artifactId, version).Execute()

Get artifact version comments

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Apicurio/apicurio-registry-client-sdk-go"
)

func main() {
    groupId := "groupId_example" // string | The artifact group ID.  Must be a string provided by the client, representing the name of the grouping of artifacts.
    artifactId := "artifactId_example" // string | The artifact ID.  Can be a string (client-provided) or UUID (server-generated), representing the unique artifact identifier.
    version := "version_example" // string | The unique identifier of a specific version of the artifact content.

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.VersionsAPI.GetArtifactVersionComments(context.Background(), groupId, artifactId, version).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `VersionsAPI.GetArtifactVersionComments``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetArtifactVersionComments`: []Comment
    fmt.Fprintf(os.Stdout, "Response from `VersionsAPI.GetArtifactVersionComments`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
groupId string The artifact group ID. Must be a string provided by the client, representing the name of the grouping of artifacts.
artifactId string The artifact ID. Can be a string (client-provided) or UUID (server-generated), representing the unique artifact identifier.
version string The unique identifier of a specific version of the artifact content.

Other Parameters

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

Name Type Description Notes

Return type

[]Comment

Authorization

No authorization required

HTTP request headers

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

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

GetArtifactVersionReferences

[]ArtifactReference GetArtifactVersionReferences(ctx, groupId, artifactId, version).RefType(refType).Execute()

Get artifact version references

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Apicurio/apicurio-registry-client-sdk-go"
)

func main() {
    groupId := "groupId_example" // string | The artifact group ID.  Must be a string provided by the client, representing the name of the grouping of artifacts.
    artifactId := "artifactId_example" // string | The artifact ID.  Can be a string (client-provided) or UUID (server-generated), representing the unique artifact identifier.
    version := "version_example" // string | The unique identifier of a specific version of the artifact content.
    refType := openapiclient.ReferenceType("OUTBOUND") // ReferenceType | Determines the type of reference to return, either INBOUND or OUTBOUND.  Defaults to OUTBOUND. (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.VersionsAPI.GetArtifactVersionReferences(context.Background(), groupId, artifactId, version).RefType(refType).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `VersionsAPI.GetArtifactVersionReferences``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetArtifactVersionReferences`: []ArtifactReference
    fmt.Fprintf(os.Stdout, "Response from `VersionsAPI.GetArtifactVersionReferences`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
groupId string The artifact group ID. Must be a string provided by the client, representing the name of the grouping of artifacts.
artifactId string The artifact ID. Can be a string (client-provided) or UUID (server-generated), representing the unique artifact identifier.
version string The unique identifier of a specific version of the artifact content.

Other Parameters

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

Name Type Description Notes

refType | ReferenceType | Determines the type of reference to return, either INBOUND or OUTBOUND. Defaults to OUTBOUND. |

Return type

[]ArtifactReference

Authorization

No authorization required

HTTP request headers

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

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

ListArtifactVersions

VersionSearchResults ListArtifactVersions(ctx, groupId, artifactId).Offset(offset).Limit(limit).Execute()

List artifact versions

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Apicurio/apicurio-registry-client-sdk-go"
)

func main() {
    groupId := "groupId_example" // string | The artifact group ID.  Must be a string provided by the client, representing the name of the grouping of artifacts.
    artifactId := "artifactId_example" // string | The artifact ID.  Can be a string (client-provided) or UUID (server-generated), representing the unique artifact identifier.
    offset := int32(56) // int32 | The number of versions to skip before starting to collect the result set.  Defaults to 0. (optional)
    limit := int32(56) // int32 | The number of versions to return.  Defaults to 20. (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.VersionsAPI.ListArtifactVersions(context.Background(), groupId, artifactId).Offset(offset).Limit(limit).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `VersionsAPI.ListArtifactVersions``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ListArtifactVersions`: VersionSearchResults
    fmt.Fprintf(os.Stdout, "Response from `VersionsAPI.ListArtifactVersions`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
groupId string The artifact group ID. Must be a string provided by the client, representing the name of the grouping of artifacts.
artifactId string The artifact ID. Can be a string (client-provided) or UUID (server-generated), representing the unique artifact identifier.

Other Parameters

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

Name Type Description Notes

offset | int32 | The number of versions to skip before starting to collect the result set. Defaults to 0. | limit | int32 | The number of versions to return. Defaults to 20. |

Return type

VersionSearchResults

Authorization

No authorization required

HTTP request headers

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

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

UpdateArtifactVersionComment

UpdateArtifactVersionComment(ctx, groupId, artifactId, version, commentId).NewComment(newComment).Execute()

Update a comment

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Apicurio/apicurio-registry-client-sdk-go"
)

func main() {
    groupId := "groupId_example" // string | The artifact group ID.  Must be a string provided by the client, representing the name of the grouping of artifacts.
    artifactId := "artifactId_example" // string | The artifact ID.  Can be a string (client-provided) or UUID (server-generated), representing the unique artifact identifier.
    version := "version_example" // string | The unique identifier of a specific version of the artifact content.
    commentId := "commentId_example" // string | The unique identifier of a single comment.
    newComment := *openapiclient.NewNewComment("Value_example") // NewComment | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    r, err := apiClient.VersionsAPI.UpdateArtifactVersionComment(context.Background(), groupId, artifactId, version, commentId).NewComment(newComment).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `VersionsAPI.UpdateArtifactVersionComment``: %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.
groupId string The artifact group ID. Must be a string provided by the client, representing the name of the grouping of artifacts.
artifactId string The artifact ID. Can be a string (client-provided) or UUID (server-generated), representing the unique artifact identifier.
version string The unique identifier of a specific version of the artifact content.
commentId string The unique identifier of a single comment.

Other Parameters

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

Name Type Description Notes

newComment | NewComment | |

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

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

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

UpdateArtifactVersionState

UpdateArtifactVersionState(ctx, groupId, artifactId, version).UpdateState(updateState).Execute()

Update artifact version state

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Apicurio/apicurio-registry-client-sdk-go"
)

func main() {
    groupId := "groupId_example" // string | The artifact group ID.  Must be a string provided by the client, representing the name of the grouping of artifacts.
    artifactId := "artifactId_example" // string | The artifact ID.  Can be a string (client-provided) or UUID (server-generated), representing the unique artifact identifier.
    version := "version_example" // string | The unique identifier of a specific version of the artifact content.
    updateState := *openapiclient.NewUpdateState(openapiclient.ArtifactState("ENABLED")) // UpdateState | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    r, err := apiClient.VersionsAPI.UpdateArtifactVersionState(context.Background(), groupId, artifactId, version).UpdateState(updateState).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `VersionsAPI.UpdateArtifactVersionState``: %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.
groupId string The artifact group ID. Must be a string provided by the client, representing the name of the grouping of artifacts.
artifactId string The artifact ID. Can be a string (client-provided) or UUID (server-generated), representing the unique artifact identifier.
version string The unique identifier of a specific version of the artifact content.

Other Parameters

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

Name Type Description Notes

updateState | UpdateState | |

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

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

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