Apicurio Registry Client SDK for Go

Apicurio Registry is a datastore for standard event schemas and API designs. Apicurio Registry enables developers to manage and share the structure of their data using a REST interface. For example, client applications can dynamically push or pull the latest updates to or from the registry without needing to redeploy. Apicurio Registry also enables developers to create rules that govern how registry content can evolve over time. For example, this includes rules for content validation and version compatibility.

The Apicurio Registry REST API enables client applications to manage the artifacts in the registry. This API provides create, read, update, and delete operations for schema and API artifacts, rules, versions, and metadata.

The supported artifact types include:

• Apache Avro schema
• AsyncAPI specification
• Google protocol buffers
• GraphQL schema
• JSON Schema
• Kafka Connect schema
• OpenAPI specification
• Web Services Description Language
• XML Schema Definition

Important: The Apicurio Registry REST API is available from https://MY-REGISTRY-URL/apis/registry/v2 by default. Therefore you must prefix all API operation paths with ../apis/registry/v2 in this case. For example: ../apis/registry/v2/ids/globalIds/{globalId}.

Overview

This API client was generated by the OpenAPI Generator project. By using the OpenAPI-spec from a remote server, you can easily generate an API client.

• API version: 2.2.4-SNAPSHOT
• Package version: 1.0.0
• Build package: org.openapitools.codegen.languages.GoClientCodegen For more information, please visit https://github.com/apicurio/apicurio-registry

Installation

Install the client SDK library to your Go project:

go get github.com/Apicurio/apicurio-registry-client-sdk-go

Add the following import to use it:

import "github.com/Apicurio/apicurio-registry-client-sdk-go"

To use a proxy, set the environment variable HTTP_PROXY:

os.Setenv("HTTP_PROXY", "http://proxy_name:proxy_port")

Creating an API client

To create an API client using the default configuration options:

cfg := registryclient.NewConfiguration()
registryClient := registryclient.NewAPIClient(&cfg)

Configuration of Server URL

Default configuration comes with Servers field that contains server objects as defined in the OpenAPI specification.

Select Server Configuration

For using other server than the one defined on index 0 set context value sw.ContextServerIndex of type int.

ctx := context.WithValue(context.Background(), registryclient.ContextServerIndex, 1)

Templated Server URL

Templated server URL is formatted using default variables from configuration or from context value sw.ContextServerVariables of type map[string]string.

ctx := context.WithValue(context.Background(), registryclient.ContextServerVariables, map[string]string{
	"basePath": "v2",
})

Note, enum values are always validated and all unused variables are silently ignored.

URLs Configuration per Operation

Each operation can use different server URL defined using OperationServers map in the Configuration. An operation is uniquely identified by "{classname}Service.{nickname}" string. Similar rules for overriding default operation server index and variables applies by using sw.ContextOperationServerIndices and sw.ContextOperationServerVariables context maps.

ctx := context.WithValue(context.Background(), registryclient.ContextOperationServerIndices, map[string]int{
	"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), registryclient.ContextOperationServerVariables, map[string]map[string]string{
	"{classname}Service.{nickname}": {
		"port": "8443",
	},
})

Documentation for API Endpoints

All URIs are relative to http://localhost

