piveau Profile SHACL Properties#
This is the reference for the domain-specific SHACL properties used for a piveau Profile.
Prefixes
@prefix sh: <http://www.w3.org/ns/shacl#> .
@prefix pv: <https://piveau.eu/ns/voc#> .
Properties#
In the following properties are described and how they affect the behavior of hub-repo and hub-search.
sh:path#
Only properties with a sh:path are considered for indexing.
There might be fields which should have a mapping but are not index through hub-repo.
This concerns special fields like id, modified, issued and resource, country or quality_meas.
sh:minCount#
Properties with sh:minCount 1 are considered to be mandatory. This affects indexing behavior and OpenAPI description.
sh:maxCount#
Properties without sh:maxCount 1 are considered to be an array. This affects indexing behavior and OpenAPI
description. Some properties, in particular multilingual properties, are never considered to be an array.
pv:mappingName#
Only properties with a pv:mappingName are considered for indexing. Defines the field name for mapping and OpenAPI and
to which field the corresponding sh:path is indexed to.
Important
piveau uses some reserved mapping names for special purposes. These are: id, resource, issued, modified,
country, translation_meta, catalog and catalog_record. Using these mapping names for other purposes might
lead to unexpected behavior. The list of reserved mapping names might change in future versions of piveau.
The currently used names can be seen in the source code of the indexing library.
pv:mappingClass#
Only properties with a pv:mappingClass are considered for indexing. Defines the field class for mapping, OpenAPI and
how the field for the corresponding sh:path is indexed. See here for all the details.
pv:mappingProperty#
Lets you define properties of a property when pv:mappingClass "Nested" is used.
pv:mappingLink#
Lets you define properties of a property with pv:mappingClass "Nested" is used, but with link to another shape.
Available Mapping Classes#
TranslationMeta#
Value: TranslationMeta
Indexing: legacyTranslationMeta, if enabled
OpenAPI:
{
"type": "object",
"properties": {
"full_available_languages": {
"type": "array",
"items": {
"type": "string"
}
},
"details": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {
"machine_translated": {
"type": "boolean"
},
"original_language": {
"type": "string"
},
"issued": {
"oneOf": [
{
"$ref": "#/components/schemas/Date"
},
{
"$ref": "#/components/schemas/DateTime"
}
]
},
"received": {
"oneOf": [
{
"$ref": "#/components/schemas/Date"
},
{
"$ref": "#/components/schemas/DateTime"
}
]
}
}
}
},
"status": {
"type": "string"
}
}
}
Search Mapping:
Dynamic Templates:
[
{
"some_property_details": {
"path_match": "some_property.details.*",
"match_mapping_type": "*",
"mapping": {
"dynamic": "strict",
"properties": {
"machine_translated": {
"enabled": false
},
"original_language": {
"enabled": false
},
"issued": {
"enabled": false
},
"received": {
"enabled": false
}
}
}
}
}
]
Mapping:
{
"properties": {
"full_available_languages": {
"enabled": false
},
"details": {
"dynamic": true,
"properties": {
"en": {
"dynamic": "strict",
"properties": {
"machine_translated": {
"enabled": false
},
"original_language": {
"enabled": false
},
"issued": {
"enabled": false
},
"received": {
"enabled": false
}
}
}
}
},
"status": {
"enabled": false
}
}
}
Keywords#
Value: Keywords
Indexing: indexingKeyword
OpenAPI:
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"label": {
"type": "string"
},
"language": {
"type": "string"
}
}
}
Search Mapping:
{
"properties": {
"id": {
"type": "text",
"analyzer": "standard",
"fields": {
"raw": {
"type": "keyword",
"ignore_above": 8191
}
}
},
"label": {
"type": "text",
"analyzer": "standard",
"fields": {
"raw": {
"type": "keyword",
"ignore_above": 8191
}
}
},
"language": {
"type": "text",
"analyzer": "standard",
"fields": {
"raw": {
"type": "keyword",
"ignore_above": 8191
}
}
}
}
}
Boolean#
Value: Boolean
Indexing: boolean
OpenAPI:
Search Mapping:
LabeledResource#
Value: LabeledResource
Indexing: indexingLabeledResource
OpenAPI:
{
"type": "object",
"properties": {
"resource": {
"type": "string"
},
"label": {
"type": "string"
}
}
}
Search Mapping:
{
"properties": {
"resource": {
"type": "keyword",
"ignore_above": 8191
},
"label": {
"type": "text",
"analyzer": "standard",
"fields": {
"raw": {
"type": "keyword",
"ignore_above": 8191
}
}
}
}
}
SpatialResource#
Value: SpatialResource
Indexing: Is indexed through spatial (but disabled ATM)
OpenAPI:
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"label": {
"type": "string"
},
"resource": {
"type": "string"
}
}
}
Search Mapping:
{
"properties": {
"id": {
"type": "text",
"analyzer": "standard",
"fields": {
"raw": {
"type": "keyword",
"ignore_above": 8191
}
}
},
"label": {
"type": "text",
"analyzer": "standard",
"fields": {
"raw": {
"type": "keyword",
"ignore_above": 8191
}
}
},
"resource": {
"type": "keyword",
"ignore_above": 8191
}
}
}
SimpleMultiLang#
Value: SimpleMultiLang
Indexing: indexingSimpleMultiLang, no array
OpenAPI:
Search Mapping:
Dynamic Templates:
[
{
"some_property": {
"path_match": "some_property.*",
"match_mapping_type": "string",
"mapping": {
"type": "text",
"analyzer": "standard"
}
}
}
]
Mapping:
License#
Value: License
Indexing: LicenseVisitor
OpenAPI:
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"label": {
"type": "string"
},
"description": {
"type": "string"
},
"la_url": {
"type": "string"
},
"resource": {
"type": "string"
}
}
}
Search Mapping:
{
"properties": {
"id": {
"type": "text",
"analyzer": "standard",
"fields": {
"raw": {
"type": "keyword",
"ignore_above": 8191
}
}
},
"label": {
"type": "text",
"analyzer": "standard",
"fields": {
"raw": {
"type": "keyword",
"ignore_above": 8191
}
}
},
"description": {
"type": "text",
"analyzer": "standard"
},
"la_url": {
"enabled": false
},
"resource": {
"type": "keyword",
"ignore_above": 8191
}
}
}
Nested#
Value: Nested
Indexing: indexingResource
OpenAPI:
Search Mapping:
DatasetType#
Value: DatasetType
Indexing: indexingType
OpenAPI:
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"resource": {
"type": "string"
},
"label": {
"type": "string"
}
}
}
Search Mapping:
{
"properties": {
"id": {
"type": "text",
"analyzer": "standard",
"fields": {
"raw": {
"type": "keyword",
"ignore_above": 8191
}
}
},
"resource": {
"type": "keyword",
"ignore_above": 8191
},
"label": {
"type": "text",
"analyzer": "standard",
"fields": {
"raw": {
"type": "keyword",
"ignore_above": 8191
}
}
}
}
}
AdmsIdentifier#
Value: AdmsIdentifier
Indexing: indexingAdmsIdentifier
OpenAPI:
{
"type": "object",
"properties": {
"identifier": {
"type": "string"
},
"scheme": {
"type": "string"
},
"resource": {
"type": "string"
}
}
}
Search Mapping:
{
"properties": {
"identifier": {
"type": "text",
"analyzer": "standard",
"fields": {
"raw": {
"type": "keyword",
"ignore_above": 8191
}
}
},
"scheme": {
"type": "text",
"analyzer": "standard",
"fields": {
"raw": {
"type": "keyword",
"ignore_above": 8191
}
}
},
"resource": {
"type": "keyword",
"ignore_above": 8191
}
}
}
Page#
Value: Page
Indexing: indexingPage
OpenAPI:
{
"type": "object",
"properties": {
"title": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"description": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"format": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"label": {
"type": "string"
},
"resource": {
"type": "string"
}
}
},
"resource": {
"type": "string"
}
}
}
Search Mapping:
Dynamic Templates:
[
{
"some_property_title": {
"path_match": "some_property.title.*",
"match_mapping_type": "string",
"mapping": {
"type": "text",
"analyzer": "standard"
}
}
},
{
"some_property_description": {
"path_match": "some_property.description.*",
"match_mapping_type": "string",
"mapping": {
"type": "text",
"analyzer": "standard"
}
}
}
]
Mapping:
{
"properties": {
"title": {
"dynamic": true,
"properties": {
"en": {
"type": "text",
"analyzer": "english"
}
}
},
"description": {
"dynamic": true,
"properties": {
"en": {
"type": "text",
"analyzer": "english"
}
}
},
"format": {
"properties": {
"id": {
"type": "text",
"analyzer": "standard",
"fields": {
"raw": {
"type": "keyword",
"ignore_above": 8191
}
}
},
"label": {
"type": "text",
"analyzer": "standard",
"fields": {
"raw": {
"type": "keyword",
"ignore_above": 8191
}
}
},
"resource": {
"type": "keyword",
"ignore_above": 8191
}
}
},
"resource": {
"type": "keyword",
"ignore_above": 8191
}
}
}
Document#
Value: Document
Indexing: DocumentVisitor
OpenAPI:
{
"type": "object",
"properties": {
"resource": {
"type": "string"
},
"label": {
"type": "string"
}
}
}
Search Mapping:
{
"properties": {
"resource": {
"type": "keyword",
"ignore_above": 8191
},
"label": {
"type": "text",
"analyzer": "standard",
"fields": {
"raw": {
"type": "keyword",
"ignore_above": 8191
}
}
}
}
}
MetadataExtension#
Value: MetadataExtension
Indexing: indexingMetadataExtension
OpenAPI:
{
"type": "object",
"properties": {
"is_used_by": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
Search Mapping:
LiteralWithId#
Value: LiteralWithId
Indexing: indexingLiteralWithId
OpenAPI:
Search Mapping:
{
"properties": {
"id": {
"type": "text",
"analyzer": "standard",
"fields": {
"raw": {
"type": "keyword",
"ignore_above": 8191
}
}
},
"label": {
"type": "text",
"analyzer": "standard",
"fields": {
"raw": {
"type": "keyword",
"ignore_above": 8191
}
}
}
}
}
DateTime#
Value: DateTime
Indexing: indexingDateTime
OpenAPI:
{
"oneOf": [
{
"$ref": "#/components/schemas/Date"
},
{
"$ref": "#/components/schemas/DateTime"
}
]
}
Search Mapping:
ContactPoint#
Value: ContactPoint
Indexing: indexingContactPoint
OpenAPI:
{
"type": "object",
"properties": {
"type": {
"type": "string"
},
"name": {
"type": "string"
},
"email": {
"type": "string"
},
"address": {
"type": "string"
},
"telephone": {
"type": "string"
},
"url": {
"type": "array",
"items": {
"type": "string"
}
},
"organisation_name": {
"type": "string"
},
"resource": {
"type": "string"
}
}
}
Search Mapping:
{
"properties": {
"type": {
"type": "text",
"analyzer": "standard",
"fields": {
"raw": {
"type": "keyword",
"ignore_above": 8191
}
}
},
"name": {
"type": "text",
"analyzer": "standard",
"fields": {
"raw": {
"type": "keyword",
"ignore_above": 8191
}
}
},
"email": {
"enabled": false
},
"address": {
"type": "text",
"analyzer": "standard",
"fields": {
"raw": {
"type": "keyword",
"ignore_above": 8191
}
}
},
"telephone": {
"type": "text",
"analyzer": "standard",
"fields": {
"raw": {
"type": "keyword",
"ignore_above": 8191
}
}
},
"url": {
"enabled": false
},
"organisation_name": {
"type": "text",
"analyzer": "standard",
"fields": {
"raw": {
"type": "keyword",
"ignore_above": 8191
}
}
},
"resource": {
"type": "keyword",
"ignore_above": 8191
}
}
}
SimpleMultiLangTitle#
Value: SimpleMultiLangTitle
Indexing: indexingSimpleMultiLang, no array
OpenAPI:
Search Mapping:
Dynamic Templates:
[
{
"some_property": {
"path_match": "some_property.*",
"match_mapping_type": "string",
"mapping": {
"type": "text",
"analyzer": "standard",
"fields": {
"autocomplete": {
"type": "text",
"analyzer": "edgengram_analyzer",
"search_analyzer": "standard"
},
"raw": {
"type": "keyword",
"ignore_above": 8191
}
}
}
}
}
]
Mapping:
{
"dynamic": true,
"properties": {
"en": {
"type": "text",
"analyzer": "english",
"fields": {
"autocomplete": {
"type": "text",
"analyzer": "edgengram_analyzer",
"search_analyzer": "standard"
},
"raw": {
"type": "keyword",
"ignore_above": 8191
}
}
}
}
}
AdmsSkos#
Value: AdmsSkos
Indexing: indexingConceptScheme
OpenAPI:
{
"type": "object",
"properties": {
"resource": {
"type": "string"
},
"label": {
"type": "string"
}
}
}
Search Mapping:
{
"properties": {
"resource": {
"type": "keyword",
"ignore_above": 8191
},
"label": {
"type": "text",
"analyzer": "standard",
"fields": {
"raw": {
"type": "keyword",
"ignore_above": 8191
}
}
}
}
}
EuroVoc#
Value: EuroVoc
Indexing: indexingConceptSchemeMultiLang
OpenAPI:
{
"type": "object",
"properties": {
"label": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"resource": {
"type": "string"
}
}
}
Search Mapping:
Dynamic Templates:
[
{
"some_property_label": {
"path_match": "some_property.label.*",
"match_mapping_type": "string",
"mapping": {
"type": "text",
"analyzer": "standard"
}
}
}
]
Mapping:
{
"properties": {
"label": {
"dynamic": true,
"properties": {
"en": {
"type": "text",
"analyzer": "english"
}
}
},
"resource": {
"type": "keyword",
"ignore_above": 8191
}
}
}
AccessService#
Value: AccessService
Indexing: indexingAccessService
OpenAPI:
{
"type": "object",
"properties": {
"title": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"description": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"endpoint_url": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
Search Mapping:
Dynamic Templates:
[
{
"some_property_title": {
"path_match": "some_property.title.*",
"match_mapping_type": "string",
"mapping": {
"type": "text",
"analyzer": "standard",
"fields": {
"raw": {
"type": "keyword",
"ignore_above": 8191
}
}
}
}
},
{
"some_property_description": {
"path_match": "some_property.description.*",
"match_mapping_type": "string",
"mapping": {
"type": "text",
"analyzer": "standard"
}
}
}
]
Mapping:
{
"properties": {
"title": {
"dynamic": true,
"properties": {
"en": {
"type": "text",
"analyzer": "english",
"fields": {
"raw": {
"type": "keyword",
"ignore_above": 8191
}
}
}
}
},
"description": {
"dynamic": true,
"properties": {
"en": {
"type": "text",
"analyzer": "english"
}
}
},
"endpoint_url": {
"enabled": false
}
}
}
Metrics#
Value: Metrics
Indexing: indexingMetrics
OpenAPI:
Search Mapping:
Format#
Value: Format
Indexing: FormatVisitor
OpenAPI:
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"resource": {
"type": "string"
},
"label": {
"type": "string"
}
}
}
Search Mapping:
{
"properties": {
"id": {
"type": "text",
"analyzer": "standard",
"fields": {
"raw": {
"type": "keyword",
"ignore_above": 8191
}
}
},
"resource": {
"type": "keyword",
"ignore_above": 8191
},
"label": {
"type": "text",
"analyzer": "standard",
"fields": {
"raw": {
"type": "keyword",
"ignore_above": 8191
}
}
}
}
}
TrimmedMultiLangSubtitle#
Value: TrimmedMultiLangSubtitle
Indexing: indexingMultiLang, no array
OpenAPI:
Search Mapping:
Dynamic Templates:
[
{
"some_property": {
"path_match": "some_property.*",
"match_mapping_type": "string",
"mapping": {
"type": "text",
"analyzer": "standard",
"fields": {
"raw": {
"type": "keyword",
"ignore_above": 8191
}
}
}
}
}
]
Mapping:
{
"dynamic": true,
"properties": {
"en": {
"type": "text",
"analyzer": "english",
"fields": {
"raw": {
"type": "keyword",
"ignore_above": 8191
}
}
}
}
}
Language#
Value: Language
Indexing: LanguageVisitor
OpenAPI:
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"resource": {
"type": "string"
},
"label": {
"type": "string"
}
}
}
Search Mapping:
{
"properties": {
"id": {
"type": "text",
"analyzer": "standard",
"fields": {
"raw": {
"type": "keyword",
"ignore_above": 8191
}
}
},
"resource": {
"type": "keyword",
"ignore_above": 8191
},
"label": {
"type": "text",
"analyzer": "standard",
"fields": {
"raw": {
"type": "keyword",
"ignore_above": 8191
}
}
}
}
}
Checksum#
Value: Checksum
Indexing: indexingChecksum
OpenAPI:
{
"type": "object",
"properties": {
"algorithm": {
"type": "string"
},
"checksum_value": {
"type": "string"
}
}
}
Search Mapping:
{
"properties": {
"algorithm": {
"type": "text",
"analyzer": "standard",
"fields": {
"raw": {
"type": "keyword",
"ignore_above": 8191
}
}
},
"checksum_value": {
"type": "binary"
}
}
}
MediaType#
Value: MediaType
Indexing: MediaTypeVisitor
OpenAPI:
Search Mapping:
MultiLang#
Value: MultiLang
Indexing: indexingMultiLang, no array
OpenAPI:
Search Mapping:
Dynamic Templates:
[
{
"some_property": {
"path_match": "some_property.*",
"match_mapping_type": "string",
"mapping": {
"type": "text",
"analyzer": "standard"
}
}
}
]
Mapping:
AccessRight#
Value: AccessRight
Indexing: indexingConceptScheme
OpenAPI:
{
"type": "object",
"properties": {
"resource": {
"type": "string"
},
"label": {
"type": "string"
}
}
}
Search Mapping:
{
"properties": {
"resource": {
"type": "keyword",
"ignore_above": 8191
},
"label": {
"type": "text",
"analyzer": "standard",
"fields": {
"raw": {
"type": "keyword",
"ignore_above": 8191
}
}
}
}
}
StandardResourceKeyword#
Value: StandardResourceKeyword
Indexing: StandardVisitor
OpenAPI:
Search Mapping:
DistributionType#
Value: DistributionType
Indexing: indexingType
OpenAPI:
{
"type": "object",
"properties": {
"resource": {
"type": "string"
},
"label": {
"type": "string"
}
}
}
Search Mapping:
{
"properties": {
"resource": {
"type": "keyword",
"ignore_above": 8191
},
"label": {
"type": "text",
"analyzer": "standard",
"fields": {
"raw": {
"type": "keyword",
"ignore_above": 8191
}
}
}
}
}
MultiLangTitle#
Value: MultiLangTitle
Indexing: indexingMultiLang, no array
OpenAPI:
Search Mapping:
Dynamic Templates:
[
{
"some_property": {
"path_match": "some_property.*",
"match_mapping_type": "string",
"mapping": {
"type": "text",
"analyzer": "standard",
"fields": {
"autocomplete": {
"type": "text",
"analyzer": "edgengram_analyzer",
"search_analyzer": "standard"
},
"raw": {
"type": "keyword",
"ignore_above": 8191
}
}
}
}
}
]
Mapping:
{
"dynamic": true,
"properties": {
"en": {
"type": "text",
"analyzer": "english",
"fields": {
"autocomplete": {
"type": "text",
"analyzer": "edgengram_analyzer",
"search_analyzer": "standard"
},
"raw": {
"type": "keyword",
"ignore_above": 8191
}
}
}
}
}
Agent#
Value: Agent
Indexing: indexingAgent
OpenAPI:
{
"type": "object",
"properties": {
"type": {
"type": "string"
},
"name": {
"type": "string"
},
"email": {
"type": "string"
},
"homepage": {
"type": "string"
},
"resource": {
"type": "string"
}
}
}
Search Mapping:
{
"properties": {
"type": {
"type": "text",
"analyzer": "standard",
"fields": {
"raw": {
"type": "keyword",
"ignore_above": 8191
}
}
},
"name": {
"type": "text",
"analyzer": "standard",
"fields": {
"raw": {
"type": "keyword",
"ignore_above": 8191
}
}
},
"email": {
"enabled": false
},
"homepage": {
"enabled": false
},
"resource": {
"type": "keyword",
"ignore_above": 8191
}
}
}
LabeledText#
Value: LabeledText
Indexing: LabeledVisitor
OpenAPI:
Search Mapping:
{
"type": "text",
"analyzer": "standard",
"fields": {
"raw": {
"type": "keyword",
"ignore_above": 8191
}
}
}
QualifiedRelation#
Value: QualifiedRelation
Indexing: indexingQualifiedRelation
OpenAPI:
{
"type": "object",
"properties": {
"relation": {
"type": "array",
"items": {
"type": "string"
}
},
"had_role": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
Search Mapping:
{
"properties": {
"relation": {
"type": "keyword",
"ignore_above": 8191
},
"had_role": {
"type": "keyword",
"ignore_above": 8191
}
}
}
StandardKeyword#
Value: StandardKeyword
Indexing: StandardVisitor
OpenAPI:
Search Mapping:
StandardDisabled#
Value: StandardDisabled
Indexing: StandardVisitor
OpenAPI:
Search Mapping:
Integer#
Value: Integer
Indexing: indexingInteger
OpenAPI:
Search Mapping:
StandardText#
Value: StandardText
Indexing: StandardVisitor
OpenAPI:
Search Mapping:
{
"type": "text",
"analyzer": "standard",
"fields": {
"raw": {
"type": "keyword",
"ignore_above": 8191
}
}
}
Spatial#
Value: Spatial
Indexing: GeoSpatialVisitor, if country is set also SpatialVisitor for country field
OpenAPI:
Search Mapping:
Frequency#
Value: Frequency
Indexing: indexingConceptScheme
OpenAPI:
{
"type": "object",
"properties": {
"resource": {
"type": "string"
},
"label": {
"type": "string"
}
}
}
Search Mapping:
{
"properties": {
"resource": {
"type": "keyword",
"ignore_above": 8191
},
"label": {
"type": "text",
"analyzer": "standard",
"fields": {
"raw": {
"type": "keyword",
"ignore_above": 8191
}
}
}
}
}
Theme#
Value: Theme
Indexing: ThemeVisitor
OpenAPI:
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"label": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"resource": {
"type": "string"
}
}
}
Search Mapping:
Dynamic Templates:
[
{
"some_property_label": {
"path_match": "some_property.label.*",
"match_mapping_type": "string",
"mapping": {
"type": "text",
"analyzer": "standard"
}
}
}
]
Mapping:
{
"properties": {
"id": {
"type": "text",
"analyzer": "standard",
"fields": {
"raw": {
"type": "keyword",
"ignore_above": 8191
}
}
},
"label": {
"dynamic": true,
"properties": {
"en": {
"type": "text",
"analyzer": "english"
}
}
},
"resource": {
"type": "keyword",
"ignore_above": 8191
}
}
}
TrimmedMultiLangTitle#
Value: TrimmedMultiLangTitle
Indexing: indexingMultiLang, no array
OpenAPI:
Search Mapping:
Dynamic Templates:
[
{
"some_property": {
"path_match": "some_property.*",
"match_mapping_type": "string",
"mapping": {
"type": "text",
"analyzer": "standard",
"fields": {
"autocomplete": {
"type": "text",
"analyzer": "edgengram_analyzer",
"search_analyzer": "standard"
},
"raw": {
"type": "keyword",
"ignore_above": 8191
}
}
}
}
}
]
Mapping: