Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

split OGC Features and Tiles endpoints factories #32

Merged
merged 12 commits into from
Mar 16, 2023
Merged

split OGC Features and Tiles endpoints factories #32

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
c8aea34
split OGC Features and Tiles endpoints factories
vincentsarago Feb 28, 2023
92139ca
update isort
vincentsarago Mar 14, 2023
990c40e
fix URL type after starlette update
vincentsarago Mar 15, 2023
966e1b3
add Main Factory
vincentsarago Mar 15, 2023
571130f
name -> title
vincentsarago Mar 15, 2023
cd5ef52
add full OGC tiles options + docs
vincentsarago Mar 15, 2023
f071e09
Merge branch 'main' into splitEndpointFactories
vincentsarago Mar 15, 2023
98316f0
davids comments
vincentsarago Mar 15, 2023
6992ca0
add factories tests
vincentsarago Mar 16, 2023
c03d045
fix docs
vincentsarago Mar 16, 2023
fca4d92
docs
vincentsarago Mar 16, 2023
9599bd5
Update tipg/factory.py
vincentsarago Mar 16, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 10 additions & 2 deletions docs/src/advanced/factories.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,14 +63,16 @@ app.include_router(endpoints.router, tags=["OGC Features API"])

- **collection_dependency** (Callable[..., tipg.dbmodel.Collection]): Callable which return a Collection instance

- **full** (bool, optional): Create Full OGC Features API set of endpoints (with landing `/` and conformance `/conformance` endpoints). Defaults to `True`
- **with_common** (bool, optional): Create Full OGC Features API set of endpoints with OGC Common endpoints (landing `/` and conformance `/conformance`). Defaults to `True`

- **router** (fastapi.APIRouter, optional): FastAPI

- **router_prefix** (str, optional): *prefix* for the whole set of endpoints

- **templates** (starlette.templating.Jinja2Templates, optional): Templates to be used in endpoint's responses

- **title** (str, optional): Title of for the endpoints (only used if `with_common=True`)

#### Endpoints

| Method | Path | Output | Description
Expand Down Expand Up @@ -100,14 +102,16 @@ app.include_router(endpoints.router, tags=["OGC Tiles API"])

- **supported_tms** (morecantile.TileMatrixSets): morecantile TileMatrixSets instance (holds a set of TileMatrixSet documents)

- **full** (bool, optional): Create Full OGC Tiles API set of endpoints (with landing `/` and conformance `/conformance` endpoints). Defaults to `True`
- **with_common** (bool, optional): Create Full OGC Features API set of endpoints with OGC Common endpoints (landing `/` and conformance `/conformance`). Defaults to `True`

- **router** (fastapi.APIRouter, optional): FastAPI

- **router_prefix** (str, optional): *prefix* for the whole set of endpoints

- **templates** (starlette.templating.Jinja2Templates, optional): Templates to be used in endpoint's responses

- **title** (str, optional): Title of for the endpoints (only used if `with_common=True`)

#### Endpoints

| Method | Path | Output | Description
Expand Down Expand Up @@ -136,12 +140,16 @@ app.include_router(endpoints.router)

- **supported_tms** (morecantile.TileMatrixSets): morecantile TileMatrixSets instance (holds a set of TileMatrixSet documents)

- **with_common** (bool, optional): Create Full OGC Features API set of endpoints with OGC Common endpoints (landing `/` and conformance `/conformance`). Defaults to `True`

- **router** (fastapi.APIRouter, optional): FastAPI

- **router_prefix** (str, optional): *prefix* for the whole set of endpoints

- **templates** (starlette.templating.Jinja2Templates, optional): Templates to be used in endpoint's responses

- **title** (str, optional): Title of for the endpoints (only used if `with_common=True`)

#### Endpoints

| Method | Path | Output | Description
Expand Down
Loading