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
Copy file name to clipboardExpand all lines: docs/api-designer/getting-started-api-designer/README.adoc
+10-4Lines changed: 10 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -132,6 +132,9 @@ endif::[]
132
132
* *Template*: Select the *Pet Store Example* template, or select another template from the list.
133
133
. Click *Create*. The new API design opens in the design editor.
134
134
. 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
+
+
135
138
. Click the *Design* tab, and optionally edit the design as follows:
136
139
* Provide a version number and a description.
137
140
* _(AsyncAPI only)_ Define terms of service.
@@ -144,7 +147,7 @@ endif::[]
144
147
* _(OpenAPI only)_ Configure vendor extensions.
145
148
. Click the *Source* tab, and review the live preview of the design.
146
149
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*.
148
151
. _(Optional)_ In the left pane of the design editor, you can add the following items:
149
152
* _(OpenAPI only)_ Resource paths, data types, and responses
150
153
* _(AsyncAPI only)_ Channels, data types, messages, operation traits, and message traits
@@ -182,8 +185,8 @@ endif::[]
182
185
* *Type*: From the list, select *Apache Avro*, or select another schema type.
183
186
. Click *Create*. The new schema design opens in the design editor.
184
187
. 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.
187
190
. Click *Save*.
188
191
+
189
192
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
251
254
.Procedure
252
255
. 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.
253
256
. 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*.
255
258
. From the *Registry instance* list, select a {registry} instance.
256
259
. In the *Group* and *ID* fields, specify the artifact details.
257
260
. Click *Test*.
@@ -288,6 +291,9 @@ For more information, see {base-url}{getting-started-url-registry}[Getting start
288
291
.Procedure
289
292
. 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.
290
293
. 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
+
+
291
297
. Complete the form to specify where to save the new design. Provide the following details:
292
298
+
293
299
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