search

NASA-PDS / pds-api

PDS web APIs specifications and user's manual
http://nasa-pds.github.io/pds-api
Other
5 stars 3 forks source link

As a user, I want the API to be schema.org compliant #45

Open tloubrieu-jpl opened 3 years ago

tloubrieu-jpl commented 3 years ago

💪 Motivation

...so that I can easily integrate the PDS API with other APIs.

So that PDS datasets are viewed by google as datasets, see for example

image

📖 Additional Details

We want to be able to add a piece of javascript code in our HTML dataset landing page (bundle, collection, observational_products), which will call the registry-api with the lidvid of the current product as an argument and complete the schema.org json-ld description of the dataset (e.g. https://schema.org/Dataset) as described on this page https://developers.google.com/search/docs/appearance/structured-data/dataset#example from the registry-api response content.

The request will use a specific Accept header value application/ld+json in the content negociation.

⚖️ Acceptance Criteria

Given When I perform Then I expect

⚙️ Engineering Details

See introduction https://schema.org/docs/data-and-datasets.html

Bundle/Collection labels: https://schema.org/DataCatalog Observational product labels: https://schema.org/Dataset Data: https://schema.org/DataDownload

tloubrieu-jpl commented 3 years ago

That could be a task for an internship

jordanpadams commented 2 years ago

Lower priority task we are descoping from B12.1