From eb8b0f121476b37eddbe62fac1844062a959a2ba Mon Sep 17 00:00:00 2001 From: Reinier Zwitserloot Date: Fri, 7 Apr 2023 20:34:49 +0200 Subject: [PATCH] [build] Turned it into a npm package. Run `npm start` to make HTML, `npm test` to lint. --- api/.gitignore | 1 + api/package.json | 14 ++++++++++++++ api/redocly.yaml | 13 +++++++++++++ api/{ui_api.swagger.yaml => zoo-api.yaml} | 2 +- 4 files changed, 29 insertions(+), 1 deletion(-) create mode 100644 api/.gitignore create mode 100644 api/package.json create mode 100644 api/redocly.yaml rename api/{ui_api.swagger.yaml => zoo-api.yaml} (99%) diff --git a/api/.gitignore b/api/.gitignore new file mode 100644 index 0000000..2fdb769 --- /dev/null +++ b/api/.gitignore @@ -0,0 +1 @@ +/zoo-api.html diff --git a/api/package.json b/api/package.json new file mode 100644 index 0000000..90365b3 --- /dev/null +++ b/api/package.json @@ -0,0 +1,14 @@ +{ + "name": "zoo-api", + "version": "1.0.0", + "dependencies": { + "@redocly/cli": "^1.0.0-beta" + }, + "private": true, + "scripts": { + "start": "npx @redocly/cli@^1.0.0-beta build-docs -o zoo-api.html", + "bundle": "npx @redocly/cli@^1.0.0-beta bundle -o dist.yaml", + "test": "npx @redocly/cli@^1.0.0-beta lint" + } +} + diff --git a/api/redocly.yaml b/api/redocly.yaml new file mode 100644 index 0000000..efc6c61 --- /dev/null +++ b/api/redocly.yaml @@ -0,0 +1,13 @@ +# see https://redocly.com/docs/cli/configuration/ +apis: + zoo-api@v1: + root: zoo-api.yaml +extends: + - recommended +rules: + no-unused-components: warn +theme: + openapi: + generateCodeSamples: + languages: + - lang: JavaScript diff --git a/api/ui_api.swagger.yaml b/api/zoo-api.yaml similarity index 99% rename from api/ui_api.swagger.yaml rename to api/zoo-api.yaml index f0739de..b8a5935 100644 --- a/api/ui_api.swagger.yaml +++ b/api/zoo-api.yaml @@ -503,7 +503,7 @@ components: schema: type: string example: >- - eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJraWQiOiJaT08tQVBJLVBLSS1JRCIsImFnYiI6IjAxMDEyMzQ1IiwiaWF0IjoxNTE2MjM5MDIyLCJqdGkiOiJ0MTIzNC01Njc4LUFCQ0QifQ.wTesCfFTq1Mz8z7hUWU6zzKSc3dopWnpeETR7eDzFtc + Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJraWQiOiJaT08tQVBJLVBLSS1JRCIsImFnYiI6IjAxMDEyMzQ1IiwiaWF0IjoxNTE2MjM5MDIyLCJqdGkiOiJ0MTIzNC01Njc4LUFCQ0QifQ.wTesCfFTq1Mz8z7hUWU6zzKSc3dopWnpeETR7eDzFtc responses: JwtFailure: