refactored conformance classes for extensions #790
Conversation
vincentsarago
requested review from
gadomski and
m-mohr
and removed request for
m-mohr
| FILTER = "https://api.stacspec.org/v1.0.0-rc.1/collection-search#filter" | ||
| QUERY = "https://api.stacspec.org/v1.0.0-rc.1/collection-search#query" | ||
| SORT = "https://api.stacspec.org/v1.0.0-rc.1/collection-search#sort" | ||
| FIELDS = "https://api.stacspec.org/v1.0.0-rc.1/collection-search#fields" |
There was a problem hiding this comment.
Those have been moved to each extensions Enums (will update the changelog to mention it)
| for ext in extensions: | ||
| if conf := known_extension_conformances.get(ext.__class__.__name__, None): | ||
| conformance_classes.append(conf) | ||
| conformance_classes.extend(ext.conformance_classes) |
There was a problem hiding this comment.
we now extend the conformance classes with the classes found within the extensions
|
|
||
| SEARCH = "https://api.stacspec.org/v1.0.0-rc.2/item-search#filter" | ||
| ITEMS = "http://www.opengis.net/spec/ogcapi-features-3/1.0/conf/features-filter" | ||
| COLLECTIONS = "https://api.stacspec.org/v1.0.0-rc.1/collection-search#filter" |
There was a problem hiding this comment.
For consistency, most extension will have search, items and collections
| response_class=self.response_class, | ||
| endpoint=create_async_endpoint(self.client.get_queryables, EmptyRequest), | ||
| ) | ||
| app.include_router(self.router, tags=["Filter Extension"]) |
There was a problem hiding this comment.
the search extension only register the /queryables endpoint
| Returns: | ||
| None | ||
| """ | ||
| pass |
There was a problem hiding this comment.
maybe worth for add a note about why we're not registering default endpoint here
| ) | ||
| COLLECTIONS_ADVANCED = ( | ||
| "https://api.stacspec.org/v1.0.0-rc.1/collection-search#advanced-free-text" | ||
| ) |
There was a problem hiding this comment.
just re-ordering entries (to have search/items/collections)
| """ | ||
|
|
||
| ITEMS = "https://api.stacspec.org/v1.0.0/ogcapi-features/extensions/transaction" | ||
| COLLECTIONS = "https://api.stacspec.org/v1.0.0/collections/extensions/transaction" |
|
here is an example of full application https://gist.github.com/vincentsarago/4ee0fdf471cf592a8ba642dcc72304d2#file-app-py |
|
Don't really have time to fully review right now, sorry. If you have specific things you want me to check though, please let me know. |
|
the changes are quite |
Makes sense to me. |
vincentsarago
deleted the
feature/refactor-conformance-classes-for-extensions
branch
3 participants
while working on stac-utils/stac-fastapi-pgstac#192 I realized the
extensionswhere designed first for/searchendpoints and might lead to some issues within the application conformance classes list.This PR aims to create extensions with correct conformances classes but also makes customization easier.
Changelog:
collection_search.ConformanceClasses->collection_search.CollectionSearchConformanceClassescollection_search.CollectionSearchPostExtension.from_extension(ext)method will now use the conformance classes from the input extensions to derived the output conformance classes.fields.FieldsConformanceClassesEnumfilter.FilterConformanceClasses.FEATURES_FILTER->filter.FilterConformanceClasses.ITEMSfilter.FilterConformanceClasses.ITEM_SEARCH_FILTER->filter.FilterConformanceClasses.SEARCHfilter.FilterConformanceClasses.COLLECTIONSfilter.SearchFilterExtension,filter.ItemCollectionFilterExtensionandfilter.CollectionSearchFilterExtensionendpoint specific extensionsFreeTextConformanceClasses.COLLECTIONSandFreeTextConformanceClasses.ITEMSinFreeTextExtensionandFreeTextAdvancedExtensiondefault conformances classesquery.QueryConformanceClassesEnumSortConformanceClassesEnum