Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
vincentsarago committed Dec 19, 2023
1 parent d5165dc commit f35276c
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 3 deletions.
4 changes: 4 additions & 0 deletions CHANGES.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,10 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/).

Note: Minor version `0.X.0` update might break the API, It's recommended to pin `tipg` to minor version: `tipg>=0.1,<0.2`

## [unreleased]

- add `tags` to all routes

## [0.5.6] - 2023-12-19

- Fix collections `prev` links and collections html templates
Expand Down
2 changes: 1 addition & 1 deletion docs/src/advanced/customization.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ async def lifespan(app: FastAPI):
app = FastAPI(openapi_url="/api", docs_url="/api.html", lifespan=lifespan)

endpoints = OGCFeaturesFactory(with_common=True)
app.include_router(endpoints.router, tags=["OGC Features API"])
app.include_router(endpoints.router)

add_exception_handlers(app, DEFAULT_STATUS_CODES)
```
Expand Down
4 changes: 2 additions & 2 deletions docs/src/user_guide/factories.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ from tipg.factory import OGCFeaturesFactory

app = FastAPI()
endpoints = OGCFeaturesFactory(with_common=True)
app.include_router(endpoints.router, tags=["OGC Features API"])
app.include_router(endpoints.router)
```

#### Creation Options
Expand Down Expand Up @@ -106,7 +106,7 @@ from tipg.factory import OGCTilesFactory

app = FastAPI()
endpoints = OGCTilesFactory(with_common=True)
app.include_router(endpoints.router, tags=["OGC Tiles API"])
app.include_router(endpoints.router)
```

#### Creation Options
Expand Down

1 comment on commit f35276c

@github-actions
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Performance Alert ⚠️

Possible performance regression was detected for benchmark 'TiPg Benchmarks'.
Benchmark result of this commit is worse than the previous benchmark result exceeding threshold 1.30.

Benchmark suite Current: f35276c Previous: f3f4465 Ratio
tests/benchmarks.py::test_benchmark_tile[0/0/0-WGS1984Quad] 7.1174410827301395 iter/sec (stddev: 0.1745451994508283) 11.33516408021844 iter/sec (stddev: 0.0030325835005803586) 1.59

This comment was automatically generated by workflow using github-action-benchmark.

Please sign in to comment.