EOX GitLab Instance
Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
V
VS
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Deploy
Releases
Container Registry
Model registry
Monitor
Incidents
Service Desk
Analyze
Value stream analytics
Contributor analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Terms and privacy
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
ESA
PRISM
VS
Commits
6f2004fc
Commit
6f2004fc
authored
5 years ago
by
Fabian Schindler
Browse files
Options
Downloads
Patches
Plain Diff
Adding OpenSearch description for searching
parent
a8dfc013
No related branches found
No related tags found
1 merge request
!8
Docs
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
documentation/usage-guide/searching.md
+74
-0
74 additions, 0 deletions
documentation/usage-guide/searching.md
with
74 additions
and
0 deletions
documentation/usage-guide/searching.md
+
74
−
0
View file @
6f2004fc
# Searching
The main searching interface is supported using OpenSearch using
various extension.
The OpenSearch URL endpoints are:
*
`/opensearch`
: Main service description
*
`/opensearch/<format>`
: Search for collections in a specific format
*
`/opensearch/collections/<collection-id>`
: Collection specific description
*
`/opensearch/collections/<collection-id>/<format>`
: Search for products in a collection in that format
The description related entrypoints provide an OpenSearch Description
Document (OSDD). This XML based file format describes general service metadata and various access URLs.
These URL objects provide templates that can be filled with
parameters to submit actual metadata queries. Depending on the used
URL, the search result is returned in one of the following formats:
*
`atom`
: Atom syndication format
*
`rss`
: RSS
*
`kml`
: Keyhole Markup Language
*
`json`
: GeoJSON
The resulting items in that result document can be paged. Specific
pages can be retrieved using the
`offset`
and
`count`
parameters.
Additionally, the response contains links to the first, last, next,
and previous pages of the result set.
The results of the search depend on the type of object being searched.
For the collection search, the result items are collection descriptions
of all matched collections encoded in the selected format. Each
description contains a link to its own specific OSDD document.
In product searches, the result document items are descriptions of
products, containing links to thumbnails, browses and product specific
services such as WMS or WCS. Additionally it contains the products
acquisition footprint and timestamp.
## Filters
The URL templates for both the collection and the record search allow
to pass parameters that control the query and shape of the search.
The following table shows all parameters available for both collection
and product search:
| Parameter | Description |
| ------------- | --------------------------------------------------------------------------------------------- |
| startIndex | The index offset of the items. Used to get subsets of a result set |
| count | The number of records for each page |
| start | The start timestamp for the time range |
| end | The end timestamp for the time range |
| timerel | The semantic of the time range. Either
`intersects`
,
`contains`
,
`disjoint`
, or
`equals`
|
| bbox | The geographic bounding box expressed as
`min-lon`
,
`min-lat`
,
`max-lon`
,
`max-lat`
in WGS 84 |
| geom | A WKT encoded geometry for a geographic search |
| lon | The longitude component of point/radius searches |
| lat | The latitude component of point/radius searches |
| r | The radious in metres of point/radius searches |
| georel | The semantic of the geometry filter. One of
`intersects`
,
`contains`
, or
`disjoint`
|
The following parameters are only available in collection searchesin
addition the general search parameters:
| Parameter | Description |
| ------------- | --------------------------------------------------------------------------------------------- |
The following parameters are only available in product searches in
addition the general search parameters:
| Parameter | Description |
| ------------- | --------------------------------------------------------------------------------------------- |
| cloudCover | Cloud cover filter. Either a specific value or an interval of values. Values between 0-100 |
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment