From 4cd9d72c3ef7aaed538b2ea6ab129a2de6990c59 Mon Sep 17 00:00:00 2001 From: ralpha Date: Sun, 3 Dec 2023 23:19:09 +0100 Subject: [PATCH] Added documentation for `OpenApiAttribute` --- README.md | 2 +- rocket-okapi-codegen/src/openapi_attr/mod.rs | 2 ++ 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 5001f713..b619ce15 100644 --- a/README.md +++ b/README.md @@ -62,7 +62,7 @@ from most places, this includes: [see this example](https://github.com/GREsau/okapi/blob/master/examples/custom_schema/src/error.rs). Some more info can be provided using the `#[openapi(...)]` derive macro, for more info see: -[OpenApiAttribute](https://github.com/GREsau/okapi/blob/master/rocket-okapi-codegen/src/openapi_attr/mod.rs#L20). +[OpenApiAttribute](https://github.com/GREsau/okapi/blob/master/rocket-okapi-codegen/src/openapi_attr/mod.rs#L22). [Schemars][Schemars] also can be used to provide more info for objects that implement `#[derive(JsonSchema)]` using the `#[schemars(...)]` and `#[serde(...)]` syntax. diff --git a/rocket-okapi-codegen/src/openapi_attr/mod.rs b/rocket-okapi-codegen/src/openapi_attr/mod.rs index d84fe7c6..1e941bb9 100644 --- a/rocket-okapi-codegen/src/openapi_attr/mod.rs +++ b/rocket-okapi-codegen/src/openapi_attr/mod.rs @@ -15,6 +15,8 @@ use syn::{ PathSegment, ReturnType, Type, TypeTuple, }; +/// This structure documents all the properties that can be used in +/// the `#[openapi]` derive macro. for example: `#[openapi(tag = "Users")]` #[derive(Debug, Default, FromMeta)] #[darling(default)] struct OpenApiAttribute {