Module backend::config::api_doc

Contains code to generate OpenApi documentation and a Swagger endpoint using utoipa and utoipa_swagger_ui.

Structs

• BaseLayerImagesApiDoc 🔒
  Struct used by utoipa to generate OpenApi documentation for all plantings endpoints.
• BlossomsApiDoc 🔒
  Struct used by utoipa to generate OpenApi documentation for all blossom endpoints.
• ConfigApiDoc 🔒
  Struct used by utoipa to generate OpenApi documentation for all config endpoints.
• DrawingsApiDoc 🔒
  Struct used by utoipa to generate OpenApi documentation for drawings endpoints.
• GuidedToursApiDoc 🔒
  Struct used by utoipa to generate OpenApi documentation for all guided tours endpoints.
• LayerApiDoc 🔒
  Struct used by utoipa to generate OpenApi documentation for all layer endpoints.
• MapApiDoc 🔒
  Struct used by utoipa to generate OpenApi documentation for all map endpoints.
• PlantLayerApiDoc 🔒
  Struct used by utoipa to generate OpenApi documentation for all plant layer endpoints.
• PlantingsApiDoc 🔒
  Struct used by utoipa to generate OpenApi documentation for all plantings endpoints.
• PlantsApiDoc 🔒
  Struct used by utoipa to generate OpenApi documentation for all plant endpoints.
• SecurityAddon 🔒
  Used by utoipa for OAuth2.
• SeedApiDoc 🔒
  Struct used by utoipa to generate OpenApi documentation for all seed endpoints.
• ShadingsApiDoc 🔒
  Struct used by utoipa to generate OpenApi documentation for all shadings endpoints.
• TimelineApiDoc 🔒
  Struct used by utoipa to generate OpenApi documentation for all timeline endpoints.
• UsersApiDoc 🔒
  Struct used by utoipa to generate OpenApi documentation for all user data endpoints.

Functions

• config
  Merges OpenApi and then serves it using Swagger.