-
-
Notifications
You must be signed in to change notification settings - Fork 72
docs: add initial documentation for Getty Images data source #264
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
base: main
Are you sure you want to change the base?
docs: add initial documentation for Getty Images data source #264
Conversation
Adds a high-level description of proposed queries and metadata returned by the Getty Images API for Quantifying the Commons.
TimidRobot
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull requests (PRs) that don't use the description template can't be accepted. Please update the description.
Instead of creating a new file, please add a section to sources.md. The existing entries give examples regarding what has been found to be most helpful.
It would also be helpful to document specific API usage/queries in the description of this PR.
|
Thank you for the feedback, that’s very helpful. I’ll update the PR description to use the required template and move the I’ll push the updates shortly. |
|
I’ve updated the PR to use the required template, moved the documentation into |
Please update the PR description with the proposed API query and what the headers would be for the resulting data file(s). |
@Geethanjali2412-K This has not yet been completed. |
|
Hello.. I’ve updated the PR description to fully follow the required template and added the proposed API query along with the expected data file headers. |
Fixes
Description
This pull request adds documentation for Getty Images as a potential data
source for the Quantifying the Commons project.
The documentation explains a proposed Getty Images API query and describes the
type of data that would be produced, using clear, high-level explanations rather
than raw API responses or media files.
Technical details
The Getty Images API (v3) provides access to metadata for a large collection of
commercial visual content, including images, illustrations, videos, and
editorial media from Getty Images and iStock.
The API returns metadata only and does not require downloading or storing media
assets. Requests are authenticated using an API key and responses are returned
in JSON format.
A representative API query could:
“education”)
If the results of this query were stored as a dataset, the resulting data file
could include the following headers:
asset_idasset_typetitledescriptioncreator_namecollection_namelicense_modelusage_restrictionskeywordscreated_dateThis structure enables analysis of licensed creative works without downloading
or storing the underlying media files.
Tests
Not applicable (documentation-only change).
Screenshots
Not applicable.
Checklist
Update index.md).mainormaster).Developer Certificate of Origin
For the purposes of this DCO, "license" is equivalent to "license or public domain dedication," and "open source license" is equivalent to "open content license or public domain dedication."
Developer Certificate of Origin