|
| 1 | +//// |
| 2 | +START GENERATED ATTRIBUTES |
| 3 | +WARNING: This content is generated by running npm --prefix .build run generate:attributes |
| 4 | +//// |
| 5 | + |
| 6 | +//All OpenShift Application Services |
| 7 | +:org-name: Application Services |
| 8 | +:product-long-rhoas: OpenShift Application Services |
| 9 | +:community: |
| 10 | +:imagesdir: ./images |
| 11 | +:property-file-name: app-services.properties |
| 12 | +:samples-git-repo: https://github.com/redhat-developer/app-services-guides |
| 13 | +:base-url: https://github.com/redhat-developer/app-services-guides/tree/main/docs/ |
| 14 | + |
| 15 | +//OpenShift Application Services CLI |
| 16 | +:base-url-cli: https://github.com/redhat-developer/app-services-cli/tree/main/docs/ |
| 17 | +:command-ref-url-cli: commands |
| 18 | +:installation-guide-url-cli: rhoas/rhoas-cli-installation/README.adoc |
| 19 | + |
| 20 | +//OpenShift Streams for Apache Kafka |
| 21 | +:product-long-kafka: OpenShift Streams for Apache Kafka |
| 22 | +:product-kafka: Streams for Apache Kafka |
| 23 | +:product-version-kafka: 1 |
| 24 | +:service-url-kafka: https://console.redhat.com/application-services/streams/ |
| 25 | +:getting-started-url-kafka: kafka/getting-started-kafka/README.adoc |
| 26 | +:kafka-bin-scripts-url-kafka: kafka/kafka-bin-scripts-kafka/README.adoc |
| 27 | +:kafkacat-url-kafka: kafka/kcat-kafka/README.adoc |
| 28 | +:quarkus-url-kafka: kafka/quarkus-kafka/README.adoc |
| 29 | +:nodejs-url-kafka: kafka/nodejs-kafka/README.adoc |
| 30 | +:getting-started-rhoas-cli-url-kafka: kafka/rhoas-cli-getting-started-kafka/README.adoc |
| 31 | +:topic-config-url-kafka: kafka/topic-configuration-kafka/README.adoc |
| 32 | +:consumer-config-url-kafka: kafka/consumer-configuration-kafka/README.adoc |
| 33 | +:access-mgmt-url-kafka: kafka/access-mgmt-kafka/README.adoc |
| 34 | +:metrics-monitoring-url-kafka: kafka/metrics-monitoring-kafka/README.adoc |
| 35 | +:service-binding-url-kafka: kafka/service-binding-kafka/README.adoc |
| 36 | + |
| 37 | +//OpenShift Service Registry |
| 38 | +:product-long-registry: OpenShift Service Registry |
| 39 | +:product-registry: Service Registry |
| 40 | +:registry: Service Registry |
| 41 | +:product-version-registry: 1 |
| 42 | +:service-url-registry: https://console.redhat.com/application-services/service-registry/ |
| 43 | +:getting-started-url-registry: registry/getting-started-registry/README.adoc |
| 44 | +:quarkus-url-registry: registry/quarkus-registry/README.adoc |
| 45 | +:getting-started-rhoas-cli-url-registry: registry/rhoas-cli-getting-started-registry/README.adoc |
| 46 | +:access-mgmt-url-registry: registry/access-mgmt-registry/README.adoc |
| 47 | +:content-rules-registry: https://access.redhat.com/documentation/en-us/red_hat_openshift_service_registry/1/guide/9b0fdf14-f0d6-4d7f-8637-3ac9e2069817[Supported Service Registry content and rules] |
| 48 | +:service-binding-url-registry: registry/service-binding-registry/README.adoc |
| 49 | + |
| 50 | +//OpenShift Connectors |
| 51 | +:product-long-connectors: OpenShift Connectors |
| 52 | +:product-connectors: Connectors |
| 53 | +:product-version-connectors: 1 |
| 54 | +:service-url-connectors: https://console.redhat.com/application-services/connectors |
| 55 | +:getting-started-url-connectors: connectors/getting-started-connectors/README.adoc |
| 56 | + |
| 57 | +//OpenShift API Designer |
| 58 | +:product-long-api-designer: OpenShift API Designer |
| 59 | +:product-api-designer: API Designer |
| 60 | +:product-version-api-designer: 1 |
| 61 | +:service-url-api-designer: https://console.redhat.com/application-services/api-designer/ |
| 62 | +:getting-started-url-api-designer: api-designer/getting-started-api-designer/README.adoc |
| 63 | + |
| 64 | +//// |
| 65 | +END GENERATED ATTRIBUTES |
| 66 | +//// |
| 67 | + |
| 68 | +[id="chap-getting-started-api-designer"] |
| 69 | += Getting started with {product-long-api-designer} |
| 70 | +ifdef::context[:parent-context: {context}] |
| 71 | +:context: getting-started-ad |
| 72 | + |
| 73 | +// Purpose statement for the assembly |
| 74 | +[role="_abstract"] |
| 75 | +As a developer of applications and services, you can use {product-long-api-designer} to ... |
| 76 | +{product-long-api-designer} is a managed cloud service that enables you to design schema and API definitions without having to install, configure, run, and maintain your own {product-api-designer} clusters. |
| 77 | + |
| 78 | +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^] |
| 79 | + |
| 80 | +ifndef::community[] |
| 81 | +.Prerequisites |
| 82 | +* You have a {org-name} account. |
| 83 | +* You have a subscription to {product-long-kafka}. |
| 84 | +//For more information about signing up, see *<@SME: Where to link?>*. |
| 85 | +endif::[] |
| 86 | + |
| 87 | +// Condition out QS-only content so that it doesn't appear in docs. |
| 88 | +// All QS anchor IDs must be in this alternate anchor ID format `[#anchor-id]` because the ascii splitter relies on the other format `[id="anchor-id"]` to generate module files. |
| 89 | +ifdef::qs[] |
| 90 | +[#description] |
| 91 | +==== |
| 92 | +Learn how to create your first {product-api-designer} design in {product-long-api-designer}. |
| 93 | +==== |
| 94 | + |
| 95 | +[#introduction] |
| 96 | +==== |
| 97 | +Welcome to the quick start for {product-long-api-designer}. |
| 98 | +In this quick start, you'll learn how to ... |
| 99 | +==== |
| 100 | +endif::[] |
| 101 | + |
| 102 | +[id="proc-creating-schema-api-design_{context}"] |
| 103 | +== Creating an {product-api-designer} schema or API design |
| 104 | + |
| 105 | +[role="_abstract"] |
| 106 | +Use the {product-long-api-designer} web console to create an {product-api-designer} schema or API design. ... |
| 107 | + |
| 108 | +ifndef::qs[] |
| 109 | +.Prerequisites |
| 110 | +* You're logged in to the {product-api-designer} web console at {service-url-api-designer}[^]. |
| 111 | +endif::[] |
| 112 | + |
| 113 | +.Procedure |
| 114 | +. In the {service-url-api-designer}[{product-api-designer} web console], click ... |
| 115 | +. Click ... |
| 116 | + |
| 117 | +[.screencapture] |
| 118 | +.{product-api-designer} placeholder image |
| 119 | +image::placeholder.png[Placeholder image for {product-api-designer} ] |
| 120 | + |
| 121 | +.Verification |
| 122 | +ifdef::qs[] |
| 123 | +* Is the new {product-api-designer} design listed in the designs table? |
| 124 | +* Is ... |
| 125 | +endif::[] |
| 126 | +ifndef::qs[] |
| 127 | +. Verify that the new {product-api-designer} design is listed in the designs table. |
| 128 | +. Verify that ... |
| 129 | +endif::[] |
| 130 | + |
| 131 | +[id="proc-importing-schema-api-design_{context}"] |
| 132 | +== Importing an {product-api-designer} schema or API design |
| 133 | + |
| 134 | +[role="_abstract"] |
| 135 | +You can import an {product-api-designer} schema or API design from a URL, from a file, or from a {registry} instance. |
| 136 | +... |
| 137 | + |
| 138 | +.Prerequisites |
| 139 | +* You're logged in to the {product-api-designer} web console at {service-url-api-designer}[^]. |
| 140 | + |
| 141 | +.Procedure |
| 142 | +. In the *{product-api-designer}* designs page of the web console, click ... |
| 143 | +. Click ... |
| 144 | + |
| 145 | + |
| 146 | +.Verification |
| 147 | +ifdef::qs[] |
| 148 | +* Is the imported {product-api-designer} design listed in the designs table? |
| 149 | +* Is ... |
| 150 | +endif::[] |
| 151 | +ifndef::qs[] |
| 152 | +. Verify that the imported {product-api-designer} design is listed in the designs table. |
| 153 | +. Verify that ... |
| 154 | +endif::[] |
| 155 | + |
| 156 | +[id="proc-editing-schema-api-design_{context}"] |
| 157 | +== Editing an {product-api-designer} schema or API design |
| 158 | + |
| 159 | +[role="_abstract"] |
| 160 | +After you create or import an {product-api-designer} design, you can edit the schema or API content. |
| 161 | + |
| 162 | +.Prerequisites |
| 163 | +* You've created or uploaded an {product-api-designer} design. |
| 164 | + |
| 165 | +.Procedure |
| 166 | +. In the *{product-api-designer}* designs page of the web console, select the {product-api-designer} design that you want to edit. |
| 167 | +. Click ... |
| 168 | + |
| 169 | + |
| 170 | +.Verification |
| 171 | +ifdef::qs[] |
| 172 | +* Is ...? |
| 173 | +endif::[] |
| 174 | +ifndef::qs[] |
| 175 | +* Verify that ... |
| 176 | +endif::[] |
| 177 | + |
| 178 | +[id="proc-validating-schema-api-design_{context}"] |
| 179 | +== Validating an {product-api-designer} schema or API design |
| 180 | + |
| 181 | +[role="_abstract"] |
| 182 | +After you edit an {product-api-designer} design, you can validate the schema or API content. |
| 183 | + |
| 184 | +.Prerequisites |
| 185 | +* You've created, uploaded, or edited an {product-api-designer} design. |
| 186 | + |
| 187 | +.Procedure |
| 188 | +. In the *{product-api-designer}* designs page of the web console, select the {product-api-designer} design that you want to validate. |
| 189 | +. Click ... |
| 190 | + |
| 191 | + |
| 192 | +.Verification |
| 193 | +ifdef::qs[] |
| 194 | +* Is ...? |
| 195 | +endif::[] |
| 196 | +ifndef::qs[] |
| 197 | +* Verify that ... |
| 198 | +endif::[] |
| 199 | + |
| 200 | +[id="proc-exporting-schema-api-design-locally_{context}"] |
| 201 | +== Saving {product-api-designer} designs locally |
| 202 | + |
| 203 | +[role="_abstract"] |
| 204 | +_*To confirm:* Not sure if we'll need this section -- perhaps the designs will be saved locally automatically: to the browser index.db in Phase 1, and to the backend database in later phases._ |
| 205 | +To ... |
| 206 | + |
| 207 | +.Prerequisites |
| 208 | +* You've created, uploaded, or edited an {product-api-designer} design. |
| 209 | + |
| 210 | +.Procedure |
| 211 | +. In the *{product-api-designer}* designs page of the web console, select the {product-api-designer} design that you want to save locally. |
| 212 | +. Click ... |
| 213 | + |
| 214 | +.Verification |
| 215 | +ifdef::qs[] |
| 216 | +* Is ...? |
| 217 | +endif::[] |
| 218 | +ifndef::qs[] |
| 219 | +* Verify that ... |
| 220 | +endif::[] |
| 221 | + |
| 222 | +[id="proc-exporting-schema-api-design-to-file_{context}"] |
| 223 | +== Exporting {product-api-designer} designs to a file |
| 224 | + |
| 225 | +[role="_abstract"] |
| 226 | +To ... |
| 227 | + |
| 228 | +.Prerequisites |
| 229 | +* You've created, uploaded, or edited an {product-api-designer} design. |
| 230 | + |
| 231 | +.Procedure |
| 232 | +. In the *{product-api-designer}* designs page of the web console, select the {product-api-designer} design that you want to save to a file. |
| 233 | +. Click ... |
| 234 | + |
| 235 | +.Verification |
| 236 | +ifdef::qs[] |
| 237 | +* Is ...? |
| 238 | +endif::[] |
| 239 | +ifndef::qs[] |
| 240 | +* Verify that ... |
| 241 | +endif::[] |
| 242 | + |
| 243 | +[id="proc-exporting-schema-api-design-to-registry_{context}"] |
| 244 | +== Exporting {product-api-designer} designs to {registry} |
| 245 | + |
| 246 | +[role="_abstract"] |
| 247 | +To ... |
| 248 | + |
| 249 | +.Prerequisites |
| 250 | +* You've created, uploaded, or edited an {product-api-designer} design. |
| 251 | +* |
| 252 | + |
| 253 | +.Procedure |
| 254 | +. In the *{product-api-designer}* designs page of the web console, select the {product-api-designer} design that you want to save to {registry}. |
| 255 | +. Click ... |
| 256 | + |
| 257 | +.Verification |
| 258 | +ifdef::qs[] |
| 259 | +* Did you ...? |
| 260 | +endif::[] |
| 261 | +ifndef::qs[] |
| 262 | +. Verify that ... |
| 263 | +endif::[] |
| 264 | + |
| 265 | + |
| 266 | +[id="proc-deleting-schema-api-design_{context}"] |
| 267 | +== Deleting {product-api-designer} designs |
| 268 | + |
| 269 | +[role="_abstract"] |
| 270 | +To ... |
| 271 | + |
| 272 | +.Prerequisites |
| 273 | +* You've created or uploaded an {product-api-designer} design. |
| 274 | + |
| 275 | +.Procedure |
| 276 | +. In the *{product-api-designer}* designs page of the web console, select the {product-api-designer} design that you want to delete. |
| 277 | +. Click ... |
| 278 | + |
| 279 | +.Verification |
| 280 | +ifdef::qs[] |
| 281 | +* Is ...? |
| 282 | +endif::[] |
| 283 | +ifndef::qs[] |
| 284 | +* Verify that ... |
| 285 | +endif::[] |
| 286 | + |
| 287 | +[role="_additional-resources"] |
| 288 | +== Additional resources |
| 289 | +* https://access.redhat.com/documentation/en-us/red_hat_openshift_api_designer/1[{product-long-api-designer} user documentation^] |
| 290 | +* https://access.redhat.com/documentation/en-us/red_hat_openshift_service_registry/1[{product-long-registry} user documentation^] |
| 291 | +* https://access.redhat.com/documentation/en-us/red_hat_openshift_streams_for_apache_kafka/1[OpenShift Streams for Apache Kafka user documentation^] |
| 292 | + |
| 293 | +ifdef::qs[] |
| 294 | +[#conclusion] |
| 295 | +==== |
| 296 | +Congratulations! You successfully completed the {api-designer} Getting Started quick start, and are now ready to use the service. |
| 297 | +==== |
| 298 | +endif::[] |
| 299 | + |
| 300 | +ifdef::parent-context[:context: {parent-context}] |
| 301 | +ifndef::parent-context[:!context:] |
0 commit comments