Skip to content

Commit

Permalink
Document artifact states 965 (#967)
Browse files Browse the repository at this point in the history
* Add artifact state docs section

* Improve state docs

* Address comments

* Address comments
  • Loading branch information
carlesarnal authored Oct 30, 2020
1 parent 1f397dc commit 7928960
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 3 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -6,16 +6,17 @@ 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}.
* 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]
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
// 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. The {registry} Rest Client will also log a warning whenever it sees deprecated content.
|===


0 comments on commit 7928960

Please sign in to comment.