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.

Sign up for GitHub

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

Jump to bottom

Document artifact states 965 #967

Merged
merged 4 commits into from
Oct 30, 2020
Merged

Document artifact states 965 #967

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
8e6edd8
Add artifact state docs section
carlesarnal Oct 29, 2020
6ac514d
Improve state docs
carlesarnal Oct 29, 2020
cf800cc
Address comments
carlesarnal Oct 29, 2020
9ccf8ab
Address comments
carlesarnal Oct 30, 2020
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
8 changes: 5 additions & 3 deletions docs/modules/ROOT/pages/getting-started/assembly-registry-reference.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,16 +6,18 @@ include::{mod-loc}shared/all-attributes.adoc[]
= {registry} reference
//If the assembly covers a task, start the title with a verb in the gerund form, such as Creating or Configuring.

This chapter lists the supported artifact types and content rule types that are stored in {registry}.

This chapter lists the supported artifact types, states and content rule types that are stored in {registry}.
transitions
EricWittmann marked this conversation as resolved.
Show resolved Hide resolved
* xref:registry-artifact-types[]
* xref:registry-artifact-states[]
* xref:registry-rule-types[]
* xref:registry-rule-maturity-matrix[]

.Additional resources
* For more detailed information on artifact and rule types, see the link:{attachmentsdir}/registry-rest-api.htm[Apicurio Registry REST API documentation]
* For more detailed information on artifact types, states, and rule types, see the link:{attachmentsdir}/registry-rest-api.htm[Apicurio Registry REST API documentation]

//INCLUDES
include::{mod-loc}getting-started/ref-registry-artifact-types.adoc[leveloffset=+1]
include::{mod-loc}getting-started/ref-registry-artifact-states.adoc[leveloffset=+1]
include::{mod-loc}getting-started/ref-registry-rule-types.adoc[leveloffset=+1]
include::{mod-loc}getting-started/ref-registry-rule-maturity-matrix.adoc[leveloffset=+1]
39 changes: 39 additions & 0 deletions docs/modules/ROOT/partials/getting-started/ref-registry-artifact-states.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
// Metadata created by nebel
// ParentAssemblies: assemblies/getting-started/as_registry-reference.adoc

[id="registry-artifact-states"]

= {registry} artifact states
These are the valid artifact states in {registry}:

.{registry} artifact states
[%header,cols=2*]
|===
|State
|Description
|`ENABLED`
|Basic state, all the operations are available.
|`DISABLED`
|The artifact and its metadata is viewable and searchable using the {registry} web console, but its content cannot be fetched by any client.
|`DEPRECATED`
|The artifact is fully usable but a header is added to the REST API response whenever the artifact content is fetched.
EricWittmann marked this conversation as resolved.
Show resolved Hide resolved
|`DELETED`
|Artifact not available through the REST API.
EricWittmann marked this conversation as resolved.
Show resolved Hide resolved
|===

.{registry} artifact state transitions
[%header,cols=2*]
|===
|State
|Valid Transition States
|`ENABLED`
|`DISABLED`,`DEPRECATED`,`DELETED`
|`DISABLED`
|`ENABLED`,`DEPRECATED`,`DELETED`
|`DEPRECATED`
|`ENABLED`,`DISABLED`,`DELETED`
|`DELETED`
|`NONE`
|===
EricWittmann marked this conversation as resolved.
Show resolved Hide resolved