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 a developer of applications and services, you can use {product-long-api-designer} to design event schemas and REST API definitions that comply with vendor-neutral and portable open specifications.
82
+
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.
83
83
{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
84
85
85
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^].
@@ -131,7 +131,7 @@ endif::[]
131
131
.Creating an API design
132
132
image::create-api-designer-design.png[Image of page to create an API design]
133
133
+
134
-
. Click *Create* to create the design. The design editor opens automatically.
134
+
. Click *Create*. The new API design opens in the design editor.
135
135
. Select the design title and click the pen icon. Change the design title to *Orders* and click the *Save changes* icon.
136
136
. Click the *Design* tab, and optionally edit the design as follows:
137
137
.. Provide a version number and a description.
@@ -154,7 +154,7 @@ The content of the *Source* tab automatically updates when you edit values on th
154
154
. Optional: In the left pane of the design editor, you can add the following items:
155
155
.. OpenAPI: Resource paths, data types, and responses
156
156
.. AsyncAPI: Channels, data types, messages, operation traits, and message traits
157
-
. Click *Save* to save all changes and close the design editor.
157
+
. Click *Save*.
158
158
159
159
The new design is listed on the designs page. You can use the options icon (three vertical dots) to open the design editor, download the design to a file, or delete the design.
160
160
@@ -176,7 +176,7 @@ endif::[]
176
176
== Creating a schema design
177
177
178
178
[role="_abstract"]
179
-
Use the {product-long-api-designer} web console to create an Apache Avro, JSON, or Google Protocol Buffers (Protobuf) event schema.
179
+
Use the {product-long-api-designer} web console to create an Apache Avro, JSON Schema, or Google Protocol Buffers (Protobuf) event schema.
180
180
181
181
ifndef::qs[]
182
182
.Prerequisites
@@ -194,14 +194,14 @@ endif::[]
194
194
.Creating a schema design
195
195
image::create-schema-design.png[Image of page to create a schema design]
196
196
+
197
-
. Click *Create* to create the design. The design editor opens automatically.
198
-
. Edit the design to provide your content.
197
+
. Click *Create*. The new schema design opens in the design editor.
198
+
. Edit the design source to provide your content.
199
199
+
200
200
[.screencapture]
201
201
.Editing a schema design
202
202
image::api-designer-schema-editor.png[Image of schema design editor]
203
203
+
204
-
. Click *Save* to save all changes and close the design editor.
204
+
. Click *Save*.
205
205
206
206
The new design is listed on the designs page. You can use the options icon (three vertical dots) to open the design editor, download the design to a file, or delete the design.
207
207
@@ -216,22 +216,23 @@ ifndef::qs[]
216
216
endif::[]
217
217
218
218
[id="proc-importing-schema-api-design_{context}"]
219
-
== Importing an {product-long-api-designer} schema or API design
219
+
== Importing a schema or API design
220
220
221
221
[role="_abstract"]
222
222
You can import an event schema or API definition into {product-long-api-designer} from a URL, from a file, or from an {product-long-registry} instance.
223
223
224
224
.Prerequisites
225
225
* You're logged in to the {product-api-designer} web console at {service-url-api-designer}[^].
226
-
* You can access a running {product-registry} instance, if you want to import from {registry}.
226
+
* You can access a running {product-registry} instance in your organization, if you want to import from {registry}.
227
227
228
228
.Procedure
229
229
. In the {service-url-api-designer}[{product-api-designer} web console], click *Import a schema or API design*, and then click one of the following options:
230
-
.. *Import from file*: Click *Browse* and select a file, or drag and drop a file, and then click *Import*.
231
-
.. *Import from URL*: Enter a valid and accessible URL, and then click *Import*.
232
-
.. *Import from {registry}*: From the instances list, select a registry instance to show a list of its artifacts. Select an artifact, and then click *Import*.
233
-
. After you import the design, the design editor opens automatically.
234
-
. When you have finished editing, you can save your changes locally, download the content to a file, or export the updated design to {registry}.
230
+
.. *Import from file*: Click *Browse* and select a file, or drag and drop a file.
231
+
.. *Import from URL*: Enter a valid and accessible URL.
232
+
.. *Import from {registry}*: From the instances list, select a {registry} instance. Browse the list of artifacts for that instance, and select an artifact.
233
+
. Click *Import*. The design editor opens automatically.
234
+
235
+
When you finish editing, you can export the updated design to {registry} as a new artifact or as a new version of the existing artifact. You can also save your changes locally, or download the content to a file.
235
236
236
237
.Verification
237
238
ifdef::qs[]
@@ -244,20 +245,20 @@ ifndef::qs[]
244
245
endif::[]
245
246
246
247
[id="proc-exporting-schema-api-design_{context}"]
247
-
== Exporting an {product-long-api-designer} schema or API design
248
+
== Exporting a schema or API design
248
249
249
250
[role="_abstract"]
250
-
After you create or import an {product-long-api-designer} event schema or API definition, you can export the content to an existing {product-long-registry} instance.
251
+
When you're happy with your changes to an {product-long-api-designer} event schema or API definition, and you want to use the design in your application, you can export the content to an existing {product-long-registry} instance.
251
252
252
253
.Prerequisites
253
254
* You're logged in to the {product-api-designer} web console at {service-url-api-designer}[^].
254
255
* You've created or imported an {product-api-designer} design.
255
-
* You can access a running {product-registry} instance.
256
+
* You can access a running {product-registry} instance in your organization.
256
257
257
258
.Procedure
258
259
. In the *{product-api-designer}* designs page of the web console, select the {product-api-designer} design that you want to export.
259
260
. Click *Edit* to open the design editor.
260
-
. From the *Save to* menu, click *Export to {registry}*.
261
+
. From the *Actions* menu, click *Export to {registry}*.
261
262
. Complete the form to specify where the new design should be saved.
262
263
+
263
264
NOTE: If the design was originally imported from {product-registry}, the fields are prepopulated with the details of the original {product-registry} instance, and the *Version* is incremented.
@@ -269,7 +270,12 @@ NOTE: Specifying a group is optional when using the web console: {registry} gen
269
270
+
270
271
.. *Artifact ID*: Enter an optional unique ID for this artifact, such as `my-ID`. If you don't specify a unique artifact ID, {registry} generates one automatically as a UUID.
271
272
.. *Version*: Specify the version number.
272
-
. Click *Save*.
273
+
+
274
+
[.screencapture]
275
+
.Exporting an API design
276
+
image::export-api-designer-design.png[Image of page to export an API design]
277
+
+
278
+
. Click *Export*.
273
279
274
280
You can manage {product-long-api-designer} design versions in {product-long-registry}. You can also download {product-api-designer} designs to a file, either for local client code generation or to import the designs into {product-long-api-management}.
0 commit comments