Class	Method	HTTP request	Description
AdminApi	CreateGlobalRule	Post /admin/rules	Create global rule
AdminApi	CreateRoleMapping	Post /admin/roleMappings	Create a new role mapping
AdminApi	DeleteAllGlobalRules	Delete /admin/rules	Delete all global rules
AdminApi	DeleteGlobalRule	Delete /admin/rules/{rule}	Delete global rule
AdminApi	DeleteRoleMapping	Delete /admin/roleMappings/{principalId}	Delete a role mapping
AdminApi	ExportData	Get /admin/export	Export registry data
AdminApi	GetConfigProperty	Get /admin/config/properties/{propertyName}	Get the value of a configuration property
AdminApi	GetGlobalRuleConfig	Get /admin/rules/{rule}	Get global rule configuration
AdminApi	GetLogConfiguration	Get /admin/loggers/{logger}	Get a single logger configuration
AdminApi	GetRoleMapping	Get /admin/roleMappings/{principalId}	Return a single role mapping
AdminApi	ImportData	Post /admin/import	Import registry data
AdminApi	ListConfigProperties	Get /admin/config/properties	List all configuration properties
AdminApi	ListGlobalRules	Get /admin/rules	List global rules
AdminApi	ListLogConfigurations	Get /admin/loggers	List logging configurations
AdminApi	ListRoleMappings	Get /admin/roleMappings	List all role mappings
AdminApi	RemoveLogConfiguration	Delete /admin/loggers/{logger}	Removes logger configuration
AdminApi	ResetConfigProperty	Delete /admin/config/properties/{propertyName}	Reset a configuration property
AdminApi	SetLogConfiguration	Put /admin/loggers/{logger}	Set a logger's configuration
AdminApi	UpdateConfigProperty	Put /admin/config/properties/{propertyName}	Update a configuration property
AdminApi	UpdateGlobalRuleConfig	Put /admin/rules/{rule}	Update global rule configuration
AdminApi	UpdateRoleMapping	Put /admin/roleMappings/{principalId}	Update a role mapping
ArtifactRulesApi	CreateArtifactRule	Post /groups/{groupId}/artifacts/{artifactId}/rules	Create artifact rule
ArtifactRulesApi	DeleteArtifactRule	Delete /groups/{groupId}/artifacts/{artifactId}/rules/{rule}	Delete artifact rule
ArtifactRulesApi	DeleteArtifactRules	Delete /groups/{groupId}/artifacts/{artifactId}/rules	Delete artifact rules
ArtifactRulesApi	GetArtifactRuleConfig	Get /groups/{groupId}/artifacts/{artifactId}/rules/{rule}	Get artifact rule configuration
ArtifactRulesApi	ListArtifactRules	Get /groups/{groupId}/artifacts/{artifactId}/rules	List artifact rules
ArtifactRulesApi	TestUpdateArtifact	Put /groups/{groupId}/artifacts/{artifactId}/test	Test update artifact
ArtifactRulesApi	UpdateArtifactRuleConfig	Put /groups/{groupId}/artifacts/{artifactId}/rules/{rule}	Update artifact rule configuration
ArtifactsApi	CreateArtifact	Post /groups/{groupId}/artifacts	Create artifact
ArtifactsApi	DeleteArtifact	Delete /groups/{groupId}/artifacts/{artifactId}	Delete artifact
ArtifactsApi	DeleteArtifactsInGroup	Delete /groups/{groupId}/artifacts	Deletes all artifacts in a group
ArtifactsApi	GetContentByGlobalId	Get /ids/globalIds/{globalId}	Get artifact by global ID
ArtifactsApi	GetContentByHash	Get /ids/contentHashes/{contentHash}/	Get artifact content by SHA-256 hash
ArtifactsApi	GetContentById	Get /ids/contentIds/{contentId}/	Get artifact content by ID
ArtifactsApi	GetLatestArtifact	Get /groups/{groupId}/artifacts/{artifactId}	Get latest artifact
ArtifactsApi	ListArtifactsInGroup	Get /groups/{groupId}/artifacts	List artifacts in group
ArtifactsApi	ReferencesByContentHash	Get /ids/contentHashes/{contentHash}/references	Returns a list with all the references for the artifact with the given hash
ArtifactsApi	ReferencesByContentId	Get /ids/contentIds/{contentId}/references	Returns a list with all the references for the artifact with the given content id.
ArtifactsApi	ReferencesByGlobalId	Get /ids/globalIds/{globalId}/references	Returns a list with all the references for the artifact with the given global id.
ArtifactsApi	SearchArtifacts	Get /search/artifacts	Search for artifacts
ArtifactsApi	SearchArtifactsByContent	Post /search/artifacts	Search for artifacts by content
ArtifactsApi	UpdateArtifact	Put /groups/{groupId}/artifacts/{artifactId}	Update artifact
ArtifactsApi	UpdateArtifactState	Put /groups/{groupId}/artifacts/{artifactId}/state	Update artifact state
MetadataApi	DeleteArtifactVersionMetaData	Delete /groups/{groupId}/artifacts/{artifactId}/versions/{version}/meta	Delete artifact version metadata
MetadataApi	GetArtifactMetaData	Get /groups/{groupId}/artifacts/{artifactId}/meta	Get artifact metadata
MetadataApi	GetArtifactVersionMetaData	Get /groups/{groupId}/artifacts/{artifactId}/versions/{version}/meta	Get artifact version metadata
MetadataApi	GetArtifactVersionMetaDataByContent	Post /groups/{groupId}/artifacts/{artifactId}/meta	Get artifact version metadata by content
MetadataApi	UpdateArtifactMetaData	Put /groups/{groupId}/artifacts/{artifactId}/meta	Update artifact metadata
MetadataApi	UpdateArtifactVersionMetaData	Put /groups/{groupId}/artifacts/{artifactId}/versions/{version}/meta	Update artifact version metadata
SystemApi	GetResourceLimits	Get /system/limits	Get resource limits information
SystemApi	GetSystemInfo	Get /system/info	Get system information
UsersApi	GetCurrentUserInfo	Get /users/me	Get current user
VersionsApi	CreateArtifactVersion	Post /groups/{groupId}/artifacts/{artifactId}/versions	Create artifact version
VersionsApi	GetArtifactVersion	Get /groups/{groupId}/artifacts/{artifactId}/versions/{version}	Get artifact version
VersionsApi	GetArtifactVersionReferences	Get /groups/{groupId}/artifacts/{artifactId}/versions/{version}/references	Get artifact version
VersionsApi	ListArtifactVersions	Get /groups/{groupId}/artifacts/{artifactId}/versions	List artifact versions
VersionsApi	UpdateArtifactVersionState	Put /groups/{groupId}/artifacts/{artifactId}/versions/{version}/state	Update artifact version state

Documentation For Models

• ArtifactMetaData
• ArtifactReference
• ArtifactSearchResults
• ArtifactState
• ArtifactType
• ConfigurationProperty
• ContentCreateRequest
• DownloadRef
• EditableMetaData
• Error
• IfExists
• Limits
• LogConfiguration
• LogLevel
• NamedLogConfiguration
• NamedLogConfigurationAllOf
• RoleMapping
• RoleType
• Rule
• RuleType
• RuleViolationCause
• RuleViolationError
• RuleViolationErrorAllOf
• SearchedArtifact
• SearchedVersion
• SortBy
• SortOrder
• SystemInfo
• UpdateConfigurationProperty
• UpdateRole
• UpdateState
• UserInfo
• VersionMetaData
• VersionSearchResults

Documentation For Authorization

Endpoints do not require authorization.

Documentation for Utility Methods

Due to the fact that model structure members are all pointers, this package contains a number of utility functions to easily obtain pointers to values of basic types. Each of these functions takes a value of the given basic type and returns a pointer to it:

• PtrBool
• PtrInt
• PtrInt32
• PtrInt64
• PtrFloat
• PtrFloat32
• PtrFloat64
• PtrString
• PtrTime

Author

[email protected]