From 4093fabd007b134ff83a7c214bdafcbc01512dc4 Mon Sep 17 00:00:00 2001 From: Paul Wright Date: Wed, 1 May 2024 15:27:57 +0100 Subject: [PATCH 1/3] remove migration --- docs/modules/ROOT/nav.adoc | 2 +- .../partials/proc-migrating-studio-data.adoc | 17 ----------------- 2 files changed, 1 insertion(+), 18 deletions(-) delete mode 100644 docs/modules/ROOT/partials/proc-migrating-studio-data.adoc diff --git a/docs/modules/ROOT/nav.adoc b/docs/modules/ROOT/nav.adoc index 3fdad7b18..bdff53c7a 100644 --- a/docs/modules/ROOT/nav.adoc +++ b/docs/modules/ROOT/nav.adoc @@ -5,7 +5,7 @@ include::partial$shared/all-attributes.adoc[] * xref:ROOT:assembly-introduction.adoc[] // Migration -* xref:ROOT:assembly-migrating-studio-v0-v1.adoc[] +//* xref:ROOT:assembly-migrating-studio-v0-v1.adoc[] * Installation ** xref:ROOT:assembly-installing-studio-docker.adoc[] diff --git a/docs/modules/ROOT/partials/proc-migrating-studio-data.adoc b/docs/modules/ROOT/partials/proc-migrating-studio-data.adoc deleted file mode 100644 index d7e698840..000000000 --- a/docs/modules/ROOT/partials/proc-migrating-studio-data.adoc +++ /dev/null @@ -1,17 +0,0 @@ -[id="migrating-studio-data"] -= Migrating {studio} data - -[role="_abstract"] -Migrating data to {studio} {studio-legacy-version} requires exporting all data from your existing {studio} deployment and importing it into the new 1.x deployment. - -.Prerequisites - -* *__TODO__* - -.Procedure - -. *__TODO__* - -[role="_additional-resources"] -.Additional resources -* *__TODO__* From 1c00c907bb5d64d3347b60c6be7b8b265837043b Mon Sep 17 00:00:00 2001 From: Paul Wright Date: Wed, 1 May 2024 15:37:53 +0100 Subject: [PATCH 2/3] add rhoad docs --- .../ROOT/pages/assembly-getting-started.adoc | 5 +- ...proc-exporting-schema-api-design copy.adoc | 49 +++++++++++++++++++ .../proc-testing-schema-api-design copy.adoc | 39 +++++++++++++++ 3 files changed, 90 insertions(+), 3 deletions(-) create mode 100644 docs/modules/ROOT/partials/proc-exporting-schema-api-design copy.adoc create mode 100644 docs/modules/ROOT/partials/proc-testing-schema-api-design copy.adoc diff --git a/docs/modules/ROOT/pages/assembly-getting-started.adoc b/docs/modules/ROOT/pages/assembly-getting-started.adoc index ca2c35079..123710506 100644 --- a/docs/modules/ROOT/pages/assembly-getting-started.adoc +++ b/docs/modules/ROOT/pages/assembly-getting-started.adoc @@ -14,9 +14,8 @@ In this quick start, you'll learn how to create an API definition or event schem include::partial$proc-creating-api-design.adoc[leveloffset=+1] include::partial$proc-creating-schema-design.adoc[leveloffset=+1] include::partial$proc-importing-schema-api-design.adoc[leveloffset=+1] -// TODO: These procedures have been available in Red Hat OpenShift API Designer, but are not currently available in Apicurio Studio: -//include::partial$proc-testing-schema-api-design.adoc[leveloffset=+1] -//include::partial$proc-exporting-schema-api-design.adoc[leveloffset=+1] +include::partial$proc-testing-schema-api-design.adoc[leveloffset=+1] +include::partial$proc-exporting-schema-api-design.adoc[leveloffset=+1] [role="_additional-resources"] == Additional resources diff --git a/docs/modules/ROOT/partials/proc-exporting-schema-api-design copy.adoc b/docs/modules/ROOT/partials/proc-exporting-schema-api-design copy.adoc new file mode 100644 index 000000000..2069d81f2 --- /dev/null +++ b/docs/modules/ROOT/partials/proc-exporting-schema-api-design copy.adoc @@ -0,0 +1,49 @@ +[id='proc-exporting-schema-api-design_{context}'] += Exporting a schema or API design +:imagesdir: ../_images + +[role="_abstract"] +When you're happy with the changes to your {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. + +.Prerequisites +* You're logged in to the {product-long-api-designer} web console at {service-url-api-designer}[^]. +* You've created or imported a design in {product-api-designer}. +* You can access a running {product-registry} instance in your organization. +For more information, see {base-url}{getting-started-url-registry}[Getting started with {product-long-registry}^]. + +.Procedure +. 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. +. Click the options icon (three vertical dots), and click *Export design to {registry}*. ++ +NOTE: You can also select *Export design to {registry}* from the *Actions* menu in the design editor. ++ +. Complete the form to specify where to save the new design. Provide the following details: ++ +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. ++ +* *Registry Instance*: Select the required instance from the list. +* *Group* _(Optional)_: Enter a unique group name such as `my-org` to organize the artifact in a named collection. +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. ++ +NOTE: Specifying a group is optional when using the web console. If no group is specified, {registry} uses the `default` group. ++ +* *ID* _(Optional)_: Enter a 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. +* *Version* _(Optional)_: Specify the version number. +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. +. Click *Export*. +The exported design is listed on the artifacts page of the specified {registry} instance. + +You can use {product-long-registry} to manage the versions of a design from {product-long-api-designer}. +You can also download a design from {product-api-designer} to a file, either for local client code generation or to import the design into {product-long-api-management}. + +.Verification +ifdef::qs[] +* Is the design listed as an artifact in {product-long-registry}? +* Are the artifact details correct? +endif::[] +ifndef::qs[] +* Verify that the design is listed as an artifact in {product-long-registry}. +* Verify that the artifact details are correct. +endif::[] + diff --git a/docs/modules/ROOT/partials/proc-testing-schema-api-design copy.adoc b/docs/modules/ROOT/partials/proc-testing-schema-api-design copy.adoc new file mode 100644 index 000000000..ae57f0e57 --- /dev/null +++ b/docs/modules/ROOT/partials/proc-testing-schema-api-design copy.adoc @@ -0,0 +1,39 @@ +[id='proc-testing-schema-api-design_{context}'] += Testing a schema or API design +:imagesdir: ../_images + +[role="_abstract"] +You can test that your schema or API design content is valid and compatible with existing content by applying the rules of an existing {product-long-registry} instance. +You can test the design while working in the {product-long-api-designer} editor, without exporting the design to {product-long-registry}. + +.Prerequisites +* You're logged in to the {product-long-api-designer} web console at {service-url-api-designer}[^]. +* You've created or imported a design in {product-api-designer}. +* You can access a running {product-registry} instance in your organization. +Within that instance, you know the artifact ID of an artifact with the required rules configured. +For more information, see {base-url}{getting-started-url-registry}[Getting started with {product-long-registry}^]. + +.Procedure +. 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. +. Click the options icon (three vertical dots), and click *Edit design content* to open the design editor. +. From the *Actions* menu, click *Run {registry} check*. +. From the *Registry instance* list, select a {registry} instance. +. In the *Group* and *ID* fields, specify the artifact details. +. Click *Test*. + +A new pane in the design editor window shows the registration issues found by the test: + +* If the design content obeys the specified rules, the registration issues pane contains the following text: +`Registry Test completed with no issues` + +* 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. + +.Verification +ifdef::qs[] +* Is the registration issues pane shown in the design editor? +* Are the test results correct? +endif::[] +ifndef::qs[] +. Verify that the registration issues pane is shown in the design editor. +. Verify that the test results are correct. +endif::[] From ca967dd74569e020bffd00240816dcf6f8f95e36 Mon Sep 17 00:00:00 2001 From: Paul Wright Date: Wed, 1 May 2024 19:11:49 +0100 Subject: [PATCH 3/3] remove quickstart verifications --- .../proc-exporting-schema-api-design copy.adoc | 10 +--------- .../partials/proc-testing-schema-api-design copy.adoc | 10 +--------- 2 files changed, 2 insertions(+), 18 deletions(-) diff --git a/docs/modules/ROOT/partials/proc-exporting-schema-api-design copy.adoc b/docs/modules/ROOT/partials/proc-exporting-schema-api-design copy.adoc index 2069d81f2..de5da9539 100644 --- a/docs/modules/ROOT/partials/proc-exporting-schema-api-design copy.adoc +++ b/docs/modules/ROOT/partials/proc-exporting-schema-api-design copy.adoc @@ -37,13 +37,5 @@ The exported design is listed on the artifacts page of the specified {registry} You can use {product-long-registry} to manage the versions of a design from {product-long-api-designer}. You can also download a design from {product-api-designer} to a file, either for local client code generation or to import the design into {product-long-api-management}. -.Verification -ifdef::qs[] -* Is the design listed as an artifact in {product-long-registry}? -* Are the artifact details correct? -endif::[] -ifndef::qs[] -* Verify that the design is listed as an artifact in {product-long-registry}. -* Verify that the artifact details are correct. -endif::[] + diff --git a/docs/modules/ROOT/partials/proc-testing-schema-api-design copy.adoc b/docs/modules/ROOT/partials/proc-testing-schema-api-design copy.adoc index ae57f0e57..aa31288e8 100644 --- a/docs/modules/ROOT/partials/proc-testing-schema-api-design copy.adoc +++ b/docs/modules/ROOT/partials/proc-testing-schema-api-design copy.adoc @@ -28,12 +28,4 @@ A new pane in the design editor window shows the registration issues found by th * 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. -.Verification -ifdef::qs[] -* Is the registration issues pane shown in the design editor? -* Are the test results correct? -endif::[] -ifndef::qs[] -. Verify that the registration issues pane is shown in the design editor. -. Verify that the test results are correct. -endif::[] +