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

New profile for DCAT US v3 #314

Merged
merged 32 commits into from
Oct 31, 2024
Merged
Changes from 1 commit
Commits
Show all changes
32 commits
Select commit Hold shift + click to select a range
418afa5
Rename example files
amercader Oct 2, 2024
ebadc16
Set things up for DCAT US profile
amercader Oct 2, 2024
171a7d8
Adapt example values to US profile
amercader Oct 4, 2024
4259f19
Separate schema file for DCAT US
amercader Oct 7, 2024
baf6d6e
Merge branch 'master' into dcat-us-3
amercader Oct 7, 2024
e9bb1b3
Consolidate input datasets in tests
amercader Oct 7, 2024
3d8eccb
Add tests for dcat_us_3 profile
amercader Oct 7, 2024
82d1e09
Add missing creator to dcat-us schema
amercader Oct 7, 2024
60009fb
Extend DCAT US profile from DCAT AP 3
amercader Oct 7, 2024
8239e1b
Add identifier property to Distributions
amercader Oct 7, 2024
90224d1
Tweaks on publisher class for dcat-us
amercader Oct 7, 2024
4dd41f6
Remove foaf:Document class
amercader Oct 8, 2024
7eff792
Don't test access_services for now
amercader Oct 8, 2024
8fd1284
Improve serialization of statements
amercader Oct 9, 2024
9569479
Update dcat us 3 test
amercader Oct 9, 2024
4040074
Index strings for repeating subfields
amercader Oct 9, 2024
712b804
Add bounding box property
amercader Oct 9, 2024
44a11fd
Add temporal_resolution to distributions
amercader Oct 14, 2024
bd346a0
Add support for data dictionary properties
amercader Oct 17, 2024
1ea2371
Merge branch 'master' into dcat-us-3
amercader Oct 17, 2024
82d8186
Fix parsing of statements after #313
amercader Oct 17, 2024
b9fa013
Add liability statement property
amercader Oct 17, 2024
ce247f4
Merge branch 'master' into dcat-us-3
amercader Oct 17, 2024
1b267f9
Support for temporalResolution and spatialResolution in distributions
amercader Oct 18, 2024
4c18b71
Add contributor property, support for multiple agents
amercader Oct 18, 2024
21d53ea
Add properties for character encoding, purpose and usage
amercader Oct 18, 2024
36a2846
Merge branch 'dcat-us-3' of github.com:ckan/ckanext-dcat into dcat-us-3
amercader Oct 18, 2024
3f39675
Add schema for DCAT US recommended properties
amercader Oct 21, 2024
49da344
Update docs to reflect DCAT-US changes
amercader Oct 21, 2024
641bcd0
Make mapping table sortable
amercader Oct 21, 2024
2773c3c
Merge branch 'multiple-agents' into dcat-us-3
amercader Oct 23, 2024
5f79509
Merge branch 'master' into dcat-us-3
amercader Oct 31, 2024
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
Prev Previous commit
Next Next commit
Add schema for DCAT US recommended properties
amercader committed Oct 21, 2024
commit 3f396754aa8cef24278548d01571f1a9fe892319
2 changes: 1 addition & 1 deletion ckanext/dcat/schemas/dcat_ap_full.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
scheming_version: 2
dataset_type: dataset
about: Full DCAT AP 2.1 schema
about: Full DCAT AP (2 and 3) schema
about_url: http://github.com/ckan/ckanext-dcat

dataset_fields:
2 changes: 1 addition & 1 deletion ckanext/dcat/schemas/dcat_ap_recommended.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
scheming_version: 2
dataset_type: dataset
about: Recommended fields for DCAT AP 2.1 schema
about: Recommended properties for the DCAT AP (2 and 3) schema
about_url: http://github.com/ckan/ckanext-dcat

dataset_fields:
12 changes: 0 additions & 12 deletions ckanext/dcat/schemas/dcat_us_full.yaml
Original file line number Diff line number Diff line change
@@ -312,12 +312,6 @@ dataset_fields:
validators: ignore_missing scheming_multiple_text
help_text: A related resource, such as a publication, that references, cites, or otherwise points to the dataset.

- field_name: applicable_legislation
label: Applicable legislation
preset: multiple_text
validators: ignore_missing scheming_multiple_text
help_text: The legislation that mandates the creation or management of the dataset.

- field_name: data_dictionary
label: Data dictionary
repeating_label: Data dictionary
@@ -472,12 +466,6 @@ resource_fields:
validators: ignore_missing scheming_multiple_text
help_text: An established schema to which the described resource conforms.

- field_name: applicable_legislation
label: Applicable legislation
preset: multiple_text
validators: ignore_missing scheming_multiple_text
help_text: The legislation that mandates the creation or management of the resource.

- field_name: access_services
label: Access services
repeating_label: Access service
256 changes: 256 additions & 0 deletions ckanext/dcat/schemas/dcat_us_recommended.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,256 @@
scheming_version: 2
dataset_type: dataset
about: Recommended properties of the DCAT US schema
about_url: http://github.com/ckan/ckanext-dcat

dataset_fields:

- field_name: title
label: Title
preset: title
required: true
help_text: A descriptive title for the dataset.

