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

update keywords and themes #100

Merged
merged 2 commits into from
Mar 8, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
36 changes: 36 additions & 0 deletions core/examples/json/keywords-themes.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
{
"keywords": [
"total",
"ozone",
"level 1.0",
"column",
"dobson",
"brewer",
"saoz"
],
"themes": [
{
"concepts": [
"dobson",
"brewer",
"vassey",
"pion",
"microtops",
"spectral",
"hoelper",
"saoz",
"filter"
],
"scheme": "https://geo.woudc.org/codelists.xml#WOUDC_InstrumentCode"
},
{
"concepts": [
"atmosphericComposition",
"pollution",
"observationPlatform",
"rocketSounding"
],
"scheme": "https://wis.wmo.int/2012/codelists/WMOCodeLists.xml#WMO_CategoryCode"
}
]
}
8 changes: 4 additions & 4 deletions core/examples/json/record.json
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,6 @@
"publisher": "https://woudc.org",
"themes": [
{
"scheme": "https://geo.woudc.org/codelists.xml#WOUDC_InstrumentCode",
"concepts": [
"dobson",
"brewer",
Expand All @@ -61,16 +60,17 @@
"hoelper",
"saoz",
"filter"
]
],
"scheme": "https://geo.woudc.org/codelists.xml#WOUDC_InstrumentCode"
},
{
"scheme": "https://wis.wmo.int/2012/codelists/WMOCodeLists.xml#WMO_CategoryCode",
"concepts": [
"atmosphericComposition",
"pollution",
"observationPlatform",
"rocketSounding"
]
],
"scheme": "https://wis.wmo.int/2012/codelists/WMOCodeLists.xml#WMO_CategoryCode"
}
],
"formats": [
Expand Down
12 changes: 6 additions & 6 deletions core/openapi/schemas/recordGeoJSON.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -78,12 +78,6 @@ properties:
items:
type: object
properties:
scheme:
type: string
description: |-
An identifier for the knowledge organization
system used to classify the resource. It is recommended that the
identifier by a resolvable URI.
concepts:
type: array
description: |-
Expand All @@ -92,6 +86,12 @@ properties:
for each entity/concept identifier.
items:
type: string
scheme:
type: string
description: |-
An identifier for the knowledge organization
system used to classify the resource. It is recommended that the
identifier by a resolvable URI.
formats:
type: array
description: A list of available distributions of the resource.
Expand Down
1 change: 1 addition & 0 deletions core/standard/clause_6_overview.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,7 @@ The Records API offers various levels of search capability of escalating complex
* a bounding box
* a time instant or time period
* keywords
* free text
* equality predicates based on a subset of core queryables (e.g. by resource type, by external identifier)

This specification also includes a conformance class that allows a catalogue to be searched using https://portal.opengeospatial.org/files/?artifact_id=56866[OpenSearch Geo]. OpenSearch Geo gives the user more control over the kinds of geometries, beyond a bounding box, that can be used to define an area of interest.
Expand Down
19 changes: 19 additions & 0 deletions core/standard/clause_7_core.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -460,6 +460,25 @@ The following YAML fragment defines the schema of a single record in a query res
include::../openapi/schemas/recordGeoJSON.yaml[]
----

==== Keywords and Themes

A record allows for one ``properties.keywords`` and 0..n ``properties.themes``
properties. The following provides an example of using keywords for free
form terms (e.g. tags) as well as themes to articulate terms from formal
vocabularies.

[#keywords-themes-example,reftext=`Keywords and themes Example`]
.Keywords and themes Example
[source,json]
----
include::../examples/json/keywords-themes.json[]
----

The following recommendations provide clarification on where and how to use
these properties in a record.

include::recommendations/core/REC_record-keywords-themes.adoc[]

==== Associations and Links

A record contains both `links` and `properties.associations` properties which
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
[[rec_record-keywords-themes]]
[width="90%",cols="2,6a"]
|===
^|*Recommendation {counter:rec-id}* |*/rec/core/record-associations*
^|A |Implementations SHOULD use the record `properties.keywords` property to provide free form keywords associated with the current record.
^|B |Implementations SHOULD use the record `properties.themes` property to enumerate 1..n objects of concepts and their respective knowledge organization system/controlled vocabulary associated with the current record.
|===