qaskx
/
qaskx.template
6
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Adding API templates

main
Tom Peltonen 2025-06-28 14:58:39 +10:00
parent b002754c06
commit 5f4efdad3a
7 changed files with 173 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
api/alternative/default.json 100644
View File

@ -0,0 +1,20 @@
{
"name": "default",
"guide": "{{.SelfFolder}}/errm01.md",
"description": "Default error model",
"templates": [
{
"engine": "",
"folder": "{{.SelfFolder}}/definitions/{{.TemplateName}}",
"file_name": "error-model.tmpl",
"output_folder": "",
"output_name": "",
"section": "",
"model": {
"activity": {
"category": "OTHER"
}
}
}
]
}

52
api/alternative/default/definitions/error-model.tmpl 100644
View File

@ -0,0 +1,52 @@
# Sequence diagram
This represents the sequence diagram for
service names {{ range .ServiceNames}}**{{.}}** {{ end }}
```mermaid
sequenceDiagram
participant consumer as Consumer
participant gateway as Gateway
participant microservice as ServiceName
participant feature as Svc Feature
participant authz as Authorisation
participant log as Logger
{{ range .Apis}}participant {{ .Name }} as Svc{{ .Name }}
{{ end }}
consumer->>+gateway: {{.ServicePoints}}
activate consumer
note right of gateway: Authentication check at GW
gateway->>+microservice: {{.ServicePoints}}
microservice->>+authz: Validate requestor
note right of authz: Authorise to function
authz-->>-microservice: 200 or 401/403 status
microservice->>+feature: Check feature switch
feature-->>-microservice: 200 or 401/403 status
microservice-)log: log request/response
{{ range .Apis}}
microservice-->>+{{ .Name }}: link {{ .Url }}
note right of {{ .Name }}: Explanation of what happens
{{ .Name }}-->>-microservice: 200 OK response
{{ end }}
alt 200 OK
microservice-->>gateway: 200 OK response
gateway-->>consumer: 200 OK response
else not OK, error
microservice-->>-gateway: !200 ERR response
gateway-->>-consumer: !200 ERR response
end
deactivate consumer
```
***Note***: Adjust the default sequence diagram above
Copyright {{.QaskxDot.ServiceOwner}}
Contact {{.QaskxDot.ServiceOwnerEmail}}

20
api/alternative/error-model.json 100644
View File

@ -0,0 +1,20 @@
{
"name": "error-model",
"guide": "{{.SelfFolder}}/error-model.md",
"description": "Default error model",
"templates": [
{
"engine": "",
"folder": "{{.SelfFolder}}/definitions/{{.TemplateName}}",
"file_name": "error-model.tmpl",
"output_folder": "",
"output_name": "",
"section": "",
"model": {
"activity": {
"category": "OTHER"
}
}
}
]
}

6
api/alternative/error-model/definitions/error-model.tmpl 100644
View File

@ -0,0 +1,6 @@
{
"description": "Standard error model",
"example": 25,
"format": "integer",
"type": "number"
}

20
api/default/error-model.json 100644
View File

@ -0,0 +1,20 @@
{
"name": "error-model",
"guide": "{{.SelfFolder}}/error-model.md",
"description": "Default error model",
"templates": [
{
"engine": "",
"folder": "{{.SelfFolder}}/{{.TemplateName}}/definitions",
"file_name": "error-model.tmpl",
"output_folder": "",
"output_name": "",
"section": "",
"model": {
"activity": {
"category": "OTHER"
}
}
}
]
}

6
api/default/error-model/error-model.json → api/error-model/error-model.json
View File

@ -1,5 +1,5 @@
{
"name": "errm01",
"name": "error-model",
"guide": "{{.SelfFolder}}/errm01.md",
"description": "Default error model",
"templates": [
@ -7,8 +7,8 @@
"engine": "",
"folder": "{{.SelfFolder}}/definitions/{{.TemplateName}}",
"file_name": "error-model.tmpl",
"output_folder": "^/docsxxx",
"output_name": "seqdgm01.md",
"output_folder": "",
"output_name": "",
"section": "",
"model": {
"activity": {

52
api/error-model/error-model/definitions/error-model.tmpl 100644
View File

@ -0,0 +1,52 @@
# Sequence diagram
This represents the sequence diagram for
service names {{ range .ServiceNames}}**{{.}}** {{ end }}
```mermaid
sequenceDiagram
participant consumer as Consumer
participant gateway as Gateway
participant microservice as ServiceName
participant feature as Svc Feature
participant authz as Authorisation
participant log as Logger
{{ range .Apis}}participant {{ .Name }} as Svc{{ .Name }}
{{ end }}
consumer->>+gateway: {{.ServicePoints}}
activate consumer
note right of gateway: Authentication check at GW
gateway->>+microservice: {{.ServicePoints}}
microservice->>+authz: Validate requestor
note right of authz: Authorise to function
authz-->>-microservice: 200 or 401/403 status
microservice->>+feature: Check feature switch
feature-->>-microservice: 200 or 401/403 status
microservice-)log: log request/response
{{ range .Apis}}
microservice-->>+{{ .Name }}: link {{ .Url }}
note right of {{ .Name }}: Explanation of what happens
{{ .Name }}-->>-microservice: 200 OK response
{{ end }}
alt 200 OK
microservice-->>gateway: 200 OK response
gateway-->>consumer: 200 OK response
else not OK, error
microservice-->>-gateway: !200 ERR response
gateway-->>-consumer: !200 ERR response
end
deactivate consumer
```
***Note***: Adjust the default sequence diagram above
Copyright {{.QaskxDot.ServiceOwner}}
Contact {{.QaskxDot.ServiceOwnerEmail}}