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
As an API owner or developer, you can use {product-long-api-designer} to design event schemas and API definitions that comply with vendor-neutral and portable open specifications.
84
-
{product-long-api-designer} is a managed cloud service that enables you to design schemas and API definitions without having to install, configure, run, and maintain your own {product-api-designer} clusters.
84
+
{product-long-api-designer} is a managed cloud service that enables you to design schemas and API definitions without having to install, configure, run, and maintain your own {product-api-designer} infrastructure.
85
85
86
86
For more overview information, see the https://access.redhat.com/documentation/en-us/red_hat_openshift_api-designer/1[{product-long-api-designer} user documentation^].
87
87
@@ -103,7 +103,7 @@ Learn how to create your first API or schema design in {product-long-api-designe
103
103
[#introduction]
104
104
====
105
105
Welcome to the quick start for {product-long-api-designer}.
106
-
In this quick start, you'll learn how to create an API definition or event schema from a blank page or from a template, import an existing design to edit it, and export a finished design to {product-registry}.
106
+
In this quick start, you'll learn how to create an API definition or event schema from a simple or detailed template, import an existing design to edit it, test a design against rules configured in {product-long-registry}, and export a finished design to {product-registry}.
107
107
====
108
108
endif::[]
109
109
@@ -121,7 +121,7 @@ endif::[]
121
121
.Procedure
122
122
. In the {service-url-api-designer}[{product-long-api-designer} web console^], click *Create design*.
123
123
. Complete the form to provide the following details for the new design:
124
-
* *Name*: Enter a unique design name, such as `my-api-design`.
124
+
* *Name*: Enter a unique design name, such as `My API Design`.
125
125
* *Description* _(Optional)_: Enter a short description of the design.
126
126
* *Type*: Accept the default value *OpenAPI*, or select another API type from the list.
127
127
* *Version* _(OpenAPI only)_: Accept the default value *3.0.2*, or select another version from the list.
@@ -173,7 +173,7 @@ endif::[]
173
173
.Procedure
174
174
. In the {service-url-api-designer}[{product-long-api-designer} web console^], click *Create design*.
175
175
. Complete the form to provide the following details for the new design:
176
-
* *Name*: Enter a unique design name, such as `my-schema-design`.
176
+
* *Name*: Enter a unique design name, such as `My Schema Design`.
177
177
* *Description* _(Optional)_: Enter a short description of the design.
178
178
* *Type*: From the list, select *Apache Avro*, or select another schema type.
179
179
. Click *Create*. The new schema design opens in the design editor.
@@ -257,7 +257,7 @@ A new pane in the design editor window shows the registration issues found by th
257
257
* If the design content obeys the specified rules, the registration issues pane contains the following text:
258
258
`Registry Test completed with no issues`
259
259
260
-
* If the registration issues pane provides details of any issues, resolve the issues and click *Retry* to retest the content using the same rules.
260
+
* If the registration issues pane provides details of any issues, resolve the issues and click *Retry* to retest the content using the same artifact rules.
261
261
262
262
.Verification
263
263
ifdef::qs[]
@@ -286,18 +286,18 @@ For more information, see {base-url}{getting-started-url-registry}[Getting start
286
286
. Click the options icon (three vertical dots), and click *Export to {registry}*.
287
287
. Complete the form to specify where to save the new design. Provide the following details:
288
288
+
289
-
NOTE: If the design was originally imported from {product-long-registry}, the fields are prepopulated with the details of the original {product-registry} instance, and the *Version* is incremented.
289
+
NOTE: If the design was originally imported from {product-long-registry}, the fields are prepopulated with the details of the original {product-registry} instance, and the *Version* field is blank.
290
290
+
291
291
* *Registry Instance*: Select the required instance from the list.
292
292
* *Group* _(Optional)_: Enter a unique group name such as `my-org` to organize the artifact in a named collection.
293
293
Each group contains a logically related set of schemas or API designs, typically managed by a single entity, belonging to a particular application or organization.
294
294
+
295
-
NOTE: Specifying a group is optional when using the web console: {registry} generates a `default` group automatically.
295
+
NOTE: Specifying a group is optional when using the web console. If no group is specified, {registry} uses the `default` group.
296
296
+
297
297
* *ID* _(Optional)_: Enter a unique ID for this artifact, such as `my-ID`.
298
298
If you don't specify a unique artifact ID, {registry} generates one automatically as a UUID.
299
299
* *Version* _(Optional)_: Specify the version number.
300
-
If you don't specify a version number, {registry} sets the version to 1.
300
+
If you don't specify a version number, {registry} sets the version to 1 for the first version, or increments the latest version by 1 for subsequent versions.
301
301
. Click *Export*.
302
302
The exported design is listed on the artifacts page of the specified {registry} instance.
0 commit comments