Module api_doc

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

Structs

AreasApiDoc 🔒

Struct used by utoipa to generate OpenApi documentation for all area endpoints.

BaseLayerImagesApiDoc 🔒

Struct used by utoipa to generate OpenApi documentation for all base_layer_image endpoints.

BlossomsApiDoc 🔒

Struct used by utoipa to generate OpenApi documentation for all blossoms endpoints.

ConfigApiDoc 🔒

Struct used by utoipa to generate OpenApi documentation for all config endpoints.

DrawingsApiDoc 🔒

Struct used by utoipa to generate OpenApi documentation for all 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 layers endpoints.

MapApiDoc 🔒

Struct used by utoipa to generate OpenApi documentation for all map endpoints.

MapCollaboratorsApiDoc 🔒

struct used by utoipa to generate openapi documentation for all map_collaborators 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 plants endpoints.

SecurityAddon 🔒

Used by utoipa for OAuth2.

SeedApiDoc 🔒

Struct used by utoipa to generate OpenApi documentation for all seed 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 users endpoints.

Functions

config

Merges OpenApi and then serves it using Swagger.