search

fiboa / specification

Field Boundaries for Agriculture (fiboa) - a specification that describes important properties of field boundaries
Apache License 2.0
9 stars 3 forks source link

Links property #1

Closed m-mohr closed 1 month ago

m-mohr commented 8 months ago

Would it be good to have a link construct comparable to what STAC has? https://github.com/radiantearth/stac-spec/blob/master/item-spec/item-spec.md#link-object

cc @cholmes

Copied from an early draft of the spec:

Property Name Data Type Description
links [Link Object] A list of links to other resources.

Link Object

This object describes a relationship with another entity. Data providers are advised to be liberal with links.

Field Name Type Description
href string REQUIRED. The actual link in the format of an URL. Relative and absolute links are both allowed.
rel string REQUIRED. Relationship between the current document and the linked document. See chapter Relation Types for more information.
type string IANA media type of the referenced entity.
title string A human readable title to be used in rendered displays of the link.
Relation Types

Where possible it is recommended to use the official IANA Link Relation Types.

Type Description
self STRONGLY RECOMMENDED. Absolute URL to the location that the file can be found online, if available. This is particularly useful when in a download package that includes metadata, so that the downstream user can know where the data has come from.
license The license URL(s) for the data SHOULD be specified if the license field is set to other. If there is no public license URL available, it is RECOMMENDED to put the license text in a separate file and link to this file.
m-mohr commented 1 month ago

Might be an extension in the future, see https://github.com/fiboa/extensions/issues/8