docs: add linting doc

hyperledger · Apr 21, 2023 · fc3226d · fc3226d
1 parent 968e71a
commit fc3226d
Showing 1 changed file with 16 additions and 0 deletions.
diff --git a/docs/guides/linting.md b/docs/guides/linting.md
@@ -285,3 +285,19 @@ Linter - Suggested Change: Enabled but pass even with error
 *Change detail*
 
 OPENAPI_SPECTRAL generates lots of errors for files which are quite large and have been generated by the openapi generator which is going to be replaced with Tapir in future work. Suggest change to enable but pass even with error. Can be re enabled when files can be reviewed as a specific task / they get removed
+
+---
+
+Date Added: 2023-04-21
+
+Author: Pat Losoponkul
+
+Date Actioned: 2023-04-21
+
+Linter - Current Status: Customise
+
+*Change detail*
+
+`tapir-generated.yaml` is added to the repository to be included in the OAS definitions.
+The linter is giving too many errors that are blocking the necessary change to be made.
+Once migrated to Tapir, we should revisit the proper OAS generation using Tapir.