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

Add attribution field to STAC entities #1278

Closed
wants to merge 5 commits into from
Closed

Conversation

emmanuelmathot
Copy link
Collaborator

Related Issue(s): #1126

Proposed Changes:

  1. Add attribution field to common basic metadata

PR Checklist:

  • This PR is made against the dev branch (all proposed changes except releases should be against dev, not master).
  • This PR has no breaking changes.
  • I have added my changes to the CHANGELOG
    or a CHANGELOG entry is not required.
  • This PR affects the STAC API spec,
    and I have opened issue/PR #XXX to track the change.

@emmanuelmathot emmanuelmathot requested a review from m-mohr May 7, 2024 11:49
| description | string | Detailed multi-line description to fully explain the STAC entity. [CommonMark 0.29](https://commonmark.org/) syntax MAY be used for rich text representation. |
| keywords | \[string] | List of keywords describing the STAC entity. |
| roles | \[string] | The semantic roles of the entity, e.g. for assets, links, providers, bands, etc. |
| attribution | string | The attribution should be short and intended for presentation to a user, for example, in a corner of a map. Parts of the text can be links to other resources if additional information is needed. [CommonMark 0.29](https://commonmark.org/) syntax MAY be used for rich text. |
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In OGC API - Common it looks more like HTML is the markup language instead of CommonMark, although their language is a bit ambiguous.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since we allow markdown everywhere else when rich text is possible, allowing html seems inconsistent. md to html converter are pretty frequent

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, on the other hand it would better align with OGC and Markdown renderers can usually just leverage HTML, too.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I hesitated but if you say so, I put HTML

Copy link
Collaborator

@m-mohr m-mohr May 7, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also not a big fan of HTML, maybe let's clarify with OGC?
opengeospatial/ogcapi-common#303 (comment)

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Funny how quick my "what should go wrong" yesterday was made obsolete. The HTML/Markup issue makes me think we might want to go for an extension...

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add to discussion for next STAC meetup

@emmanuelmathot emmanuelmathot added this to the 1.1 milestone May 14, 2024
@m-mohr m-mohr linked an issue May 14, 2024 that may be closed by this pull request
@emmanuelmathot
Copy link
Collaborator Author

Discussion in STAC meetup: move it to extension

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Backport attribution from OGC APIs to a STAC extension
2 participants