From 3d2cc869e966e1bd6949aa8a63412750c6838026 Mon Sep 17 00:00:00 2001 From: "Vyacheslav N. Boyko" Date: Fri, 8 Apr 2022 10:48:07 +0300 Subject: [PATCH] added page async api --- .gitignore | 3 +++ README.md | 15 +++++++++++ waas-api.json => api/waas-api.json | 0 async-api/waas-async-api.yaml | 23 +++++++++++++++++ index.html | 41 +++++++++++++++++++++--------- update-api.sh | 1 + update-async-api.sh | 4 +++ update.sh | 1 - 8 files changed, 75 insertions(+), 13 deletions(-) rename waas-api.json => api/waas-api.json (100%) create mode 100644 async-api/waas-async-api.yaml create mode 100755 update-api.sh create mode 100755 update-async-api.sh delete mode 100644 update.sh diff --git a/.gitignore b/.gitignore index 59ce014..2d24213 100644 --- a/.gitignore +++ b/.gitignore @@ -1,5 +1,8 @@ +.idea /.idea/.gitignore /.idea/misc.xml /.idea/modules.xml /.idea/pf-waas-api.iml /.idea/vcs.xml +**.**~ +**.iml diff --git a/README.md b/README.md index fcddd91..9046f3d 100644 --- a/README.md +++ b/README.md @@ -1 +1,16 @@ # pf-waas-api + +## Обновление Async API + +### Предварительно установить библиотеку + +``` bash +npm install -g @asyncapi/html-template@0.16.0 +``` + +### Запустить пересборку HTML + +``` bash +cd async-api/site/ +ag ../waas-async-api.yaml @asyncapi/html-template +``` diff --git a/waas-api.json b/api/waas-api.json similarity index 100% rename from waas-api.json rename to api/waas-api.json diff --git a/async-api/waas-async-api.yaml b/async-api/waas-async-api.yaml new file mode 100644 index 0000000..ed5db5f --- /dev/null +++ b/async-api/waas-async-api.yaml @@ -0,0 +1,23 @@ +asyncapi: 2.3.0 +info: + title: Account Service + version: 1.0.0 + description: This service is in charge of processing user signups +channels: + card/authorization: + subscribe: + message: + $ref: '#/components/messages/UserSignedUp' +components: + messages: + UserSignedUp: + payload: + type: object + properties: + displayName: + type: string + description: Name of the user + email: + type: string + format: email + description: Email of the user \ No newline at end of file diff --git a/index.html b/index.html index a503589..9ab5a0b 100644 --- a/index.html +++ b/index.html @@ -1,11 +1,12 @@ - ReDoc + ProFee WAAS API +