You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@isis.apache.org by da...@apache.org on 2021/03/28 10:58:10 UTC
[isis] 02/02: : merging in final changes to docs
This is an automated email from the ASF dual-hosted git repository.
danhaywood pushed a commit to branch release-2.0.0-M5-RC2
in repository https://gitbox.apache.org/repos/asf/isis.git
commit 7db13178f9d9324f5ea92bec42d8e3f543dbf31c
Author: danhaywood <da...@haywood-associates.co.uk>
AuthorDate: Sun Mar 28 11:52:20 2021 +0100
: merging in final changes to docs
---
.../modules/ROOT/pages/2021/2.0.0-M5/relnotes.adoc | 2 ++
antora/supplemental-ui/schema/chg/chg-2.0.xsd | 4 ++--
antora/supplemental-ui/schema/chg/chg.xsd | 4 ++--
antora/supplemental-ui/schema/cmd/cmd-2.0.xsd | 4 ++--
antora/supplemental-ui/schema/cmd/cmd.xsd | 4 ++--
antora/supplemental-ui/schema/common/common.xsd | 14 +-------------
antora/supplemental-ui/schema/ixn/ixn-2.0.xsd | 2 +-
antora/supplemental-ui/schema/ixn/ixn.xsd | 2 +-
antora/supplemental-ui/schema/metamodel/metamodel-2.0.xsd | 4 ++--
antora/supplemental-ui/schema/metamodel/metamodel.xsd | 10 ++++++++--
10 files changed, 23 insertions(+), 27 deletions(-)
diff --git a/antora/components/relnotes/modules/ROOT/pages/2021/2.0.0-M5/relnotes.adoc b/antora/components/relnotes/modules/ROOT/pages/2021/2.0.0-M5/relnotes.adoc
index 4111883..6cba163 100644
--- a/antora/components/relnotes/modules/ROOT/pages/2021/2.0.0-M5/relnotes.adoc
+++ b/antora/components/relnotes/modules/ROOT/pages/2021/2.0.0-M5/relnotes.adoc
@@ -14,6 +14,8 @@ Data source URLs are now configured using Spring configuration properties (for e
The xref:security:secman:about.adoc[SecMan] integration was extended to also provide a JPA implementation, and was also reworked to use logical type names rather than physical package names.
The notion of xref:refguide:applib:index/id/LogicalType.adoc[LogicalType] was also formally added into the applib.
+One notable breaking change: the XSDs for schemas were changed, with `transactionId` being renamed to `interactionId`.
+
Documentation tooling was also developed to automate large parts of the xref:refguide::about.adoc[Reference Guide], as well as to provide a xref:refguide:_overview:about.adoc[System Overview].
diff --git a/antora/supplemental-ui/schema/chg/chg-2.0.xsd b/antora/supplemental-ui/schema/chg/chg-2.0.xsd
index 3590d20..d51974d 100644
--- a/antora/supplemental-ui/schema/chg/chg-2.0.xsd
+++ b/antora/supplemental-ui/schema/chg/chg-2.0.xsd
@@ -45,7 +45,7 @@
</xs:documentation>
</xs:annotation>
</xs:element>
- <xs:element name="transactionId" type="xs:string">
+ <xs:element name="interactionId" type="xs:string">
<xs:annotation>
<xs:documentation>Unique identifier of the interaction id within which this change occurred.
</xs:documentation>
@@ -53,7 +53,7 @@
</xs:element>
<xs:element name="sequence" type="xs:int">
<xs:annotation>
- <xs:documentation>Unique sequence number of the set of change within the interaction. There could be many such events within a single interaction, one for each completed transaction.
+ <xs:documentation>Unique sequence number of the transaction committed within the interaction. Although there is usually just one transaction per interaction, in advanced use cases there could be many.
</xs:documentation>
</xs:annotation>
</xs:element>
diff --git a/antora/supplemental-ui/schema/chg/chg.xsd b/antora/supplemental-ui/schema/chg/chg.xsd
index 3590d20..d51974d 100644
--- a/antora/supplemental-ui/schema/chg/chg.xsd
+++ b/antora/supplemental-ui/schema/chg/chg.xsd
@@ -45,7 +45,7 @@
</xs:documentation>
</xs:annotation>
</xs:element>
- <xs:element name="transactionId" type="xs:string">
+ <xs:element name="interactionId" type="xs:string">
<xs:annotation>
<xs:documentation>Unique identifier of the interaction id within which this change occurred.
</xs:documentation>
@@ -53,7 +53,7 @@
</xs:element>
<xs:element name="sequence" type="xs:int">
<xs:annotation>
- <xs:documentation>Unique sequence number of the set of change within the interaction. There could be many such events within a single interaction, one for each completed transaction.
+ <xs:documentation>Unique sequence number of the transaction committed within the interaction. Although there is usually just one transaction per interaction, in advanced use cases there could be many.
</xs:documentation>
</xs:annotation>
</xs:element>
diff --git a/antora/supplemental-ui/schema/cmd/cmd-2.0.xsd b/antora/supplemental-ui/schema/cmd/cmd-2.0.xsd
index 87dcd6a..218f1e4 100644
--- a/antora/supplemental-ui/schema/cmd/cmd-2.0.xsd
+++ b/antora/supplemental-ui/schema/cmd/cmd-2.0.xsd
@@ -55,9 +55,9 @@
</xs:documentation>
</xs:annotation>
</xs:element>
- <xs:element name="transactionId" type="xs:string">
+ <xs:element name="interactionId" type="xs:string">
<xs:annotation>
- <xs:documentation>Transaction id for this command, a unique identifier.
+ <xs:documentation>Unique identifier of the interaction that gave rise to this command.
</xs:documentation>
</xs:annotation>
</xs:element>
diff --git a/antora/supplemental-ui/schema/cmd/cmd.xsd b/antora/supplemental-ui/schema/cmd/cmd.xsd
index 87dcd6a..218f1e4 100644
--- a/antora/supplemental-ui/schema/cmd/cmd.xsd
+++ b/antora/supplemental-ui/schema/cmd/cmd.xsd
@@ -55,9 +55,9 @@
</xs:documentation>
</xs:annotation>
</xs:element>
- <xs:element name="transactionId" type="xs:string">
+ <xs:element name="interactionId" type="xs:string">
<xs:annotation>
- <xs:documentation>Transaction id for this command, a unique identifier.
+ <xs:documentation>Unique identifier of the interaction that gave rise to this command.
</xs:documentation>
</xs:annotation>
</xs:element>
diff --git a/antora/supplemental-ui/schema/common/common.xsd b/antora/supplemental-ui/schema/common/common.xsd
index d36a0ba..b654d0c 100644
--- a/antora/supplemental-ui/schema/common/common.xsd
+++ b/antora/supplemental-ui/schema/common/common.xsd
@@ -58,18 +58,6 @@
</xs:complexType>
<xs:complexType name="oidDto">
- <xs:sequence>
- <xs:element name="objectType" type="xs:string">
- <xs:annotation>
- <xs:documentation>Deprecated, use the 'objectType' attribute instead.</xs:documentation>
- </xs:annotation>
- </xs:element>
- <xs:element name="objectIdentifier" type="xs:string">
- <xs:annotation>
- <xs:documentation>Deprecated, use the 'id' attribute instead.</xs:documentation>
- </xs:annotation>
- </xs:element>
- </xs:sequence>
<xs:attribute name="type" type="xs:string"/>
<xs:attribute name="id" type="xs:string"/>
</xs:complexType>
@@ -235,4 +223,4 @@
</xs:restriction>
</xs:simpleType>
-</xs:schema>
\ No newline at end of file
+</xs:schema>
diff --git a/antora/supplemental-ui/schema/ixn/ixn-2.0.xsd b/antora/supplemental-ui/schema/ixn/ixn-2.0.xsd
index dd83dbf..bf1bc5e 100644
--- a/antora/supplemental-ui/schema/ixn/ixn-2.0.xsd
+++ b/antora/supplemental-ui/schema/ixn/ixn-2.0.xsd
@@ -47,7 +47,7 @@
</xs:documentation>
</xs:annotation>
</xs:element>
- <xs:element name="transactionId" type="xs:string">
+ <xs:element name="interactionId" type="xs:string">
<xs:annotation>
<xs:documentation>Unique identifier of the interaction which this member was interacted with (action invoked/property edited); can be used to locate the corresponding Command object (which may have been persisted).
</xs:documentation>
diff --git a/antora/supplemental-ui/schema/ixn/ixn.xsd b/antora/supplemental-ui/schema/ixn/ixn.xsd
index dd83dbf..bf1bc5e 100644
--- a/antora/supplemental-ui/schema/ixn/ixn.xsd
+++ b/antora/supplemental-ui/schema/ixn/ixn.xsd
@@ -47,7 +47,7 @@
</xs:documentation>
</xs:annotation>
</xs:element>
- <xs:element name="transactionId" type="xs:string">
+ <xs:element name="interactionId" type="xs:string">
<xs:annotation>
<xs:documentation>Unique identifier of the interaction which this member was interacted with (action invoked/property edited); can be used to locate the corresponding Command object (which may have been persisted).
</xs:documentation>
diff --git a/antora/supplemental-ui/schema/metamodel/metamodel-2.0.xsd b/antora/supplemental-ui/schema/metamodel/metamodel-2.0.xsd
index 4cd2e29..b5d37b7 100644
--- a/antora/supplemental-ui/schema/metamodel/metamodel-2.0.xsd
+++ b/antora/supplemental-ui/schema/metamodel/metamodel-2.0.xsd
@@ -278,8 +278,8 @@
</xs:sequence>
<xs:attribute name="id" type="xs:string">
<xs:annotation>
- <xs:documentation>The facet type (fqcn) that is common to a set of concrete
- facet implementations. These ids are usually known to the framework for
+ <xs:documentation>The facet type (fqcn) that is common to a set of concrete
+ facet implementations. These ids are usually known to the framework for
there well defined semantics within the programming model.
</xs:documentation>
</xs:annotation></xs:attribute>
diff --git a/antora/supplemental-ui/schema/metamodel/metamodel.xsd b/antora/supplemental-ui/schema/metamodel/metamodel.xsd
index cdc76ab..035bfe5 100644
--- a/antora/supplemental-ui/schema/metamodel/metamodel.xsd
+++ b/antora/supplemental-ui/schema/metamodel/metamodel.xsd
@@ -276,7 +276,13 @@
<xs:sequence>
<xs:element name="attr" type="facetAttr" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
- <xs:attribute name="id" type="xs:string"/>
+ <xs:attribute name="id" type="xs:string">
+ <xs:annotation>
+ <xs:documentation>The facet type (fqcn) that is common to a set of concrete
+ facet implementations. These ids are usually known to the framework for
+ there well defined semantics within the programming model.
+ </xs:documentation>
+ </xs:annotation></xs:attribute>
<xs:attribute name="fqcn" type="xs:string"/>
</xs:complexType>
@@ -302,4 +308,4 @@
</xs:complexType>
-</xs:schema>
\ No newline at end of file
+</xs:schema>