From 1d5cd12ea24607a3be9a0358d4428f1d6e7f92a6 Mon Sep 17 00:00:00 2001 From: John Chilton Date: Mon, 12 Dec 2022 19:05:38 -0500 Subject: [PATCH] Do not OpenAPI schema lint for operation-4xx-response. We have good infrastructure for error handling in the API and it could be improved in many ways - but I don't think keeping a list of exclusions is helpful. This is just going to get in the way and encourage unhelpful boilerplate IMO. This is the equivalent of Java checked exceptions - a bad idea. xref: https://redocly.com/docs/cli/rules/operation-4xx-response/ --- .redocly.lint-ignore.yaml | 12 ------------ .redocly.yaml | 5 +++++ 2 files changed, 5 insertions(+), 12 deletions(-) create mode 100644 .redocly.yaml diff --git a/.redocly.lint-ignore.yaml b/.redocly.lint-ignore.yaml index 1e90c28250ea..c1e0cd37d820 100644 --- a/.redocly.lint-ignore.yaml +++ b/.redocly.lint-ignore.yaml @@ -27,18 +27,6 @@ _schema.json: #/paths/~1api~1dataset_collections~1{id}~1prepare_download/post/parameters/0/name - >- #/paths/~1api~1histories~1{history_id}~1contents~1archive~1{id}/get/parameters - operation-4xx-response: - - '#/paths/~1api~1datatypes~1converters/get/responses' - - '#/paths/~1api~1datatypes~1edam_data/get/responses' - - '#/paths/~1api~1datatypes~1edam_data~1detailed/get/responses' - - '#/paths/~1api~1datatypes~1edam_formats/get/responses' - - '#/paths/~1api~1datatypes~1edam_formats~1detailed/get/responses' - - '#/paths/~1api~1datatypes~1mapping/get/responses' - - '#/paths/~1api~1datatypes~1sniffers/get/responses' - - '#/paths/~1api~1licenses/get/responses' - - '#/paths/~1api~1tours/get/responses' - - '#/paths/~1api~1version/get/responses' - - '#/paths/~1ga4gh~1drs~1v1~1service-info/get/responses' security-defined: - '#/paths/~1api~1datatypes/get' - '#/paths/~1api~1datatypes~1converters/get' diff --git a/.redocly.yaml b/.redocly.yaml new file mode 100644 index 000000000000..15897fe5d315 --- /dev/null +++ b/.redocly.yaml @@ -0,0 +1,5 @@ +organization: galaxyproject.org +extends: + - recommended +rules: + operation-4xx-response: off