From f35276ccbb0adf58ece7c2565afdcc1c5509cdd2 Mon Sep 17 00:00:00 2001 From: vincentsarago Date: Tue, 19 Dec 2023 17:07:18 +0100 Subject: [PATCH] update docs --- CHANGES.md | 4 ++++ docs/src/advanced/customization.md | 2 +- docs/src/user_guide/factories.md | 4 ++-- 3 files changed, 7 insertions(+), 3 deletions(-) diff --git a/CHANGES.md b/CHANGES.md index 995630dd..5c204b36 100644 --- a/CHANGES.md +++ b/CHANGES.md @@ -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 diff --git a/docs/src/advanced/customization.md b/docs/src/advanced/customization.md index 93d5cca8..acf8c04d 100644 --- a/docs/src/advanced/customization.md +++ b/docs/src/advanced/customization.md @@ -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) ``` diff --git a/docs/src/user_guide/factories.md b/docs/src/user_guide/factories.md index 95722f43..a1775d71 100644 --- a/docs/src/user_guide/factories.md +++ b/docs/src/user_guide/factories.md @@ -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 @@ -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