Last modified by Helena K. on 2026/06/09 19:45
Summary
-
Page properties (1 modified, 0 added, 0 removed)
Details
- Page properties
-
- Content
-
... ... @@ -260,10 +260,12 @@ 260 260 261 261 === 5.2.7 Registry Behaviour === 262 262 263 -The following table defines the behaviour of the [[SDMX Registry>>doc:sdmx:Glossary 2\.1.SDMX Registry.WebHome]] for the various Registry Interface messages. It should be noted, though, that as of [[SDMX>>doc:sdmx:Glossary 2\.1.Statistical data and metadata exchange.WebHome]] 3.0, an extended versioning scheme newly incl uding semantic versioning is foreseen for all [[Maintainable Artefacts>>doc:sdmx:Glossary 2\.1.Maintainable artefact.WebHome]]. Moreover, while the old versioning scheme is allowed, given there is no more a "final" flag, there is no way guaranteeing the consistency across (% style="color:#e74c3c" %)version(%%) of a Maintainable, unless semantic versioning is used.263 +The following table defines the behaviour of the [[SDMX Registry>>doc:sdmx:Glossary 2\.1.SDMX Registry.WebHome]] for the various Registry Interface messages. It should be noted, though, that as of [[SDMX>>doc:sdmx:Glossary 2\.1.Statistical data and metadata exchange.WebHome]] 3.0, an extended versioning scheme newly incl 264 264 265 - Given the above, the behaviourdescribed inthe followingtable concernsither draft [[Artefacts>>doc:sdmx:Glossary 2\.1.Artefact.WebHome]] using semantic versioningor any [[Artefacts>>doc:sdmx:Glossary 2\.1.Artefact.WebHome]] using the old versioningscheme. Nevertheless, in the case ofsemantic versioning theregistry must respect the versioningrules when performingtheactions below. For example,it isnotpossibleto replace a non-draft [[Artefact>>doc:sdmx:Glossary 2\.1.Artefact.WebHome]] that follows semantic versioning, unless a newer (% style="color:#e74c3c" %)version(%%) is introducedaccording to the semantic versioning rules.Furthermore, even when draft [[Artefacts>>doc:sdmx:Glossary 2\.1.Artefact.WebHome]]aresubmitted,theregistryhasto verifysemantic versioningisrespected against thepreviousnon-draft (% style="color:#e74c3c"%)versions(%%).Itis worthnoting that theulesfor semantic versioningandreplacingor maintaining semanticallyversioned [[Artefacts>>doc:sdmx:Glossary2\.1.Artefact.WebHome]]appliestoexternallyshared [[Artefacts>>doc:sdmx:Glossary 2\.1.Artefact.WebHome]]. This meansthatanysystem may internallyperformanychange within a (% style="color:#e74c3c"%)version(%%) of an [[Artefact>>doc:sdmx:Glossary 2\.1.Artefact.WebHome]],until the latter is sharedoutside ofthatsystem or becomes public. Then (as also explained inthe [[SDMX>>doc:sdmx:Glossary 2\.1.Statistical data and metadata exchange.WebHome]]Standards Section 6 “TechnicalNotes”) the [[Artefacts>>doc:sdmx:Glossary2\.1.Artefact.WebHome]] must adhere to the SemanticVersioningrules.265 +uding semantic versioning is foreseen for all [[Maintainable Artefacts>>doc:sdmx:Glossary 2\.1.Maintainable artefact.WebHome]]. Moreover, while the old versioning scheme is allowed, given there is no more a "final" flag, there is no way guaranteeing the consistency across [[version>>doc:sdmx:Glossary 2\.1.Version.WebHome]] of a Maintainable, unless semantic versioning is used. 266 266 267 +Given the above, the behaviour described in the following table concerns either draft [[Artefacts>>doc:sdmx:Glossary 2\.1.Artefact.WebHome]] using semantic versioning or any [[Artefacts>>doc:sdmx:Glossary 2\.1.Artefact.WebHome]] using the old versioning scheme. Nevertheless, in the case of semantic versioning the registry must respect the versioning rules when performing the actions below. For example, it is not possible to replace a non-draft [[Artefact>>doc:sdmx:Glossary 2\.1.Artefact.WebHome]] that follows semantic versioning, unless a newer [[version>>doc:sdmx:Glossary 2\.1.Version.WebHome]] is introduced according to the semantic versioning rules. Furthermore, even when draft [[Artefacts>>doc:sdmx:Glossary 2\.1.Artefact.WebHome]] are submitted, the registry has to verify semantic versioning is respected against the previous non-draft [[versions>>doc:sdmx:Glossary 2\.1.Version.WebHome]]. It is worth noting that the rules for semantic versioning and replacing or maintaining semantically versioned [[Artefacts>>doc:sdmx:Glossary 2\.1.Artefact.WebHome]] applies to externally shared [[Artefacts>>doc:sdmx:Glossary 2\.1.Artefact.WebHome]]. This means that any system may internally perform any change within a [[version>>doc:sdmx:Glossary 2\.1.Version.WebHome]] of an [[Artefact>>doc:sdmx:Glossary 2\.1.Artefact.WebHome]], until the latter is shared outside of that system or becomes public. Then (as also explained in the [[SDMX>>doc:sdmx:Glossary 2\.1.Statistical data and metadata exchange.WebHome]] Standards Section 6 “Technical Notes”) the [[Artefacts>>doc:sdmx:Glossary 2\.1.Artefact.WebHome]] must adhere to the Semantic Versioning rules. 268 + 267 267 (% style="width:982.835px" %) 268 268 |(% style="width:217px" %)**Interface**|(% style="width:763px" %)**Behaviour** 269 269 |(% style="width:217px" %)All|(% style="width:763px" %)((( ... ... @@ -271,13 +271,13 @@ 271 271 1. Cross referenced structures MUST exist in either the submitted document (in Structures or Structure Location) or in the registry to which the request is submitted. 272 272 1. If the action is set to “delete” (or a [[maintainable Artefact>>doc:sdmx:Glossary 2\.1.Maintainable artefact.WebHome]] is DELETEd) then the Registry MUST verify that the object can be deleted. In order to qualify for deletion, the object must: 273 273 274 -a) Be a draft (% style="color:#e74c3c"%)version(%%).276 +a) Be a draft [[version>>doc:sdmx:Glossary 2\.1.Version.WebHome]]. 275 275 b) Not be explicitly{{footnote}}With semantic versioning, it is allowed to reference a range of artefacts, e.g., a DSD referencing a Codelist with version 1.2.3+ means all patch versions greater than 1.2.3. This means that deleting 1.2.4draft does not break integrity of the aforementioned DSD.{{/footnote}} referenced from any other object in the Registry. 276 276 277 277 4) The semantic versioning rules in the [[SDMX>>doc:sdmx:Glossary 2\.1.Statistical data and metadata exchange.WebHome]] documentation MUST be obeyed. 278 278 ))) 279 279 |(% style="width:217px" %)Structure submission|(% style="width:763px" %)((( 280 -Structures are submitted at the (% style="color:#e74c3c" %)level(%%)of the [[Maintainable Artefact>>doc:sdmx:Glossary 2\.1.Maintainable artefact.WebHome]] and the behaviour in “All” above is therefore at the(% style="color:#e74c3c" %)level(%%)of the [[Maintainable Artefact>>doc:sdmx:Glossary 2\.1.Maintainable artefact.WebHome]].282 +Structures are submitted at the level of the [[Maintainable Artefact>>doc:sdmx:Glossary 2\.1.Maintainable artefact.WebHome]] and the behaviour in “All” above is therefore at the level of the [[Maintainable Artefact>>doc:sdmx:Glossary 2\.1.Maintainable artefact.WebHome]]. 281 281 ))) 282 282 |(% style="width:217px" %)SubmitRegistrationRequest|(% style="width:763px" %)If the datasource is a file (simple datasource) then the file MAY be retrieved and indexed according to the Boolean [[attributes>>doc:sdmx:Glossary 2\.1.Attribute.WebHome]] set in the Registration. For a queryable datasource the Registry MAY validate that the source exists and can accept an [[SDMX>>doc:sdmx:Glossary 2\.1.Statistical data and metadata exchange.WebHome]] data query. 283 283 ... ... @@ -289,7 +289,7 @@ 289 289 290 290 * //**IdentifiableArtefact**// – this gives an object the ability to be uniquely identified (see following section on identification), to have a user-defined URI, and to have multi-lingual [[annotations>>doc:sdmx:Glossary 2\.1.Annotation.WebHome]]. 291 291 * //**NameableArtefact**// – this has all of the features of //IdentifiableArtefact// plus the ability to have a multi-lingual name and description. 292 -* //**VersionableArtefact**// – this has all of the above features plus a (% style="color:#e74c3c"%)version(%%)number, according to the [[SDMX>>doc:sdmx:Glossary 2\.1.Statistical data and metadata exchange.WebHome]] versioning rules in [[SDMX>>doc:sdmx:Glossary 2\.1.Statistical data and metadata exchange.WebHome]] Standards Section 6 “Technical Notes”, paragraph “4.3 Versioning”, and a validity period.294 +* //**VersionableArtefact**// – this has all of the above features plus a [[version>>doc:sdmx:Glossary 2\.1.Version.WebHome]] number, according to the [[SDMX>>doc:sdmx:Glossary 2\.1.Statistical data and metadata exchange.WebHome]] versioning rules in [[SDMX>>doc:sdmx:Glossary 2\.1.Statistical data and metadata exchange.WebHome]] Standards Section 6 “Technical Notes”, paragraph “4.3 Versioning”, and a validity period. 293 293 * //**MaintainableArtefact**// – this has all of the above features, plus registry and structure URIs, and an association to the maintenance organisation of the object. 294 294 295 295 === 6.1.1 Identification, Naming, Versioning, and Maintenance Model === ... ... @@ -296,7 +296,7 @@ 296 296 297 297 [[image:SDMX 3.1 Section 5_en_4a9b2cfc.jpg||height="688" width="587"]] 298 298 299 -**Figure 5: Class diagram of fundamental [[artefacts>>doc:sdmx:Glossary2\.1.Artefact.WebHome]]in the[[SDMX-IM>>doc:sdmx:Glossary 2\.1.SDMX Information Model.WebHome]]**301 +**Figure 5: Class diagram of fundamental artefacts in the SDMX-IM** 300 300 301 301 The table below shows the identification and related data [[attributes>>doc:sdmx:Glossary 2\.1.Attribute.WebHome]] to be stored in a registry for objects that are one of: 302 302 ... ... @@ -307,7 +307,7 @@ 307 307 * //Maintainable// 308 308 309 309 (% style="width:1038.83px" %) 310 -|(% colspan="2" %)**Object Type**|(% colspan="2" %)**Data [[Attributes>>doc:sdmx:Glossary 2\.1.Attribute.WebHome]]**|(% colspan="2" %)**Status**|(% colspan="2" %)**Data type**|(% colspan="2" %)**Notes**312 +|(% colspan="2" %)**Object Type**|(% colspan="2" %)**Data Attributes**|(% colspan="2" %)**Status**|(% colspan="2" %)**Data type**|(% colspan="2" %)**Notes** 311 311 |(% colspan="2" rowspan="4" %)//Annotable//|(% colspan="2" %)AnnotationTitle|(% colspan="2" %)C|(% colspan="2" %)string|(% colspan="2" %) 312 312 |(% colspan="2" %)AnnotationType|(% colspan="2" %)C|(% colspan="2" %)string|(% colspan="2" %) 313 313 |(% colspan="2" %)AnnotationURN|(% colspan="2" %)C|(% colspan="2" %)string|(% colspan="2" %)