Wardrobe
/
rediOps
mirror of https://github.com/meerkat-manor/rediOps.git
5
0
Fork 0
Code Issues Projects Releases Wiki Activity

Recognise server can be client

documentation
meerkat-manor 2023-08-02 23:07:38 +10:00
parent 6d82fc1723
commit 417ed7f7e4
3 changed files with 43 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/developer_client_start.md
View File

@ -101,7 +101,7 @@ sequenceDiagram
term -->- vsc: close term -->- vsc: close
rect grey rect lightgrey
Note over vsc, qaskx: Developer codes to use the OpenAPI definition, with base code in place Note over vsc, qaskx: Developer codes to use the OpenAPI definition, with base code in place
vsc -->> vsc: Code update vsc -->> vsc: Code update
vsc -->> vsc: Local build vsc -->> vsc: Local build

20
docs/developer_server_start.md
View File

@ -24,6 +24,9 @@ The assumptions for this documents are:
The sequence of automation activity using **devops** file and **qaskx-cli** is The sequence of automation activity using **devops** file and **qaskx-cli** is
as follows. as follows.
**A server can also be a consumer of other APIs in which case it needs to generate
when downstream API specifications client code.**
The Qaskx command line tool needs to be installed on the developer machine The Qaskx command line tool needs to be installed on the developer machine
```mermaid ```mermaid
@ -94,7 +97,22 @@ sequenceDiagram
qaskx -) devops: Auto update entries, including build, test qaskx -) devops: Auto update entries, including build, test
qaskx -->>- term: Success qaskx -->>- term: Success
rect grey opt
term ->>+ qaskx: Generate code
Note over qaskx, cmdb: qaskx-cli gen client cmd
qaskx ->>+ devops: Read dependency list
devops -->>- qaskx: Contents
loop Read called dependencies
qaskx ->>+ oas3f: Read dependency
oas3f -->>- qaskx: Contents
qaskx -) qaskx: Auto generate client code
end
qaskx -->>- term: Success
end
rect lightgrey
Note over vsc, qaskx: Developer codes to use the OpenAPI definition, with base code in place Note over vsc, qaskx: Developer codes to use the OpenAPI definition, with base code in place
vsc -->> vsc: Code update vsc -->> vsc: Code update
vsc -->> vsc: Local build vsc -->> vsc: Local build

22
docs/developer_update.md
View File

@ -45,6 +45,9 @@ sequenceDiagram
Once the OpenAPI definition has been updated the server code needs to be Once the OpenAPI definition has been updated the server code needs to be
re-generated as the publisher of the API. re-generated as the publisher of the API.
**A server can also be a consumer of other APIs in which case it needs updating
when downstream API specifications change.**
```mermaid ```mermaid
--- ---
title: Server development update task flow title: Server development update task flow
@ -84,9 +87,24 @@ sequenceDiagram
end end
qaskx -->>- term: Success qaskx -->>- term: Success
opt
term ->>+ qaskx: Generate code
Note over qaskx, cmdb: qaskx-cli gen client cmd
qaskx ->>+ devops: Read dependency list
devops -->>- qaskx: Contents
loop Read called dependencies
qaskx ->>+ oas3f: Read dependency
oas3f -->>- qaskx: Contents
qaskx -) qaskx: Auto generate client code
end
qaskx -->>- term: Success
end
term -->- vsc: close term -->- vsc: close
rect grey rect lightgrey
Note over vsc, qaskx: Code updates to use the updated OpenAPI definition Note over vsc, qaskx: Code updates to use the updated OpenAPI definition
vsc -->> vsc: Code update vsc -->> vsc: Code update
vsc -->> vsc: Local build vsc -->> vsc: Local build
@ -147,7 +165,7 @@ sequenceDiagram
term -->- vsc: close term -->- vsc: close
rect grey rect lightgrey
Note over vsc, qaskx: Code updates to use the updated OpenAPI definition Note over vsc, qaskx: Code updates to use the updated OpenAPI definition
vsc -->> vsc: Code update vsc -->> vsc: Code update
vsc -->> vsc: Local build vsc -->> vsc: Local build