- field_name: name
label: URL
preset: dataset_slug
form_placeholder: eg. my-dataset

- field_name: notes
label: Description
required: true
form_snippet: markdown.html
help_text: A free-text account of the dataset.

- field_name: tag_string
label: Keywords
preset: tag_string_autocomplete
form_placeholder: eg. economy, mental health, government
help_text: Keywords or tags describing the dataset. Use commas to separate multiple values.

- field_name: contact
label: Contact points
repeating_label: Contact point
repeating_subfields:

- field_name: uri
label: URI

- field_name: name
label: Name

- field_name: email
label: Email
display_snippet: email.html
help_text: Contact information for enquiries about the dataset.

- field_name: publisher
label: Publisher
repeating_label: Publisher
repeating_once: true
repeating_subfields:

- field_name: uri
label: URI

- field_name: name
label: Name

- field_name: email
label: Email
display_snippet: email.html

- field_name: url
label: URL
display_snippet: link.html

- field_name: type
label: Type

- field_name: identifier
label: Identifier
help_text: Unique identifier for the publisher, such as a ROR ID.
help_text: Entity responsible for making the dataset available.

- field_name: license_id
label: License
form_snippet: license.html
help_text: License definitions and additional information can be found at http://opendefinition.org/.

- field_name: owner_org
label: Organization
preset: dataset_organization
help_text: The CKAN organization the dataset belongs to.

- field_name: url
label: Landing page
form_placeholder: http://example.com/dataset.json
display_snippet: link.html
help_text: Web page that can be navigated to gain access to the dataset, its distributions and/or additional information.

# Note: this will fall back to metadata_created if not present
- field_name: issued
label: Release date
preset: dcat_date
help_text: Date of publication of the dataset.

# Note: this will fall back to metadata_modified if not present
- field_name: modified
label: Modification date
preset: dcat_date
help_text: Most recent date on which the dataset was changed, updated or modified.

# Note: CKAN will generate a unique identifier for each dataset
- field_name: identifier
label: Identifier
help_text: A unique identifier of the dataset, if not provided it will fall back to CKAN's internal id.

- field_name: temporal_coverage
label: Temporal coverage
repeating_subfields:

- field_name: start
label: Start
preset: dcat_date

- field_name: end
label: End
preset: dcat_date
help_text: The temporal period or periods the dataset covers.

- field_name: bbox
label: Geographic Bounding Box
repeating_subfields:

- field_name: west
label: West Longitude

- field_name: east
label: East Longitude

- field_name: north
label: North Latitude

- field_name: south
label: South Latitude
help_text: A geographic bounding box in WGS84 coordinate system (Lat/Long) that describes the spatial extent of the dataset.

- field_name: spatial_coverage
label: Spatial coverage
repeating_subfields:

- field_name: uri
label: URI

- field_name: text
label: Label

- field_name: geom
label: Geometry

- field_name: bbox
label: Bounding Box

- field_name: centroid
label: Centroid
help_text: A geographic region that is covered by the dataset.

- field_name: theme
label: Theme
preset: multiple_text
validators: ignore_missing scheming_multiple_text
help_text: A category of the dataset. A Dataset may be associated with multiple themes.

- field_name: data_dictionary
label: Data dictionary
repeating_label: Data dictionary
repeating_once: true
repeating_subfields:

- field_name: url
label: URL

- field_name: format
label: Format

- field_name: license
label: License

# Note: if not provided, this will be autogenerated
- field_name: uri
label: URI
help_text: An URI for this dataset (if not provided it will be autogenerated).

# TODO: relation-based properties are not yet included (e.g. is_version_of, source, sample, etc)
#
resource_fields:

- field_name: url
label: URL
preset: resource_url_upload

- field_name: name
label: Name
form_placeholder:
help_text: A descriptive title for the resource.

- field_name: format
label: Format
preset: resource_format_autocomplete
help_text: File format. If not provided it will be guessed.

- field_name: rights
label: Rights
form_snippet: markdown.html
display_snippet: markdown.html
help_text: Some statement about the rights associated with the resource.

- field_name: license
label: License
help_text: License in which the resource is made available. If not provided will be inherited from the dataset.

# Note: this falls back to the standard resource url field
- field_name: access_url
label: Access URL
help_text: URL that gives access to the dataset (defaults to the standard resource URL).

# Note: this falls back to the standard resource url field
- field_name: download_url
label: Download URL
display_snippet: link.html
help_text: URL that provides a direct link to a downloadable file (defaults to the standard resource URL).

- field_name: issued
label: Release date
preset: dcat_date
help_text: Date of publication of the resource.

- field_name: modified
label: Modification date
preset: dcat_date
help_text: Most recent date on which the resource was changed, updated or modified.

- field_name: temporal_resolution
label: Temporal resolution
help_text: Minimum time period resolvable in the distribution.

- field_name: data_dictionary
label: Data dictionary
repeating_label: Data dictionary
repeating_once: true
repeating_subfields:

- field_name: url
label: URL

- field_name: format
label: Format

- field_name: license
label: License


# Note: if not provided, this will be autogenerated
- field_name: uri
label: URI
help_text: An URI for this resource (if not provided it will be autogenerated).