You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* Update all REST API endpoint references
* Removed docs about generating client SDK (feature removed for now)
* rename client to sdk
* Build using local playbook
* Updates to core documentation for 3.0
* Lots of changes to docs for the 3.0 release
* Lots more docs changes
Copy file name to clipboardexpand all lines: docs-playbook/package.json
+1-1
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
{
2
2
"name": "apicurio-docs-playbook",
3
-
"version": "1.0.0",
3
+
"version": "3.0.0",
4
4
"description": "This folder contains the configuration and scripts used when building the Apicurio Registry documentation for publishing to the Apicurio project web site. We are using a tool called Antora to build the asciidoc based documentation into a publishable site. However, due to some issues with building on various platforms (I'm looking at you, Windows) and also some conflicts between what Antora builds and what our GitHub Pages (jekyll) project site expects, we have created a non-trivial (but automated) process for building the docs.",
This chapter explains how to set important configuration options for your {registry} deployment. This includes features such as the {registry} web console, logging, events, and health checks:
8
+
This chapter explains how to set important configuration options for your {registry} deployment. This includes features such as the {registry} web console, logging, and health checks:
Copy file name to clipboardexpand all lines: docs/modules/ROOT/pages/getting-started/assembly-installing-registry-docker.adoc
+1-1
Original file line number
Diff line number
Diff line change
@@ -14,7 +14,7 @@ This chapter explains how to install and run {registry} using Docker with the fo
14
14
.Prerequisites
15
15
* {registry-overview}
16
16
17
-
NOTE: You can install more than one instance of {registry} depending on your environment. The number of instances depends on your storage option, for example, your Kafka or database cluster configuration, and on the number and type of artifacts stored in {registry}.
17
+
NOTE: You can install more than one replica of {registry} depending on your environment. The number of replicas depends on your storage option, for example, your Kafka or database cluster configuration, and on the number and type of artifacts stored in {registry}.
//If the assembly covers a task, start the title with a verb in the gerund form, such as Creating or Configuring.
7
7
8
8
[role="_abstract"]
9
-
Client applications can use {registry} REST API operations to manage schema and API artifacts in {registry}, for example, in a CI/CD pipeline deployed in production. The Core Registry API v2 provides operations for artifacts, versions, metadata, and rules stored in {registry}. For detailed information, see the {registry-rest-api}.
9
+
Client applications can use {registry} REST API operations to manage schema and API artifacts in {registry}, for example, in a CI/CD pipeline deployed in production. The Core Registry API v3 provides operations for artifacts, versions, metadata, and rules stored in {registry}. For detailed information, see the {registry-rest-api}.
10
10
11
-
This chapter shows examples of how to use the Core Registry API v2 to perform the following tasks:
11
+
This chapter shows examples of how to use the Core Registry API v3 to perform the following tasks:
Copy file name to clipboardexpand all lines: docs/modules/ROOT/partials/getting-started/con-kafka-connect-converters.adoc
-5
Original file line number
Diff line number
Diff line change
@@ -7,12 +7,7 @@
7
7
You can use {registry} with Apache Kafka Connect to stream data between Kafka and external systems. Using Kafka Connect, you can define connectors for different systems to move large volumes of data into and out of Kafka-based systems.
8
8
9
9
.{registry} and Kafka Connect architecture
10
-
ifdef::apicurio-registry,rh-service-registry[]
11
10
image::images/getting-started/registry-connect-architecture.png[Registry and Kafka Connect architecture]
12
-
endif::[]
13
-
ifdef::rh-openshift-sr[]
14
-
image::../_images/introduction/registry-connect-architecture.png[Registry and Kafka Connect architecture]
15
-
endif::[]
16
11
17
12
{registry} provides the following features for Kafka Connect:
Copy file name to clipboardexpand all lines: docs/modules/ROOT/partials/getting-started/con-registry-artifacts.adoc
+59-17
Original file line number
Diff line number
Diff line change
@@ -28,6 +28,51 @@ The items stored in {registry}, such as event schemas and API designs, are known
28
28
29
29
When a schema or API design is added as an artifact in {registry}, client applications can then use that schema or API design to validate that the client messages conform to the correct data structure at runtime.
30
30
31
+
Artifacts have metadata, both generated and editable. Standard metadata for an artifact includes (but may not be limited to):
32
+
33
+
=== Generated or immutable properties
34
+
35
+
- groupId
36
+
- artifactId
37
+
- artifactType
38
+
- createdOn
39
+
- modifiedBy
40
+
- modifiedOn
41
+
42
+
=== Editable properties
43
+
- name
44
+
- description
45
+
- labels
46
+
- owner
47
+
48
+
[discrete]
49
+
== Artifact Versions
50
+
Every artifact is composed of zero or more _artifact version_s. Only artifact versions have actual
51
+
content (as well as metadata). These versions represent the evolution of the content of an artifact,
52
+
and are immutable. You can think of an Artifact as an ordered sequence of Versions, typically with
53
+
the most recent version representing the "current" schema or API design content.
54
+
55
+
56
+
Artifact Versions have metadata, both generated and editable. Standard metadata for an artifact version includes (but may not be limited to):
57
+
58
+
=== Generated or immutable properties
59
+
60
+
- groupId
61
+
- artifactId
62
+
- version
63
+
- globalId
64
+
- contentId
65
+
- owner
66
+
- createdOn
67
+
- modifiedBy
68
+
- modifiedOn
69
+
70
+
=== Editable properties
71
+
- name
72
+
- description
73
+
- labels
74
+
- state
75
+
31
76
32
77
[discrete]
33
78
== Groups of schemas and APIs
@@ -38,20 +83,23 @@ You can create optional artifact groups when adding your schemas and API designs
38
83
39
84
Schema and API groups can contain multiple artifact types. For example, you could have Protobuf, Avro, JSON Schema, OpenAPI, or AsyncAPI artifacts all in the same group.
40
85
41
-
You can create schema and API artifacts and groups using the {registry} web console, REST API, command line, Maven plug-in, or Java client application. The following simple example shows using the Core Registry REST API:
86
+
Groups have metadata, both generated and editable. Standard metadata for a group includes (but may not be limited to):
42
87
43
-
[source,bash]
44
-
----
45
-
$ curl -X POST -H "Content-type: application/json; artifactType=AVRO" \
This example creates an artifact group named `my-group` and adds an Avro schema with an artifact ID of `share-price`.
100
+
You can create schema and API artifacts and groups using the {registry} web console, REST API, command line, Maven plug-in, or Java client application.
53
101
54
-
NOTE: Specifying a group is optional when using the {registry} web console, and a `default` group is created automatically. When using the REST API or Maven plug-in, specify the `default` group in the API path if you do not want to create a unique group.
102
+
NOTE: Specifying a group is optional when using the {registry} web console, and the `default` group is used automatically. When using the REST API or Maven plug-in, specify the `default` group in the API path if you do not want to create a unique group.
55
103
56
104
[role="_additional-resources"]
57
105
.Additional resources
@@ -121,12 +169,6 @@ You can manage artifact references using the {registry} core REST API, Maven plu
121
169
.Additional resources
122
170
123
171
* For details on managing artifact references, see:
124
-
ifdef::apicurio-registry,rh-service-registry[]
125
172
** {managing-registry-artifacts-api}.
126
173
** {managing-registry-artifacts-maven}.
127
-
endif::[]
128
-
ifdef::rh-openshift-sr[]
129
-
** {base-url}{manage-api-url-registry}[Managing Service Registry data using the Core Registry API].
130
-
** {base-url}{manage-maven-plugin-url-registry}[Managing schemas and APIs using the Service Registry Maven plug-in].
131
-
endif::[]
132
174
* For a Java example, see the https://github.com/Apicurio/apicurio-registry/tree/main/examples/serdes-with-references[Apicurio Registry SerDes with references demonstration].
0 commit comments