\MetadataAPI

All URIs are relative to http://localhost

Method	HTTP request	Description
DeleteArtifactVersionMetaData	Delete /groups/{groupId}/artifacts/{artifactId}/versions/{version}/meta	Delete artifact version metadata
GetArtifactMetaData	Get /groups/{groupId}/artifacts/{artifactId}/meta	Get artifact metadata
GetArtifactOwner	Get /groups/{groupId}/artifacts/{artifactId}/owner	Get artifact owner
GetArtifactVersionMetaData	Get /groups/{groupId}/artifacts/{artifactId}/versions/{version}/meta	Get artifact version metadata
GetArtifactVersionMetaDataByContent	Post /groups/{groupId}/artifacts/{artifactId}/meta	Get artifact version metadata by content
UpdateArtifactMetaData	Put /groups/{groupId}/artifacts/{artifactId}/meta	Update artifact metadata
UpdateArtifactOwner	Put /groups/{groupId}/artifacts/{artifactId}/owner	Update artifact owner
UpdateArtifactVersionMetaData	Put /groups/{groupId}/artifacts/{artifactId}/versions/{version}/meta	Update artifact version metadata

DeleteArtifactVersionMetaData

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

Delete artifact version metadata

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.MetadataAPI.DeleteArtifactVersionMetaData(context.Background(), groupId, artifactId, version).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `MetadataAPI.DeleteArtifactVersionMetaData``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
}

Path Parameters

Name	Type	Description
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 apiDeleteArtifactVersionMetaDataRequest 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]

GetArtifactMetaData

ArtifactMetaData GetArtifactMetaData(ctx, groupId, artifactId).Execute()

Get artifact metadata

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.

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

Path Parameters

Name	Type	Description
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 apiGetArtifactMetaDataRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

ArtifactMetaData

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]

GetArtifactOwner

ArtifactOwner GetArtifactOwner(ctx, groupId, artifactId).Execute()

Get artifact owner

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.

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

Path Parameters

Name	Type	Description
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 apiGetArtifactOwnerRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

ArtifactOwner

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]

GetArtifactVersionMetaData

VersionMetaData GetArtifactVersionMetaData(ctx, groupId, artifactId, version).Execute()

Get artifact version metadata

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.MetadataAPI.GetArtifactVersionMetaData(context.Background(), groupId, artifactId, version).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `MetadataAPI.GetArtifactVersionMetaData``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetArtifactVersionMetaData`: VersionMetaData
    fmt.Fprintf(os.Stdout, "Response from `MetadataAPI.GetArtifactVersionMetaData`: %v\n", resp)
}

Path Parameters

Name	Type	Description
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 apiGetArtifactVersionMetaDataRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

VersionMetaData

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]

GetArtifactVersionMetaDataByContent

VersionMetaData GetArtifactVersionMetaDataByContent(ctx, groupId, artifactId).Body(body).Canonical(canonical).Execute()

Get artifact version metadata by content

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 an artifact version.
    canonical := true // bool | Parameter that can be set to `true` to indicate that the server should \"canonicalize\" the content when searching for a matching version.  Canonicalization is unique to each artifact type, but typically involves removing any extra whitespace and formatting the content in a consistent manner. (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.MetadataAPI.GetArtifactVersionMetaDataByContent(context.Background(), groupId, artifactId).Body(body).Canonical(canonical).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `MetadataAPI.GetArtifactVersionMetaDataByContent``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetArtifactVersionMetaDataByContent`: VersionMetaData
    fmt.Fprintf(os.Stdout, "Response from `MetadataAPI.GetArtifactVersionMetaDataByContent`: %v\n", resp)
}

Path Parameters

Name	Type	Description
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 apiGetArtifactVersionMetaDataByContentRequest struct via the builder pattern

Name	Type	Description	Notes

body | *os.File | The content of an artifact version. | canonical | bool | Parameter that can be set to `true` to indicate that the server should "canonicalize" the content when searching for a matching version. Canonicalization is unique to each artifact type, but typically involves removing any extra whitespace and formatting the content in a consistent manner. |

Return type

VersionMetaData

Authorization

No authorization required

HTTP request headers

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

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

UpdateArtifactMetaData

UpdateArtifactMetaData(ctx, groupId, artifactId).EditableMetaData(editableMetaData).Execute()

Update artifact metadata

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.
    editableMetaData := *openapiclient.NewEditableMetaData() // EditableMetaData | Updated artifact metadata.

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

Path Parameters

Name	Type	Description
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 apiUpdateArtifactMetaDataRequest struct via the builder pattern

Name	Type	Description	Notes

editableMetaData | EditableMetaData | Updated artifact metadata. |

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]

UpdateArtifactOwner

UpdateArtifactOwner(ctx, groupId, artifactId).ArtifactOwner(artifactOwner).Execute()

Update artifact owner

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.
    artifactOwner := *openapiclient.NewArtifactOwner() // ArtifactOwner | 

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

Path Parameters

Name	Type	Description
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 apiUpdateArtifactOwnerRequest struct via the builder pattern

Name	Type	Description	Notes

artifactOwner | ArtifactOwner | |

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]

UpdateArtifactVersionMetaData

UpdateArtifactVersionMetaData(ctx, groupId, artifactId, version).EditableMetaData(editableMetaData).Execute()

Update artifact version metadata

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.
    editableMetaData := *openapiclient.NewEditableMetaData() // EditableMetaData | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    r, err := apiClient.MetadataAPI.UpdateArtifactVersionMetaData(context.Background(), groupId, artifactId, version).EditableMetaData(editableMetaData).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `MetadataAPI.UpdateArtifactVersionMetaData``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
}

Path Parameters

Name	Type	Description
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 apiUpdateArtifactVersionMetaDataRequest struct via the builder pattern

Name	Type	Description	Notes

editableMetaData | EditableMetaData | |

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]

Files

MetadataAPI.md

Latest commit

History

MetadataAPI.md

File metadata and controls

\MetadataAPI

DeleteArtifactVersionMetaData

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

GetArtifactMetaData

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

GetArtifactOwner

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

GetArtifactVersionMetaData

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

GetArtifactVersionMetaDataByContent

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

UpdateArtifactMetaData

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

UpdateArtifactOwner

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

UpdateArtifactVersionMetaData

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers