common

Documentation

Overview

*

• Copyright 2023 Planet Labs PBC *
• Licensed under the Apache License, Version 2.0 (the "License");
• you may not use this file except in compliance with the License.
• You may obtain a copy of the License at *
• http://www.apache.org/licenses/LICENSE-2.0 *
• Unless required by applicable law or agreed to in writing, software
• distributed under the License is distributed on an "AS IS" BASIS,
• WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
• See the License for the specific language governing permissions and
• limitations under the License.

*

• Copyright 2023 Planet Labs PBC *
• Licensed under the Apache License, Version 2.0 (the "License");
• you may not use this file except in compliance with the License.
• You may obtain a copy of the License at *
• http://www.apache.org/licenses/LICENSE-2.0 *
• Unless required by applicable law or agreed to in writing, software
• distributed under the License is distributed on an "AS IS" BASIS,
• WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
• See the License for the specific language governing permissions and
• limitations under the License.

*

• Copyright 2023 Planet Labs PBC *
• Licensed under the Apache License, Version 2.0 (the "License");
• you may not use this file except in compliance with the License.
• You may obtain a copy of the License at *
• http://www.apache.org/licenses/LICENSE-2.0 *
• Unless required by applicable law or agreed to in writing, software
• distributed under the License is distributed on an "AS IS" BASIS,
• WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
• See the License for the specific language governing permissions and
• limitations under the License.

*

• Copyright 2023 Planet Labs PBC *
• Licensed under the Apache License, Version 2.0 (the "License");
• you may not use this file except in compliance with the License.
• You may obtain a copy of the License at *
• http://www.apache.org/licenses/LICENSE-2.0 *
• Unless required by applicable law or agreed to in writing, software
• distributed under the License is distributed on an "AS IS" BASIS,
• WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
• See the License for the specific language governing permissions and
• limitations under the License.

*

• Copyright 2023 Planet Labs PBC *
• Licensed under the Apache License, Version 2.0 (the "License");
• you may not use this file except in compliance with the License.
• You may obtain a copy of the License at *
• http://www.apache.org/licenses/LICENSE-2.0 *
• Unless required by applicable law or agreed to in writing, software
• distributed under the License is distributed on an "AS IS" BASIS,
• WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
• See the License for the specific language governing permissions and
• limitations under the License.

*

• Copyright 2023 Planet Labs PBC *
• Licensed under the Apache License, Version 2.0 (the "License");
• you may not use this file except in compliance with the License.
• You may obtain a copy of the License at *
• http://www.apache.org/licenses/LICENSE-2.0 *
• Unless required by applicable law or agreed to in writing, software
• distributed under the License is distributed on an "AS IS" BASIS,
• WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
• See the License for the specific language governing permissions and
• limitations under the License.

*

• Copyright 2023 Planet Labs PBC *
• Licensed under the Apache License, Version 2.0 (the "License");
• you may not use this file except in compliance with the License.
• You may obtain a copy of the License at *
• http://www.apache.org/licenses/LICENSE-2.0 *
• Unless required by applicable law or agreed to in writing, software
• distributed under the License is distributed on an "AS IS" BASIS,
• WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
• See the License for the specific language governing permissions and
• limitations under the License.

*

• Copyright 2023 Planet Labs PBC *
• Licensed under the Apache License, Version 2.0 (the "License");
• you may not use this file except in compliance with the License.
• You may obtain a copy of the License at *
• http://www.apache.org/licenses/LICENSE-2.0 *
• Unless required by applicable law or agreed to in writing, software
• distributed under the License is distributed on an "AS IS" BASIS,
• WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
• See the License for the specific language governing permissions and
• limitations under the License.

Index

• func GetConformance(base *url.URL) (*api.Conformance, error)
• func GetDocs(apiPath string) ([]byte, error)
• func GetRoot(base *url.URL) (*api.Root, error)
• func GetSchema() (*openapi3.T, error)
• func GetTileMatrixSet(id string, base *url.URL) (*api.TileMatrixSet, error)
• func GetTileMatrixSetList(base *url.URL, tiles []*TileSetConfig) (*api.TileMatrixSetList, error)
• func GetTileSet(base *url.URL, id int, tileSetConfig *TileSetConfig) (*api.TileSet, error)
• func GetTileSetList(base *url.URL, tiles []*TileSetConfig) (*api.TileSetList, error)
• type Config
• type GenerateConfig
• type ServeConfig
• type TileSetConfig

Functions

func GetConformance

func GetConformance(base *url.URL) (*api.Conformance, error)

func GetDocs

func GetDocs(apiPath string) ([]byte, error)

func GetRoot

func GetRoot(base *url.URL) (*api.Root, error)

func GetSchema

func GetSchema() (*openapi3.T, error)

func GetTileMatrixSet

func GetTileMatrixSet(id string, base *url.URL) (*api.TileMatrixSet, error)

func GetTileMatrixSetList

func GetTileMatrixSetList(base *url.URL, tiles []*TileSetConfig) (*api.TileMatrixSetList, error)

func GetTileSet

func GetTileSet(base *url.URL, id int, tileSetConfig *TileSetConfig) (*api.TileSet, error)

func GetTileSetList

func GetTileSetList(base *url.URL, tiles []*TileSetConfig) (*api.TileSetList, error)

Types

type Config

type Config struct {
	Serve    *ServeConfig     `validate:"omitempty"`
	Generate *GenerateConfig  `validate:"omitempty"`
	Tiles    []*TileSetConfig `validate:"required,dive"`
}

type GenerateConfig

type GenerateConfig struct {
	Origin    string
	Directory string
}

type ServeConfig

type ServeConfig struct {
	Port   int `validate:"gte=0"`
	Origin string
}

type TileSetConfig

type TileSetConfig struct {
	URL             string `validate:"required,url,contains={z},contains={x},contains={y}"`
	Title           string
	Type            string
	TileType        string
	TileMatrixSetID string
	MinZoom         *int
	MaxZoom         *int
	Extent          []float64
}