Chapter 3. Managing Service Registry content using the web console

Procedure

1. Connect to the Service Registry web console on:

   http://MY_REGISTRY_URL/ui

2. Click Upload artifact, and specify the following:

   • Group & ID: Use the default empty settings to automatically generate an ID and default group, or enter an optional artifact group or ID.

   • Type: Use the default Auto-Detect setting to automatically detect the artifact type, or select the artifact type from the drop-down, for example, Avro Schema or OpenAPI.

     Note

     The Service Registry server cannot automatically detect the Kafka Connect Schema artifact type. You must manually select this artifact type.

   • Artifact: Drag and drop or click Browse to upload a file, for example, my-schema.json or my-openapi.json.

3. Click Upload and view the Artifact Details:

   Figure 3.1. Artifact Details in Service Registry web console

   
   • Info: Displays the artifact name and optional group, description, lifecycle status, when created, and last modified. Click the Edit Artifact Metadata pencil icon to edit the artifact name and description or add labels, and click Download to download the artifact file locally. Also displays artifact Content Rules that you can enable and configure.
   • Documentation (OpenAPI only): Displays automatically-generated REST API documentation.
   • Content: Displays a read-only view of the full artifact content.
4. In Content Rules, click Enable to configure a Validity Rule or Compatibility Rule, and select the appropriate rule configuration from the drop-down. For more details, see Chapter 8, Service Registry artifact reference.
5. Click Upload new version to add a new artifact version, and drag and drop or click Browse to upload the file, for example, my-schema.json or my-openapi.json.

6. To delete an artifact, click the trash icon next to Upload new version.

   Warning

   Deleting an artifact deletes the artifact and all of its versions, and cannot be undone. Artifact versions are immutable and cannot be deleted individually.

Procedure

1. Connect to the Service Registry web console on:

   http://MY_REGISTRY_URL/ui

2. Browse the list of artifacts stored in the registry, or enter a search string to find an artifact. You can select to search by a specific Name, Group, Description, or Labels.

   Figure 3.2. Browse artifacts in Service Registry web console

   

3. Click View artifact to view the Artifact Details:

   • Info: Displays the artifact name and optional group, description, lifecycle status, when created, and last modified. Click the Edit Artifact Metadata pencil icon to edit the artifact name and description or add labels, and click Download to download the artifact file locally. Also displays artifact Content Rules that you can enable and configure.
   • Documentation (OpenAPI only): Displays automatically-generated REST API documentation.
   • Content: Displays a read-only view of the full artifact content.
4. Select to view a different artifact Version from the drop-down, if additional versions have been added.

Procedure

1. Connect to the Service Registry web console on:

   http://MY_REGISTRY_URL/ui

2. For artifact rules, browse the list of artifacts stored in the registry, or enter a search string to find an artifact. You can select to search by a specific artifact Name, Group, Description, or Labels.
3. Click View artifact to view the Artifact Details.

4. In Content Rules, click Enable to configure an artifact Validity Rule or Compatibility Rule, and select the appropriate rule configuration from the drop-down. For more details, see Chapter 8, Service Registry artifact reference.

   Figure 3.3. Configure content rules in Service Registry web console

   
5. For global rules, click Manage global rules at the top right of the toolbar, and click Enable to configure a global Validity Rule or Compatibility Rule, and select the appropriate rule configuration from the drop-down. For more details, see Chapter 8, Service Registry artifact reference.
6. To disable an artifact rule or global rule, click the trash icon next to the rule.