Skip to content

Commit 44ce623

Browse files
authored
docs: JR-415: Updates some menu items, adds a note about the API desi… (#570)
* docs: JR-415: Updates some menu items, adds a note about the API design title * docs: JR-415: Replaces text with attribute
1 parent fdab318 commit 44ce623

File tree

1 file changed

+10
-4
lines changed
  • docs/api-designer/getting-started-api-designer

1 file changed

+10
-4
lines changed

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

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -132,6 +132,9 @@ endif::[]
132132
* *Template*: Select the *Pet Store Example* template, or select another template from the list.
133133
. Click *Create*. The new API design opens in the design editor.
134134
. Select the design title and click the pen icon. Change the design title to *Orders* and click the *Save changes* icon.
135+
+
136+
NOTE: Editing the design _title_ does not change the design _name_. To rename a design, click *Actions > Edit design metadata*, edit the design name, and click *Save*.
137+
+
135138
. Click the *Design* tab, and optionally edit the design as follows:
136139
* Provide a version number and a description.
137140
* _(AsyncAPI only)_ Define terms of service.
@@ -144,7 +147,7 @@ endif::[]
144147
* _(OpenAPI only)_ Configure vendor extensions.
145148
. Click the *Source* tab, and review the live preview of the design.
146149
The content of the *Source* tab automatically updates when you edit values on the editor page.
147-
. _(Optional)_ To see the changes that you made since the last save, click *Actions > Show changes*.
150+
. _(Optional)_ To see the changes that you made since the last save, click *Actions > Show design changes*.
148151
. _(Optional)_ In the left pane of the design editor, you can add the following items:
149152
* _(OpenAPI only)_ Resource paths, data types, and responses
150153
* _(AsyncAPI only)_ Channels, data types, messages, operation traits, and message traits
@@ -182,8 +185,8 @@ endif::[]
182185
* *Type*: From the list, select *Apache Avro*, or select another schema type.
183186
. Click *Create*. The new schema design opens in the design editor.
184187
. Edit the design source to provide your content.
185-
. _(Optional)_ To see the changes that you made since the last save, click *Actions > Show changes*.
186-
. _(Optional)_ For Apache Avro or JSON Schema designs, you can click *Actions > Format content* to insert spaces and tabs that align your design content correctly.
188+
. _(Optional)_ To see the changes that you made since the last save, click *Actions > Show design changes*.
189+
. _(Optional)_ For Apache Avro or JSON Schema designs, you can click *Actions > Format design content* to insert spaces and tabs that align your design content correctly.
187190
. Click *Save*.
188191
+
189192
The new design is listed on the *API and Schema Designs* page.
@@ -251,7 +254,7 @@ For more information, see {base-url}{getting-started-url-registry}[Getting start
251254
.Procedure
252255
. On the *API and Schema Designs* page of the {service-url-api-designer}[{product-long-api-designer} web console^], select the design that you want to test.
253256
. Click the options icon (three vertical dots), and click *Edit design content* to open the design editor.
254-
. From the *Actions* menu, click *Test using Service Registry*.
257+
. From the *Actions* menu, click *Run {registry} check*.
255258
. From the *Registry instance* list, select a {registry} instance.
256259
. In the *Group* and *ID* fields, specify the artifact details.
257260
. Click *Test*.
@@ -288,6 +291,9 @@ For more information, see {base-url}{getting-started-url-registry}[Getting start
288291
.Procedure
289292
. On the *API and Schema Designs* page of the {service-url-api-designer}[{product-long-api-designer} web console^], select the design that you want to export.
290293
. Click the options icon (three vertical dots), and click *Export design to {registry}*.
294+
+
295+
NOTE: You can also select *Export design to {registry}* from the *Actions* menu in the design editor.
296+
+
291297
. Complete the form to specify where to save the new design. Provide the following details:
292298
+
293299
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.

0 commit comments

Comments
 (0)