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

Attachment of annotations #38

Closed
sosna opened this issue Feb 4, 2016 · 2 comments
Closed

Attachment of annotations #38

sosna opened this issue Feb 4, 2016 · 2 comments

Comments

@sosna
Copy link
Member

@sosna sosna commented Feb 4, 2016

Issue received on the SDMX users forum:

"In the spec, there is an annotations array, this array can contain multiple annotations,

In sdmx-ml, annotations can be attached to either dataset, series or observation,

In sdmx-json is the fact that an annotation attached to an observation lost in the translation from sdmx-ml to sdmx-json? I can't see any way to put in the sdmx-json that the annotation is attached to an observation ?? all the annotations are grouped together in the array with no field on the observation to denote that a particular annotation is associated with that observation ?

Thanks in advance for clearing things up for me.."

@dosse

This comment has been minimized.

Copy link
Contributor

@dosse dosse commented Jul 21, 2017

I discussed this briefly with Matt, The best approach seems being to complete the SDMX-JSON standard documentation by extending the definition of the arrays in the observations object to include also annotation indexes in addition to the observation values and the attribute indexes.

dosse added a commit that referenced this issue Jul 28, 2017
Include changes for issue #38 for attachment of annotations to observations, components and component values
dosse added a commit that referenced this issue Aug 11, 2017
Implemented agreed improvement related to issue #38: Highlight sentence explaining the constraint for positions of attributes when including annotations for observations.
dosse added a commit that referenced this issue Aug 29, 2017
Updated inline examples with annotations for issue #38. Complemented/corrected descriptions related to annotations.
dosse added a commit that referenced this issue Aug 29, 2017
Updates for issue #38 "Attachment of annotations"
dosse added a commit that referenced this issue Aug 29, 2017
Updated schema for issue #38 (Attachment of annotations)
dosse added a commit that referenced this issue Aug 29, 2017
Updated example for issue #38 (Attachment of annotations)
dosse added a commit that referenced this issue Aug 29, 2017
Updated example for issue #38 (Attachment of annotations)
dosse added a commit that referenced this issue Aug 29, 2017
Updated example for issue #38 (Attachment of annotations)
@dosse

This comment has been minimized.

Copy link
Contributor

@dosse dosse commented Aug 29, 2017

As agreed by SDMX-TWG TF3, added support for attachment of annotations to observations, components and component values (according to SDMX Information Model). Annotations can now be attached to structure, component, component value, dataSet, series and observation. Updated the examples and schema accordingly.

@dosse dosse closed this Aug 29, 2017
dosse added a commit that referenced this issue Feb 1, 2019
* Create browse-by-topic.md

* Initial release of the browse-by-topic requirement

* Update browse-by-topic.md

* Minor edits

* Fixed typo

* Sample file for step 1 of browse-by-topic use case

* Sample for step 1 of browse-by-topic - hateoas

* Made URLs generic & added reference resolution

* Changed images alt text

* Added list of matching series

* Reviewed format for step 1

* Added sample file for step 2

* Minor formatting changes

* Changed message IDs

* Add large sample for step 3.

* References now handled as HATEOAS links

* References to DSDs now handled as HATEOAS links

* Moved to a two-queries approach

* Explain why categorisations are not used

* Minor edits

* Artefacts resolution now taken into account

* Update step1.json

* Update step1.json

