Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs mvp #2505

Draft
wants to merge 3 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/modules/ROOT/nav.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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[]
Expand Down
5 changes: 2 additions & 3 deletions docs/modules/ROOT/pages/assembly-getting-started.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
[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}.



17 changes: 0 additions & 17 deletions docs/modules/ROOT/partials/proc-migrating-studio-data.adoc

This file was deleted.

Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
[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.


Loading