Skip to content

Commit 5180fcd

Browse files
authored
docs: JR-339: Updates based on SME feedback (#541)
1 parent b230282 commit 5180fcd

File tree

1 file changed

+8
-8
lines changed
  • docs/api-designer/getting-started-api-designer

1 file changed

+8
-8
lines changed

docs/api-designer/getting-started-api-designer/README.adoc

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ ifdef::context[:parent-context: {context}]
8181
// Purpose statement for the assembly
8282
[role="_abstract"]
8383
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.
8585

8686
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^].
8787

@@ -103,7 +103,7 @@ Learn how to create your first API or schema design in {product-long-api-designe
103103
[#introduction]
104104
====
105105
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}.
107107
====
108108
endif::[]
109109

@@ -121,7 +121,7 @@ endif::[]
121121
.Procedure
122122
. In the {service-url-api-designer}[{product-long-api-designer} web console^], click *Create design*.
123123
. 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`.
125125
* *Description* _(Optional)_: Enter a short description of the design.
126126
* *Type*: Accept the default value *OpenAPI*, or select another API type from the list.
127127
* *Version* _(OpenAPI only)_: Accept the default value *3.0.2*, or select another version from the list.
@@ -173,7 +173,7 @@ endif::[]
173173
.Procedure
174174
. In the {service-url-api-designer}[{product-long-api-designer} web console^], click *Create design*.
175175
. 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`.
177177
* *Description* _(Optional)_: Enter a short description of the design.
178178
* *Type*: From the list, select *Apache Avro*, or select another schema type.
179179
. 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
257257
* If the design content obeys the specified rules, the registration issues pane contains the following text:
258258
`Registry Test completed with no issues`
259259

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.
261261

262262
.Verification
263263
ifdef::qs[]
@@ -286,18 +286,18 @@ For more information, see {base-url}{getting-started-url-registry}[Getting start
286286
. Click the options icon (three vertical dots), and click *Export to {registry}*.
287287
. Complete the form to specify where to save the new design. Provide the following details:
288288
+
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.
290290
+
291291
* *Registry Instance*: Select the required instance from the list.
292292
* *Group* _(Optional)_: Enter a unique group name such as `my-org` to organize the artifact in a named collection.
293293
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.
294294
+
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.
296296
+
297297
* *ID* _(Optional)_: Enter a unique ID for this artifact, such as `my-ID`.
298298
If you don't specify a unique artifact ID, {registry} generates one automatically as a UUID.
299299
* *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.
301301
. Click *Export*.
302302
The exported design is listed on the artifacts page of the specified {registry} instance.
303303

0 commit comments

Comments
 (0)