Releases: art-institute-of-chicago/data-aggregator
Releases · art-institute-of-chicago/data-aggregator
Testing + performance improvements
Artwork Date Qualifiers and command-line reporting
Improvements to unit test and API documentation
- Fix unit tests [WEB-347, WEB-1382, WEB-1189]
- Speed up the execution of unit test [WEB-1475, WEB-979]
- Finish up branding API documentation [WEB-1354, WEB-1114]
- Add left sidebar with anchor links to API documentation [WEB-1482]
- Produce JSON data dumps of API data [WEB-1384]
- Simplify database migrations
Update documentation and changes to support website email triggers
Minor tweaks to support changes in source systems
Minor enhancements for data served to anonymous users
- Reduce per-page limit down to 100 for anonymous users [WEB-1382, WEB-1365]
- Remove per-page limit for authenticated users [WEB-1382, WEB-1365]
- Refactor logic for parsing
include
parameter to provide more consistent behavior [WEB-979] - Fix bug causing
null
fields in Exhibitions anonymous, non-search responses [WEB-1419]
1.0-beta2
1.0-beta2 – Minor enhancements, code cleanup and reorganization
- Refactor deletes from LAKE so they can run every five minutes instead of hourly
- Move titles into all listing endpoints, where previously they were only indexed in search
- Add CDN in front of API
- Add
alt_text
tothumbnail
block of all resources
ARTWORKS
- The following modifications have been made to the API schema:
has_multimedia_resources
- Added, whether this artwork has any associated microsites, digital publications, or documents tagged as multimediahas_educational_resources
- Added, whether this artwork has any documents tagged as educationaltheme_titles
- Added, the names of all thematic publish categories related to this artwork
EVENTS
- Add fields to support sales.artic.edu
- The following modifications have been made to the API schema:
is_admission_required
- Added, whether admission to the museum is required to attend this eventticketed_event_id
- Added, unique identifier of the event in the ticketing system this website event is tied tosurvey_url
- Added, URL to the survey associated with this eventemail_series
- Added, the email series associated with this eventdoor_time
- Added, the time the doors open for this event
1.0-beta1
1.0-beta1 – Final cleanup before beta and bug fixes
- Upgrade to Laravel 5.6
- Unpublished all documentation
- Performance improvements to artwork endpoints
- Add hourly command to delete unpublished collections data
- Refactor transformations from source systems into a shared code set to reduce duplication
- Add functional tests to monitor artwork search behavior
- Clean up duplication in casting model value types
- Update models when related records are updated. E.g., update artwork
is_on_view
when the galleryis_closed
flag is updated. - Standardize how source dates are output in the API
- Add
info
andconfig
block to the bottom of each request, to convert version number and URLs needed to use paths that reference other systems
ARTWORKS
- Output
fiscal_year
values - The following modifications have been made to the API schema:
technique_id
- Added, unique identifier of the preferred technique term for this workalt_technique_ids
– Added, unique identifiers of all other non-preferred technique terms for this worktechnique_titles
– Added, the names of all technique terms related to this artwork
- The following includes are now available in the /artworks endpoint:
catalogue_pivots
– Renamed fromcatalogues
to more accurately reflect what it returns
ASSETS (including IMAGES, SOUNDS, VIDEOS, and TEXTS)
- The following modifications have been made to the API schema:
alt_text
– Added, alternative text for the asset to describe it to people with low or no visioncopyright_notice
- Added, statement notifying how the asset is protected by copyright. Applies to the asset itself, not artwork it may be related to.
SELECTIONS
- The following modifications have been made to the API schema:
copy
– Renamed fromcontent
to more accurately name its content
DEPRECATED ENDPOINTS
artwork-dates
– Removed due to lack of use cases for accessing or searching this data directlyartwork-dates/{id}
pages
– Deprecated from the Web CMS APIpages/{id}
NEW ENDPOINTS
- A number of new resources types have been made available in the Web CMS, and we've added corresponding endpoints in the Data Hub:
generic-pages
generic-pages/{id}
press-releases
press-releases/{id}
research-guides
research-guides/{id}
educator-resources
educator-resources/{id}
digital-catalogs
digital-catalogs/{id}
printed-catalogs
printed-catalogs/{id}
0.13
0.13 - Tweak search and filters
- Refactor CategoryTerm to store all their data in the same table and use scope models to make distinctions between the two, rather than combining the table data in a view
- Make website pageviews influence relevancy score in artwork search
- Add
technique
term fields
ARTWORKS
- The following modifications have been made to the API schema:
technique_ids
- Added, unique identifiers of all technique terms for this workartist_title
- Added, names of the preferred artist/culture associated with this workdate_dates
- Removed, replaced with thedates
include added in 0.12, as this list doesn't provide any of the pivot fields (preferred, start date, end date, date type qualifier, etc)link_ids
- Removed, as a link is not a unique resource but is represented by thecontent
field on assets
CATEGORY-TERMS (including CATEGORIES and TERMS)
- The following modifications have been made to the API schema:
term_id
- Removed, as this is duplicating theid
fieldcategory_id
- Removed, as this is duplicating theid
fieldterm_type_id
- Removed, replaced withsubtype
, since this list is short and very staticsubtype
- Added, takes one of the following values: classification, material, technique, style, subject, department, theme
ASSETS (including IMAGES, SOUNDS, VIDEOS, and TEXTS)
- Added
content.keyword
field to search, for filtering assets with URLs - The following modifications have been made to the API schema:
is_multimedia_resource
- Added, whether this resource is considered to be multimediais_educational_resource
- Added, whether this resource is considered to be educationalis_teacher_resource
- Added, whether this resource is considered to be educational
DEPRECATED ENDPOINTS
- Links have been removed from the API entirely, as a link is not a unique resource but is represented by the
content
field on assets. - Term types models have been removed and replaced with a static string list
- Removed
/artworks/{id}/terms
since it doesn't provide "pivot" information about which terms are preferred - These endpoints have been removed:
/links
/links/{id}
/links/{id}/pull
/term-types
/term-types/{id}
/term-types/{id}/pull
/artworks/{id}/terms
0.12
0.12 - Finish integration with new collections data
- Add and fill in the final round of collections data integration
- Further refactor import commands for consistency
ARTWORKS
- Add Materials terms
- Replace production-quality faked terms with real data
- Reformat department_id to follow same conventions as /categories IDs, since departments are a subset of category records. (E.g., PC-##)
- Add
*.keyword
fields to Elasticsearch for all*_title[s]
fields - Add *_ids fields to provide all IDs of fields that are split between preferred and alternate fields
- Fill in multiple titles per artwork
- Fill in multiple images per artwork
- Fill in multiple agents per artwork
- Fill in multiple places per artwork
- Fill in multiple assets per artwork
- Fill in multiple dates per artwork
- The following modifications have been made to the API schema:
alt_classification_ids
- Renamed fromalt_classificaiton_ids
to correct typematerial_id
- Added, unique identifier of the preferred material term for this workalt_material_ids
- Added, unique identifiers of all other non-preferred material terms for this workmaterial_ids
- Added, unique identifiers of all material terms for this workmaterial_titles
- Added, the names of all material terms related to this artworkartist_ids
- Added, unique identifier of all artist/cultures associated with this workstyle_ids
- Added, unique identifiers of all style terms for this workclassification_ids
- Added, unique identifiers of all classification terms for this worksubject_ids
- Added, unique identifiers of all subject terms for this work
- The following
include
s are now available in the/artworks
endpoint:artist_pivots
- Provides metadata about the agents in theartists
include, e.g., role, preferred, etc.place_pivots
dates
- While not new, this include has now been filled in with data
ASSETS (including IMAGES, SOUNDS, VIDEOS, and TEXTS)
- Note which assets should be made available in multimedia, educational resources, etc.
- Added
/assets/search
that targets images, videos, sounds, and texts - The following modifications have been made to the API schema:
content
- Added, text of URL of the contents of this assetis_multimedia_resource
- Added, whether this resource is considered to be multimediais_educational_resource
- Added, whether this resource is considered to be educationalis_teacher_resource
- Added, whether this resource is considered to be educational
EXHIBITIONS
- Added installation shots and PDFs related to exhibitions
- The following modifications have been made to the API schema:
image_iiif_url
- Removed, in favor of clients creating the URL based onimage_id
alt_image_ids
- Added, Unique identifiers of all non-preferred images of this exhibition.document_ids
- Added, Unique identifiers of assets that serve as documentation for this exhibition
TERMS
- Replace production-quality fake terms data with real data
- The following modifications have been made to the API schema:
type
- Removed,term_type_id
takes its placeterm_type_id
- Added, unique identifier of term type
TOURS
- Make tours findable by the artwork and artist names of the works included in the tour
- The following modifications have been made to the API schema:
artwork_titles
- Added, names of the artworks featured in this tour's tour stopsartist_titles
- Added, names of the artists of the artworks featured in this tour's tour stopstour_stop_titles
- Removed,artwork_titles
takes its place
PRODUCTS
- Make note of whether a shop product is currently available on their website
- The following modifications have been made to the API schema:
is_active
- Added, whether this product is currently available on the shop website
NEW ENDPOINTS
- The following endpoints have been added:
agent-roles
agent-roles/{id}
artwork-place-qualifiers
artwork-place-qualifiers/{id}
artwork-dates
artwork-dates/{id}
artwork-date-qualifiers
artwork-date-qualifiers/{id}
term-types
term-types/{id}
TO BE DEPRECATED IN 0.13
/artworks
-date_dates
- Replaced with thedates
include, as this list doesn't provide any of the pivot fields (preferred, start date, end date, date type qualifier, etc)/links
- These entire endpoints will be removed, as a link is not a unique resource but is represented by thecontent
field on assets/links/{id}
/links/{id}/pull
/artworks
-link_ids