From de51a7833d9773511770c65ed5965734c1bf2929 Mon Sep 17 00:00:00 2001 From: Maikel Linke Date: Thu, 22 Jun 2023 11:16:57 +1000 Subject: [PATCH] Add script to swaggerize DFC API in its engine Rswag doesn't look for specs in engines by default. We haven't added any Rswag specs in the dfc_provider engine yet but that will come. The generated API schema has some superfluous whitespace removed due to a fix in the rswag gems. --- script/rswag | 6 ++++++ swagger/v1/swagger.yaml | 10 +++++----- 2 files changed, 11 insertions(+), 5 deletions(-) create mode 100755 script/rswag diff --git a/script/rswag b/script/rswag new file mode 100755 index 0000000000..52d7336a66 --- /dev/null +++ b/script/rswag @@ -0,0 +1,6 @@ +#!/usr/bin/env sh + +# Generate the API documentation based on our specs. +# +# The PATTERN argument is adding engines to the search path. +exec ./bin/rake rswag PATTERN="spec/requests/api/**/*_spec.rb,engines/dfc_provider/spec/requests/**/*_spec.rb" diff --git a/swagger/v1/swagger.yaml b/swagger/v1/swagger.yaml index 82ae1aab26..e59001ec0b 100644 --- a/swagger/v1/swagger.yaml +++ b/swagger/v1/swagger.yaml @@ -77,7 +77,7 @@ components: billing_address: type: object nullable: true - example: + example: shipping_address: type: object nullable: true @@ -190,7 +190,7 @@ components: billing_address: type: object nullable: true - example: + example: shipping_address: type: object nullable: true @@ -375,7 +375,7 @@ paths: billing_address: type: object nullable: true - example: + example: shipping_address: type: object nullable: true @@ -468,7 +468,7 @@ paths: billing_address: type: object nullable: true - example: + example: shipping_address: type: object nullable: true @@ -598,7 +598,7 @@ paths: billing_address: type: object nullable: true - example: + example: shipping_address: type: object nullable: true