README
¶
Geospatial data resources / collections.
For GoKoala devs: If you want to implement collections support in one of the OGC building blocks
in GoKoala (see ogc
package) you'll need to perform the following tasks:
Config:
- Expand / add yaml tag in
engine.Config.OgcAPI
to allow users to configure collections
OpenAPI
- Materialize the collections as API endpoints by looping over the collection in the OpenAPI template
for that specific OGC building block. For example for OGC tiles you'll need to
create
/collection/{collectionId}/tiles
endpoints in OpenAPI. Note/collection/{collectionId}
endpoint are already implemented in OpenAPI by this package.
Responses:
- Expand the
collections
andcollection
templates. - Implement an endpoint in your specific OGC API building block to serve the CONTENTS of a collection
(e.g.
/collection/{collectionId}/tiles
)
Testing:
- Add unit tests
Documentation
¶
Index ¶
Constants ¶
const (
CollectionsPath = "/collections"
)
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Collections ¶
type Collections struct {
// contains filtered or unexported fields
}
func NewCollections ¶
func NewCollections(e *engine.Engine) *Collections
NewCollections enables support for OGC APIs that organize data in the concept of collections. A collection, also known as a geospatial data resource, is a common way to organize data in various OGC APIs.
func (*Collections) Collection ¶
func (c *Collections) Collection() http.HandlerFunc
Collection provides METADATA about a specific collection. To get the CONTENTS of a collection each OGC API building block must provide a separate/specific endpoint.
For example in: - OGC API Features you would have: /collections/{collectionId}/items - OGC API Tiles could have: /collections/{collectionId}/tiles - OGC API Maps could have: /collections/{collectionId}/map - OGC API 3d GeoVolumes would have: /collections/{collectionId}/3dtiles
func (*Collections) Collections ¶
func (c *Collections) Collections() http.HandlerFunc
Collections returns list of collections