From fc3226d08a9e6a2f3b749e657c8a102f947af69c Mon Sep 17 00:00:00 2001 From: Pat Losoponkul Date: Fri, 21 Apr 2023 16:40:02 +0700 Subject: [PATCH] docs: add linting doc --- docs/guides/linting.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/docs/guides/linting.md b/docs/guides/linting.md index 79f0b68500..697aea4815 100644 --- 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.