Built by Maven

apicurio-registry:register

Full name:

io.apicurio:apicurio-registry-maven-plugin:3.0.6:register

Description:

Register artifacts against registry.

Attributes:

  • Requires a Maven project to be executed.
  • The goal is not marked as thread-safe and thus does not support parallel builds.

Required Parameters

Name Type Since Description
<artifacts> List<RegisterArtifact> - The list of artifacts to register.
<registryUrl> String - The registry's url. e.g. http://localhost:8080/apis/registry/v3
User Property: apicurio.url

Optional Parameters

Name Type Since Description
<authServerUrl> String - The URL of the authentication server (if required).
User Property: auth.server.url
<clientId> String - The client id to use when authenticating to the auth sever.
User Property: client.id
<clientScope> String - The client scope to use when authenticating to the auth sever.
User Property: client.scope
<clientSecret> String - The client secret to use when authenticating to the auth sever.
User Property: client.secret
<dryRun> boolean - Set this to 'true' to perform the action with the "dryRun" option enabled. This will effectively test whether registration *would have worked*. But it results in no changes made on the server.
Default: false
User Property: dryRun
<existingReferences> List<ExistingReference> - The list of pre-registered artifacts that can be used as references.
<password> String - Authentication credentials: password
User Property: password
<skip> boolean - Set this to 'true' to skip registering the artifact(s). Convenient in case you want to skip for specific occasions.
Default: false
User Property: skipRegister
<username> String - Authentication credentials: username
User Property: username

Parameter Details

<artifacts>

The list of artifacts to register.
  • Type: java.util.List<io.apicurio.registry.maven.RegisterArtifact>
  • Required: Yes

<authServerUrl>

The URL of the authentication server (if required).
  • Type: java.lang.String
  • Required: No
  • User Property: auth.server.url

<clientId>

The client id to use when authenticating to the auth sever.
  • Type: java.lang.String
  • Required: No
  • User Property: client.id

<clientScope>

The client scope to use when authenticating to the auth sever.
  • Type: java.lang.String
  • Required: No
  • User Property: client.scope

<clientSecret>

The client secret to use when authenticating to the auth sever.
  • Type: java.lang.String
  • Required: No
  • User Property: client.secret

<dryRun>

Set this to 'true' to perform the action with the "dryRun" option enabled. This will effectively test whether registration *would have worked*. But it results in no changes made on the server.
  • Type: boolean
  • Required: No
  • User Property: dryRun
  • Default: false

<existingReferences>

The list of pre-registered artifacts that can be used as references.
  • Type: java.util.List<io.apicurio.registry.maven.ExistingReference>
  • Required: No

<password>

Authentication credentials: password
  • Type: java.lang.String
  • Required: No
  • User Property: password

<registryUrl>

The registry's url. e.g. http://localhost:8080/apis/registry/v3
  • Type: java.lang.String
  • Required: Yes
  • User Property: apicurio.url

<skip>

Set this to 'true' to skip registering the artifact(s). Convenient in case you want to skip for specific occasions.
  • Type: boolean
  • Required: No
  • User Property: skipRegister
  • Default: false

<username>

Authentication credentials: username
  • Type: java.lang.String
  • Required: No
  • User Property: username