* Create 0-status.md (#20)

* first Jens test

* Update Json Message for Hierarchy of Categories (#42)

* Update step1.json

* Remove inappropriate link in the header

* Doc/jens (#43)

* New field guide for SDMX JSON structure message format.
* Reference document for SDMX JSON structure message format.

* Corrected small grammatical errors.

* adding missing properties (#45)

* Updated structure content description

* Update README.md

* Update README.md

* Update README.md

* Update step1-hateoas.json

* Update step1.json

* Update step2.json

* Update step3.json

* Update 1-sdmx-json-field-guide.md

Corrected a formatting glitch.

* Update 1-sdmx-json-field-guide.md

Shortened field guide structure and further developed explanations to facilitate comprehension.
Fixed issue #8 (Allow links also in components)

* Update 1-sdmx-json-field-guide.md

Corrected newly introduced errors in document bookmarks.
Fixed issue #33 (SDMX-Json data messages DataStructure/Dataflow reference/URN).
Added "hreflang" name to link object as response to issue #40 (properties for language used in structure and possibly data SDMX JSON messages) .

* Update 1-sdmx-json-field-guide.md

Correction in example text formatting.

* Update 1-sdmx-json-field-guide.md

Include changes for issue #38 for attachment of annotations to observations, components and component values

* Update 1-sdmx-json-field-guide.md

Update for #8 adding links for component values, and replacing uri by standard links mechanism in annotations

* Update 1-sdmx-json-field-guide.md

Implemented agreed improvement related to issue #38: Highlight sentence explaining the constraint for positions of attributes when including annotations for observations.

* #8 support for links in Component (#51)

Changed schema in order to allow links in Component
(Partly) update schema for issue #8

* Update sdmx-json-data-schema.json

Completed update of schema for issue #8

* Update 1-sdmx-json-field-guide.md

Highlighted recommendation for issue #33.

* #33 links in examples (#49)

Updated examples for issue #33

* Update 1-sdmx-json-field-guide.md

Updated inline examples with annotations for issue #38. Complemented/corrected descriptions related to annotations.

* Update 3-full-example-with-comments.md

Updates for issue #38 "Attachment of annotations"

* Update sdmx-json-data-schema.json

Updated schema for issue #38 (Attachment of annotations)

* Update exr-cross-section.json

Updated example for issue #38 (Attachment of annotations)

* Update exr-flat.json

Updated example for issue #38 (Attachment of annotations)

* Update exr-time-series.json

Updated example for issue #38 (Attachment of annotations)

* Update 1-sdmx-json-field-guide.md (#52)

* Update 1-sdmx-json-field-guide.md

Proposal to not include SDMX-JSON version as mandatory but a recommendation should be made to add information of the SDMX-JSON version as done by other standards (e.g. html). Do this by aligning with JSON-API standard with:
-	new optional top-level meta tag replacing the current header tag to specify SDMX-JSON schema, which contains the SDMX-JSON format version number
-	new top-level data tag under which the current structure and dataSets tags are grouped
-	the already existing top-level errors tag is updated

* Update sdmx-json-data-schema.json

Changed to align with SDMX-API spec (linked to implementation for #37)

* Update 1-sdmx-json-field-guide.md

#46 : Make keyPosition mandatory for dimensions.

* Update sdmx-json-data-schema.json

#46 and other bug corrections

* Update 2-references.md

Align to SDMX-API specification

* Update 1-sdmx-json-field-guide.md

Implement solution for #40

* Update sdmx-json-data-schema.json

Implementation of solution for #40

* Update 3-full-example-with-comments.md

Implement solution for #40

* Update exr-action-delete.json

Implementation of solution of #40

* Update exr-cross-section.json

Implementation of solution of #40

* Update exr-flat.json

Implementation of solution of #40

* Update exr-time-series.json

Implementation of solution of #40

* Update sdmx-json-data-schema.json

First changes for #30

* Update and rename data-message/tools/schemas/sdmx-json-data-schema.json to data-message/tools/schemas/1.0/sdmx-json-data-schema.json

Implementation of solution for #30 (regular expression validation)
Also corrected bugs

* Update exr-action-delete.json

Bug correction for #46

* Update exr-cross-section.json

Bug correction for #46

* Update exr-flat.json

Bug correction for #46

* Update exr-time-series.json

Bug correction for #46

* Update 3-full-example-with-comments.md

Corrected bug for #46

* Update sdmx-json-data-schema.json

Corrected bug that prevented following feature:
An attribute value of "null" can be used to reduce the message size by using the index of the attribute value in the data part of the message (instead of "null").

* Update sdmx-json-data-schema.json

Undo previous change as it wasn't correct.

* Update 3-full-example-with-comments.md

Bug correction for attribute value specification

* Update 1-sdmx-json-field-guide.md

Replaced resources and references with properties of one single Data object, one for each returned artefact. This will allow for a more in-depth content validation with a JSON schema. Using multiple languages. Changes not yet finished.

* Update 1-sdmx-json-field-guide.md

More changes: Changed "nullable" to "optional"

* Create sdmx-json-structure-schema.json

First version, more changes to come

* Update sdmx-json-structure-schema.json

More changes, and more still to come

* Update 1-sdmx-json-field-guide.md

More changes, and more to come...

* Update 1-sdmx-json-field-guide.md

Changes to align with structure message (in progress) and simplify use and specs for languages.

* Update sdmx-json-structure-schema.json

* Update sdmx-json-data-schema.json

Changes to align with structure message (in progress) and simplify use and specs for languages.

* Update exr-action-delete.json

Changes to align with structure message (in progress) and simplify use and specs for languages.

* Update exr-cross-section.json

Changes to align with structure message (in progress) and simplify use and specs for languages.

* Update exr-flat.json

Changes to align with structure message (in progress) and simplify use and specs for languages.

* Update exr-time-series.json

Changes to align with structure message (in progress) and simplify use and specs for languages.

* Update sdmx-json-data-schema.json

Correction for content-language because RFC standard doesn't include q weights. Therefore simplification of language specification without weights.

* Update 1-sdmx-json-field-guide.md

Correction for content-language because RFC standard doesn't include q weights. Therefore simplification of language specification without weights.

* Update 3-full-example-with-comments.md

Correction for content-language because RFC standard doesn't include q weights. Therefore simplification of language specification without weights.

* Update exr-action-delete.json

Correction for content-language because RFC standard doesn't include q weights. Therefore simplification of language specification without weights.

* Update exr-cross-section.json

Correction for content-language because RFC standard doesn't include q weights. Therefore simplification of language specification without weights.

* Update exr-flat.json

Correction for content-language because RFC standard doesn't include q weights. Therefore simplification of language specification without weights.

* Update exr-time-series.json

Correction for content-language because RFC standard doesn't include q weights. Therefore simplification of language specification without weights.

* Update 1-sdmx-json-field-guide.md

Correction for content-language because RFC standard doesn't include q weights. Therefore simplification of language specification without weights.

* Update sdmx-json-structure-schema.json

Work ongoing...

* Update 1-sdmx-json-field-guide.md

Work ongoing...

* Update 1-sdmx-json-field-guide.md

Correction for annotation title

* Update 1-sdmx-json-field-guide.md

Added possibility to include parent and order number for component values to allow for reconstructing component value hierarchies.

* Update 3-full-example-with-comments.md

Added possibility to include parent and order number for component values to allow for reconstructing component value hierarchies.

* Update sdmx-json-data-schema.json

Added possibility to include parent and order number for component values to allow for reconstructing component value hierarchies.

* Update exr-flat.json

Added possibility to include parent and order number for component values to allow for reconstructing component value hierarchies.

* Update exr-time-series.json

Added possibility to include parent and order number for component values to allow for reconstructing component value hierarchies.

* Update exr-action-delete.json

Added possibility to include parent and order number for component values to allow for reconstructing component value hierarchies.

* Update exr-cross-section.json

Added possibility to include parent and order number for component values to allow for reconstructing component value hierarchies.

* Update sdmx-json-structure-schema.json

Added codelist, categoryscheme and conceptscheme

* Update 1-sdmx-json-field-guide.md

Added codelist, categoryscheme and conceptscheme.
Treating urn and uri inside the links objects including one link for "self".

* Update 1-sdmx-json-field-guide.md

Some corrections.

* Update sdmx-json-structure-schema.json

Some corrections.

* Update 1-sdmx-json-field-guide.md

Replace component value's parent property object by string, to be consistent with SDMX-JSON structure message.

* Update 1-sdmx-json-field-guide.md

Completed with most frequent artefact types. 
Remaining artefacts are defined in schema: metadataStructures, hierarchicalCodelists, dataProviderSchemes, dataConsumerSchemes, organisationUnitSchemes, metadataflows, reportingTaxonomies, provisionAgreements, structureSets, processes

* Update 1-sdmx-json-field-guide.md

Formatting corrections

* Update sdmx-json-structure-schema.json

Completed schema for all structural artefact types.

* Update sdmx-json-structure-schema.json

Formatting correction

* Create generated-sample.json

Sample generated automatically from json schema.

* Update sdmx-json-data-schema.json

Correction to parent item specification.

* Create 1-sdmx-json-field-guide.md

First draft

* Update 1-sdmx-json-field-guide.md

Small corrections/improvements

* Update 1-sdmx-json-field-guide.md

Alignment with structure and metadata messages on management of human-readable localised names

* Update 1-sdmx-json-field-guide.md

Correction

* Update 1-sdmx-json-field-guide.md

Correction

* Update sdmx-json-data-schema.json

Make data message consistent with structure and metadata message for human-readable names

* Update 1-sdmx-json-field-guide.md

Correction

* Update sdmx-json-data-schema.json

Complement links

* Update sdmx-json-structure-schema.json

* Create sdmx-json-metadata-schema.json

* Update sdmx-json-data-schema.json

* Update sdmx-json-structure-schema.json

Simplified groupDimensions to simply array of dimension IDs.
Href not mandatory in links anymore, but links to have at least href or urn.

* Create constructed-sample

* Create constructed-sample.json

* Delete constructed-sample

* Update 1-sdmx-json-field-guide.md

Corrections/additions to ItemScheme/Item documentation.

* Update constructed-sample.json

Correction

* Update sdmx-json-structure-schema.json

Removed "id", "version" and "agencyID" properties from “ConceptRepresentation” type used for Concept definitions (because its “enumeration” property already contains the URN which holds the same information). Consistently, the SDMX-JSON format only uses URNs for referencing other artefacts rather than separate "id", "version" and "agencyID" properties.
Removed the “ISOConceptReferenceType” type. The “isoConceptReference” property of the “ConceptType” type is thus now taking just a simple URN rather than that “ISOConceptReferenceType” object.

* Update 1-sdmx-json-field-guide.md

* Create constructed-sample2

* Update sdmx-json-metadata-schema.json

* Update constructed-sample2

* Create constructed-sample

* Create generated-sample

* Update sdmx-json-metadata-schema.json

* format alignment for localised strings, added attribute relationship (#56)

* Update 1-sdmx-json-field-guide.md

Proposal to not include SDMX-JSON version as mandatory but a recommendation should be made to add information of the SDMX-JSON version as done by other standards (e.g. html). Do this by aligning with JSON-API standard with:
-	new optional top-level meta tag to specify SDMX-JSON version, this tag can contain the SDMX-JSON version number
-	new top-level data tag under which the current header, structure and dataSets tags should be grouped
-	the already existing top-level errors tag would need to be updated

* Update 1-sdmx-json-field-guide.md

* Update 1-sdmx-json-field-guide.md

* Update 1-sdmx-json-field-guide.md

* Update 3-full-example-with-comments.md

* Update sdmx-json-data-schema.json

* Rename data-message/tools/schemas/sdmx-json-data-schema.json to data-message/tools/schemas/1.0/sdmx-json-data-schema.json

* Update exr-action-delete.json

* Update exr-cross-section.json

* Update exr-action-delete.json

* Update 3-full-example-with-comments.md

* Update exr-flat.json

* Update exr-time-series.json

* Create agri.json

* Update 1-sdmx-json-field-guide.md

* Added attribute relationship and structure format changes (#57)

* Update sdmx-json-data-schema.json

Added AttributeRelationship (by copying similar structure construct from new SDMX-JSON structure message draft but removing all group references - this means groups should already be resolved into a list of dimensions by the server for the client)

* Update sdmx-json-structure-schema.json

Simplified groupDimensions to simply array of dimension IDs.
Href not mandatory in links anymore, but links to have at least href or urn.

* Update 1-sdmx-json-field-guide.md

* Update sdmx-json-data-schema.json

* Update sdmx-json-data-schema.json

* Update 1-sdmx-json-field-guide.md

* Update sdmx-json-structure-schema.json

* Update 1-sdmx-json-field-guide.md

* Update sdmx-json-data-schema.json

* Update sdmx-json-metadata-schema.json

* Update README.md

* Update README.md

* Update 1-sdmx-json-field-guide.md

Corrected formatting and writing mistakes

* Update 1-sdmx-json-field-guide.md

* Update 1-sdmx-json-field-guide.md

* first full release

* Add type prop to contentconstraint (#60)

* Corrected generated example for contentconstraint definition and other bugs

* Finished contentconstraint correction #59

* Corrected content constraint type #59, other small bugs and cleaning of unused definitions

* Corrected contentconstraints #59

* Corrected contentconstraint #59

* Still #59

* Generic language management (#62)

* Generic language approach

as agreed by SDMX-TWG TF3 to fully respond to #40

* Delete TODO.md

* Generic language approach

as agreed by SDMX-TWG TF3 to fully respond to #40

* Generic language approach

as agreed by SDMX-TWG TF3 to fully respond to #40

* Generic language approach

as agreed by SDMX-TWG TF3 to fully respond to #40

* Generic language approach

as agreed by SDMX-TWG TF3 to fully respond to #40

* Generic language approach

as agreed by SDMX-TWG TF3 to fully respond to #40

* Generic language approach

as agreed by SDMX-TWG TF3 to fully respond to #40

* Generic language approach

as agreed by SDMX-TWG TF3 to fully respond to #40

* Generic language approach

as agreed by SDMX-TWG TF3 to fully respond to #40

* Generic language approach

as agreed by SDMX-TWG TF3 to fully respond to #40

* Generic language approach

as agreed by SDMX-TWG TF3 to fully respond to #40

* Delete step1-hateoas.json

* Delete step1.json

* Delete step2.json

* Delete step3.json

* Generic language approach

as agreed by SDMX-TWG TF3 to fully respond to #40

* Generic language approach

as agreed by SDMX-TWG TF3 to fully respond to #40

* Generic language approach

as agreed by SDMX-TWG TF3 to fully respond to #40

* Generic language approach

as agreed by SDMX-TWG TF3 to fully respond to #40

* Generic language approach

as agreed by SDMX-TWG TF3 to fully respond to #40

* Generic language approach

as agreed by SDMX-TWG TF3 to fully respond to #40

* Generic language approach

as agreed by SDMX-TWG TF3 to fully respond to #40

* Generic language approach

as agreed by SDMX-TWG TF3 to fully respond to #40

* Generic language approach

as agreed by SDMX-TWG TF3 to fully respond to #40

* Generic language approach

as agreed by SDMX-TWG TF3 to fully respond to #40

* Generic language approach

as agreed by SDMX-TWG TF3 to fully respond to #40

* Generic language approach

as agreed by SDMX-TWG TF3 to fully respond to #40

* Generic language approach

as agreed by SDMX-TWG TF3 to fully respond to #40

* Added mention of metadata message

* Delete sdmx-json-metadata-schema.json

* Delete constructed-sample

* Delete constructed-sample2

* Delete generated-sample

* Delete 1-sdmx-json-field-guide.md

* Delete 0-status.md

* Delete 1-sdmx-json-field-guide.md

* Delete 2-references.md

* Delete cs-list.png

* Delete cs-treeview.png

* Delete df-filters.png

* Delete df-list.png

* Delete series-list.png

* Delete browse-by-topic.md

* Delete sdmx-json-structure-schema.json

* Delete constructed-sample.json

* Delete generated-sample.json

* Update README.md

* Update README.md

* Update README.md
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
2 participants
You can’t perform that action at this time.