feat: add registry-instance to generate script

packages/registry-instance-sdk/README.md

@@ -0,0 +1,242 @@
+# registry-instance-sdk
+
+Apicurio Registry API [v2]
+
+- API version: 2.2.5.Final
+
+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}`.
+
+
+  For more information, please visit [https://github.com/apicurio/apicurio-registry](https://github.com/apicurio/apicurio-registry)
+
+*Automatically generated by the [OpenAPI Generator](https://openapi-generator.tech)*
+
+## Requirements
+
+Building the API client library requires:
+
+1. Java 1.8+
+2. Maven/Gradle
+
+## Installation
+
+To install the API client library to your local Maven repository, simply execute:
+
+```shell
+mvn clean install
+```
+
+To deploy it to a remote Maven repository instead, configure the settings of the repository and execute:
+
+```shell
+mvn clean deploy
+```
+
+Refer to the [OSSRH Guide](http://central.sonatype.org/pages/ossrh-guide.html) for more information.
+
+### Maven users
+
+Add this dependency to your project's POM:
+
+```xml
+<dependency>
+  <groupId>com.redhat.cloud</groupId>
+  <artifactId>registry-instance-sdk</artifactId>
+  <version>2.2.5.Final</version>
+  <scope>compile</scope>
+</dependency>
+```
+
+### Gradle users
+
+Add this dependency to your project's build file:
+
+```groovy
+  repositories {
+    mavenCentral()     // Needed if the 'registry-instance-sdk' jar has been published to maven central.
+    mavenLocal()       // Needed if the 'registry-instance-sdk' jar has been published to the local maven repo.
+  }
+
+  dependencies {
+     implementation "com.redhat.cloud:registry-instance-sdk:2.2.5.Final"
+  }
+```
+
+### Others
+
+At first generate the JAR by executing:
+
+```shell
+mvn clean package
+```
+
+Then manually install the following JARs:
+
+- `target/registry-instance-sdk-2.2.5.Final.jar`
+- `target/lib/*.jar`
+
+## Getting Started
+
+Please follow the [installation](#installation) instruction and execute the following Java code:
+
+```java
+
+import com.openshift.cloud.api.registry.instance.invoker.*;
+import com.openshift.cloud.api.registry.instance.invoker.auth.*;
+import com.openshift.cloud.api.registry.instance.models.*;
+import com.openshift.cloud.api.registry.instance.AdminApi;
+
+public class AdminApiExample {
+
+    public static void main(String[] args) {
+        ApiClient defaultClient = Configuration.getDefaultApiClient();
+        defaultClient.setBasePath("http://localhost");
+
+        AdminApi apiInstance = new AdminApi(defaultClient);
+        RoleMapping roleMapping = new RoleMapping(); // RoleMapping | 
+        try {
+            apiInstance.createRoleMapping(roleMapping);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling AdminApi#createRoleMapping");
+            System.err.println("Status code: " + e.getCode());
+            System.err.println("Reason: " + e.getResponseBody());
+            System.err.println("Response headers: " + e.getResponseHeaders());
+            e.printStackTrace();
+        }
+    }
+}
+
+```
+
+## Documentation for API Endpoints
+
+All URIs are relative to *http://localhost*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*AdminApi* | [**createRoleMapping**](docs/AdminApi.md#createRoleMapping) | **POST** /admin/roleMappings | Create a new role mapping
+*AdminApi* | [**deleteRoleMapping**](docs/AdminApi.md#deleteRoleMapping) | **DELETE** /admin/roleMappings/{principalId} | Delete a role mapping
+*AdminApi* | [**exportData**](docs/AdminApi.md#exportData) | **GET** /admin/export | Export registry data
+*AdminApi* | [**getConfigProperty**](docs/AdminApi.md#getConfigProperty) | **GET** /admin/config/properties/{propertyName} | Get the value of a configuration property
+*AdminApi* | [**getLogConfiguration**](docs/AdminApi.md#getLogConfiguration) | **GET** /admin/loggers/{logger} | Get a single logger configuration
+*AdminApi* | [**getRoleMapping**](docs/AdminApi.md#getRoleMapping) | **GET** /admin/roleMappings/{principalId} | Return a single role mapping
+*AdminApi* | [**importData**](docs/AdminApi.md#importData) | **POST** /admin/import | Import registry data
+*AdminApi* | [**listConfigProperties**](docs/AdminApi.md#listConfigProperties) | **GET** /admin/config/properties | List all configuration properties
+*AdminApi* | [**listLogConfigurations**](docs/AdminApi.md#listLogConfigurations) | **GET** /admin/loggers | List logging configurations
+*AdminApi* | [**listRoleMappings**](docs/AdminApi.md#listRoleMappings) | **GET** /admin/roleMappings | List all role mappings
+*AdminApi* | [**removeLogConfiguration**](docs/AdminApi.md#removeLogConfiguration) | **DELETE** /admin/loggers/{logger} | Removes logger configuration
+*AdminApi* | [**resetConfigProperty**](docs/AdminApi.md#resetConfigProperty) | **DELETE** /admin/config/properties/{propertyName} | Reset a configuration property
+*AdminApi* | [**setLogConfiguration**](docs/AdminApi.md#setLogConfiguration) | **PUT** /admin/loggers/{logger} | Set a logger&#39;s configuration
+*AdminApi* | [**updateConfigProperty**](docs/AdminApi.md#updateConfigProperty) | **PUT** /admin/config/properties/{propertyName} | Update a configuration property
+*AdminApi* | [**updateRoleMapping**](docs/AdminApi.md#updateRoleMapping) | **PUT** /admin/roleMappings/{principalId} | Update a role mapping
+*ArtifactRulesApi* | [**createArtifactRule**](docs/ArtifactRulesApi.md#createArtifactRule) | **POST** /groups/{groupId}/artifacts/{artifactId}/rules | Create artifact rule
+*ArtifactRulesApi* | [**deleteArtifactRule**](docs/ArtifactRulesApi.md#deleteArtifactRule) | **DELETE** /groups/{groupId}/artifacts/{artifactId}/rules/{rule} | Delete artifact rule
+*ArtifactRulesApi* | [**deleteArtifactRules**](docs/ArtifactRulesApi.md#deleteArtifactRules) | **DELETE** /groups/{groupId}/artifacts/{artifactId}/rules | Delete artifact rules
+*ArtifactRulesApi* | [**getArtifactRuleConfig**](docs/ArtifactRulesApi.md#getArtifactRuleConfig) | **GET** /groups/{groupId}/artifacts/{artifactId}/rules/{rule} | Get artifact rule configuration
+*ArtifactRulesApi* | [**listArtifactRules**](docs/ArtifactRulesApi.md#listArtifactRules) | **GET** /groups/{groupId}/artifacts/{artifactId}/rules | List artifact rules
+*ArtifactRulesApi* | [**testUpdateArtifact**](docs/ArtifactRulesApi.md#testUpdateArtifact) | **PUT** /groups/{groupId}/artifacts/{artifactId}/test | Test update artifact
+*ArtifactRulesApi* | [**updateArtifactRuleConfig**](docs/ArtifactRulesApi.md#updateArtifactRuleConfig) | **PUT** /groups/{groupId}/artifacts/{artifactId}/rules/{rule} | Update artifact rule configuration
+*ArtifactsApi* | [**createArtifact**](docs/ArtifactsApi.md#createArtifact) | **POST** /groups/{groupId}/artifacts | Create artifact
+*ArtifactsApi* | [**deleteArtifact**](docs/ArtifactsApi.md#deleteArtifact) | **DELETE** /groups/{groupId}/artifacts/{artifactId} | Delete artifact
+*ArtifactsApi* | [**deleteArtifactsInGroup**](docs/ArtifactsApi.md#deleteArtifactsInGroup) | **DELETE** /groups/{groupId}/artifacts | Deletes all artifacts in a group
+*ArtifactsApi* | [**getContentByGlobalId**](docs/ArtifactsApi.md#getContentByGlobalId) | **GET** /ids/globalIds/{globalId} | Get artifact by global ID
+*ArtifactsApi* | [**getContentByHash**](docs/ArtifactsApi.md#getContentByHash) | **GET** /ids/contentHashes/{contentHash}/ | Get artifact content by SHA-256 hash
+*ArtifactsApi* | [**getContentById**](docs/ArtifactsApi.md#getContentById) | **GET** /ids/contentIds/{contentId}/ | Get artifact content by ID
+*ArtifactsApi* | [**getLatestArtifact**](docs/ArtifactsApi.md#getLatestArtifact) | **GET** /groups/{groupId}/artifacts/{artifactId} | Get latest artifact
+*ArtifactsApi* | [**listArtifactsInGroup**](docs/ArtifactsApi.md#listArtifactsInGroup) | **GET** /groups/{groupId}/artifacts | List artifacts in group
+*ArtifactsApi* | [**referencesByContentHash**](docs/ArtifactsApi.md#referencesByContentHash) | **GET** /ids/contentHashes/{contentHash}/references | Returns a list with all the references for the artifact with the given hash
+*ArtifactsApi* | [**referencesByContentId**](docs/ArtifactsApi.md#referencesByContentId) | **GET** /ids/contentIds/{contentId}/references | Returns a list with all the references for the artifact with the given content id.
+*ArtifactsApi* | [**referencesByGlobalId**](docs/ArtifactsApi.md#referencesByGlobalId) | **GET** /ids/globalIds/{globalId}/references | Returns a list with all the references for the artifact with the given global id.
+*ArtifactsApi* | [**updateArtifact**](docs/ArtifactsApi.md#updateArtifact) | **PUT** /groups/{groupId}/artifacts/{artifactId} | Update artifact
+*ArtifactsApi* | [**updateArtifactState**](docs/ArtifactsApi.md#updateArtifactState) | **PUT** /groups/{groupId}/artifacts/{artifactId}/state | Update artifact state
+*GlobalRulesApi* | [**createGlobalRule**](docs/GlobalRulesApi.md#createGlobalRule) | **POST** /admin/rules | Create global rule
+*GlobalRulesApi* | [**deleteAllGlobalRules**](docs/GlobalRulesApi.md#deleteAllGlobalRules) | **DELETE** /admin/rules | Delete all global rules
+*GlobalRulesApi* | [**deleteGlobalRule**](docs/GlobalRulesApi.md#deleteGlobalRule) | **DELETE** /admin/rules/{rule} | Delete global rule
+*GlobalRulesApi* | [**getGlobalRuleConfig**](docs/GlobalRulesApi.md#getGlobalRuleConfig) | **GET** /admin/rules/{rule} | Get global rule configuration
+*GlobalRulesApi* | [**listGlobalRules**](docs/GlobalRulesApi.md#listGlobalRules) | **GET** /admin/rules | List global rules
+*GlobalRulesApi* | [**updateGlobalRuleConfig**](docs/GlobalRulesApi.md#updateGlobalRuleConfig) | **PUT** /admin/rules/{rule} | Update global rule configuration
+*MetadataApi* | [**deleteArtifactVersionMetaData**](docs/MetadataApi.md#deleteArtifactVersionMetaData) | **DELETE** /groups/{groupId}/artifacts/{artifactId}/versions/{version}/meta | Delete artifact version metadata
+*MetadataApi* | [**getArtifactMetaData**](docs/MetadataApi.md#getArtifactMetaData) | **GET** /groups/{groupId}/artifacts/{artifactId}/meta | Get artifact metadata
+*MetadataApi* | [**getArtifactVersionMetaData**](docs/MetadataApi.md#getArtifactVersionMetaData) | **GET** /groups/{groupId}/artifacts/{artifactId}/versions/{version}/meta | Get artifact version metadata
+*MetadataApi* | [**getArtifactVersionMetaDataByContent**](docs/MetadataApi.md#getArtifactVersionMetaDataByContent) | **POST** /groups/{groupId}/artifacts/{artifactId}/meta | Get artifact version metadata by content
+*MetadataApi* | [**updateArtifactMetaData**](docs/MetadataApi.md#updateArtifactMetaData) | **PUT** /groups/{groupId}/artifacts/{artifactId}/meta | Update artifact metadata
+*MetadataApi* | [**updateArtifactVersionMetaData**](docs/MetadataApi.md#updateArtifactVersionMetaData) | **PUT** /groups/{groupId}/artifacts/{artifactId}/versions/{version}/meta | Update artifact version metadata
+*SearchApi* | [**searchArtifacts**](docs/SearchApi.md#searchArtifacts) | **GET** /search/artifacts | Search for artifacts
+*SearchApi* | [**searchArtifactsByContent**](docs/SearchApi.md#searchArtifactsByContent) | **POST** /search/artifacts | Search for artifacts by content
+*SystemApi* | [**getResourceLimits**](docs/SystemApi.md#getResourceLimits) | **GET** /system/limits | Get resource limits information
+*SystemApi* | [**getSystemInfo**](docs/SystemApi.md#getSystemInfo) | **GET** /system/info | Get system information
+*UsersApi* | [**getCurrentUserInfo**](docs/UsersApi.md#getCurrentUserInfo) | **GET** /users/me | Get current user
+*VersionsApi* | [**createArtifactVersion**](docs/VersionsApi.md#createArtifactVersion) | **POST** /groups/{groupId}/artifacts/{artifactId}/versions | Create artifact version
+*VersionsApi* | [**getArtifactVersion**](docs/VersionsApi.md#getArtifactVersion) | **GET** /groups/{groupId}/artifacts/{artifactId}/versions/{version} | Get artifact version
+*VersionsApi* | [**getArtifactVersionReferences**](docs/VersionsApi.md#getArtifactVersionReferences) | **GET** /groups/{groupId}/artifacts/{artifactId}/versions/{version}/references | Get artifact version
+*VersionsApi* | [**listArtifactVersions**](docs/VersionsApi.md#listArtifactVersions) | **GET** /groups/{groupId}/artifacts/{artifactId}/versions | List artifact versions
+*VersionsApi* | [**updateArtifactVersionState**](docs/VersionsApi.md#updateArtifactVersionState) | **PUT** /groups/{groupId}/artifacts/{artifactId}/versions/{version}/state | Update artifact version state
+
+
+## Documentation for Models
+
+ - [ArtifactMetaData](docs/ArtifactMetaData.md)
+ - [ArtifactReference](docs/ArtifactReference.md)
+ - [ArtifactSearchResults](docs/ArtifactSearchResults.md)
+ - [ArtifactState](docs/ArtifactState.md)
+ - [ArtifactType](docs/ArtifactType.md)
+ - [ConfigurationProperty](docs/ConfigurationProperty.md)
+ - [ContentCreateRequest](docs/ContentCreateRequest.md)
+ - [DownloadRef](docs/DownloadRef.md)
+ - [EditableMetaData](docs/EditableMetaData.md)
+ - [Error](docs/Error.md)
+ - [IfExists](docs/IfExists.md)
+ - [Limits](docs/Limits.md)
+ - [LogConfiguration](docs/LogConfiguration.md)
+ - [LogLevel](docs/LogLevel.md)
+ - [NamedLogConfiguration](docs/NamedLogConfiguration.md)
+ - [NamedLogConfigurationAllOf](docs/NamedLogConfigurationAllOf.md)
+ - [RoleMapping](docs/RoleMapping.md)
+ - [RoleType](docs/RoleType.md)
+ - [Rule](docs/Rule.md)
+ - [RuleType](docs/RuleType.md)
+ - [RuleViolationCause](docs/RuleViolationCause.md)
+ - [RuleViolationError](docs/RuleViolationError.md)
+ - [RuleViolationErrorAllOf](docs/RuleViolationErrorAllOf.md)
+ - [SearchedArtifact](docs/SearchedArtifact.md)
+ - [SearchedVersion](docs/SearchedVersion.md)
+ - [SortBy](docs/SortBy.md)
+ - [SortOrder](docs/SortOrder.md)
+ - [SystemInfo](docs/SystemInfo.md)
+ - [UpdateConfigurationProperty](docs/UpdateConfigurationProperty.md)
+ - [UpdateRole](docs/UpdateRole.md)
+ - [UpdateState](docs/UpdateState.md)
+ - [UserInfo](docs/UserInfo.md)
+ - [VersionMetaData](docs/VersionMetaData.md)
+ - [VersionSearchResults](docs/VersionSearchResults.md)
+
+
+## Documentation for Authorization
+
+All endpoints do not require authorization.
+Authentication schemes defined for the API:
+
+## Recommendation
+
+It's recommended to create an instance of `ApiClient` per thread in a multithreaded environment to avoid any potential issues.
+
+## Author
+
+apicurio@lists.jboss.org
+