Add warning on outdated docs for Tingle.AspNetCore.Swagger

tinglesoftware · Mar 19, 2024 · 7f9fe54 · 7f9fe54
1 parent 6318f23
commit 7f9fe54
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/src/Tingle.AspNetCore.Swagger/README.md b/src/Tingle.AspNetCore.Swagger/README.md
@@ -1,5 +1,10 @@
 # Tingle.AspNetCore.Swagger
 
+> [!CAUTION]
+> This documentation for `Tingle.AspNetCore.Swagger` may cover the mos recent version of the code. Use it sparingly
+> 
+> See https://github.com/tinglesoftware/dotnet-extensions/issues/221
+
 Swagger is a specification for documenting your API and specifies the format (URL, method, and representation) used to describe REST web services. This library is used to generate API documentation as well as add API documentation UI through ReDoc.
 
 The library includes the `Swashbuckle.AspNetCore.SwaggerGen` library which is a Swagger generator that builds the `SwaggerDocument` objects directly from your routes, controllers, and models. It is combined with the Swagger endpoint middleware to automatically expose Swagger JSON.