Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update readme #336

Merged
merged 1 commit into from
Feb 12, 2024
Merged

Update readme #336

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions spec/ExecutionAndTraceLog.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
version: 2.1.0

x-gui-paths:
########################################################################################################################

Check warning on line 7 in spec/ExecutionAndTraceLog.yaml

View workflow job for this annotation

GitHub Actions / YAML 

7:1 [comments-indentation] comment not indented like content
# Representation Layer
########################################################################################################################
/docs:
Expand All @@ -16,7 +16,7 @@
responses:
'200':
description: 'Swagger API description page represented'
# Not explixitly described

Check warning on line 19 in spec/ExecutionAndTraceLog.yaml

View workflow job for this annotation

GitHub Actions / YAML 

19:13 [comments-indentation] comment not indented like content
'400':
$ref: '#/components/responses/responseForErroredOamRequests'
'401':
Expand All @@ -31,7 +31,7 @@
$ref: '#/components/responses/responseForErroredOamRequests'

paths:
########################################

Check warning on line 34 in spec/ExecutionAndTraceLog.yaml

View workflow job for this annotation

GitHub Actions / YAML 

34:1 [comments-indentation] comment not indented like content
# Service Layer - Individual Part
########################################
/v1/bequeath-your-data-and-die:
Expand Down Expand Up @@ -165,7 +165,7 @@
$ref: '#/components/responses/responseForErroredServiceRequests'
callbacks:
PromptForBequeathingDataCausesTransferOfListOfApplications:
url: #[/core-model-1-4:control-construct/logical-termination-point=eatl-2-1-0-tcp-c-nr-2-1-0-000/layer-protocol=0/tcp-client-interface-1-0:tcp-client-interface-pac/tcp-client-interface-configuration/remote-protocol]://[/core-model-1-4:control-construct/logical-termination-point=eatl-2-1-0-tcp-c-nr-2-1-0-000/layer-protocol=0/tcp-client-interface-1-0:tcp-client-interface-pac/tcp-client-interface-configuration/remote-address/domain-name or /core-model-1-4:control-construct/logical-termination-point=eatl-2-1-0-tcp-c-nr-2-1-0-000/layer-protocol=0/tcp-client-interface-1-0:tcp-client-interface-pac/tcp-client-interface-configuration/remote-address/ip-address/ipv-4-address]:[/core-model-1-4:control-construct/logical-termination-point=eatl-2-1-0-tcp-c-nr-2-1-0-000/layer-protocol=0/tcp-client-interface-1-0:tcp-client-interface-pac/tcp-client-interface-configuration/remote-port][/core-model-1-4:control-construct/logical-termination-point=eatl-2-1-0-op-c-im-nr-2-1-0-000/layer-protocol=0/operation-client-interface-1-0:operation-client-interface-pac/operation-client-interface-configuration/operation-name]

Check warning on line 168 in spec/ExecutionAndTraceLog.yaml

View workflow job for this annotation

GitHub Actions / YAML 

168:16 [comments] too few spaces before comment

Check warning on line 168 in spec/ExecutionAndTraceLog.yaml

View workflow job for this annotation

GitHub Actions / YAML 

168:17 [comments] missing starting space in comment
post:
parameters:
- $ref: '#/components/parameters/user'
Expand Down Expand Up @@ -274,7 +274,7 @@
default:
$ref: '#/components/responses/responseForErroredServiceRequests'
PromptForBequeathingDataCausesRequestForBroadcastingInfoAboutServerReplacement:
url: #[/core-model-1-4:control-construct/logical-termination-point=eatl-2-1-0-tcp-c-ro-2-1-0-000/layer-protocol=0/tcp-client-interface-1-0:tcp-client-interface-pac/tcp-client-interface-configuration/remote-protocol]://[/core-model-1-4:control-construct/logical-termination-point=eatl-2-1-0-tcp-c-ro-2-1-0-000/layer-protocol=0/tcp-client-interface-1-0:tcp-client-interface-pac/tcp-client-interface-configuration/remote-address/domain-name or /core-model-1-4:control-construct/logical-termination-point=eatl-2-1-0-tcp-c-ro-2-1-0-000/layer-protocol=0/tcp-client-interface-1-0:tcp-client-interface-pac/tcp-client-interface-configuration/remote-address/ip-address/ipv-4-address]:[/core-model-1-4:control-construct/logical-termination-point=eatl-2-1-0-tcp-c-ro-2-1-0-000/layer-protocol=0/tcp-client-interface-1-0:tcp-client-interface-pac/tcp-client-interface-configuration/remote-port][/core-model-1-4:control-construct/logical-termination-point=eatl-2-1-0-op-c-bm-ro-2-1-0-001/layer-protocol=0/operation-client-interface-1-0:operation-client-interface-pac/operation-client-interface-configuration/operation-name]

Check warning on line 277 in spec/ExecutionAndTraceLog.yaml

View workflow job for this annotation

GitHub Actions / YAML 

277:16 [comments] too few spaces before comment

Check warning on line 277 in spec/ExecutionAndTraceLog.yaml

View workflow job for this annotation

GitHub Actions / YAML 

277:17 [comments] missing starting space in comment
post:
parameters:
- $ref: '#/components/parameters/user'
Expand Down Expand Up @@ -387,7 +387,7 @@
default:
$ref: '#/components/responses/responseForErroredServiceRequests'
PromptForBequeathingDataCausesRequestForDeregisteringOfOldRelease:
url: #[/core-model-1-4:control-construct/logical-termination-point=eatl-2-1-0-tcp-c-ro-2-1-0-000/layer-protocol=0/tcp-client-interface-1-0:tcp-client-interface-pac/tcp-client-interface-configuration/remote-protocol]://[/core-model-1-4:control-construct/logical-termination-point=eatl-2-1-0-tcp-c-ro-2-1-0-000/layer-protocol=0/tcp-client-interface-1-0:tcp-client-interface-pac/tcp-client-interface-configuration/remote-address/domain-name or /core-model-1-4:control-construct/logical-termination-point=eatl-2-1-0-tcp-c-ro-2-1-0-000/layer-protocol=0/tcp-client-interface-1-0:tcp-client-interface-pac/tcp-client-interface-configuration/remote-address/ip-address/ipv-4-address]:[/core-model-1-4:control-construct/logical-termination-point=eatl-2-1-0-tcp-c-ro-2-1-0-000/layer-protocol=0/tcp-client-interface-1-0:tcp-client-interface-pac/tcp-client-interface-configuration/remote-port][/core-model-1-4:control-construct/logical-termination-point=eatl-2-1-0-op-c-bm-ro-2-1-0-002/layer-protocol=0/operation-client-interface-1-0:operation-client-interface-pac/operation-client-interface-configuration/operation-name]

Check warning on line 390 in spec/ExecutionAndTraceLog.yaml

View workflow job for this annotation

GitHub Actions / YAML 

390:16 [comments] too few spaces before comment

Check warning on line 390 in spec/ExecutionAndTraceLog.yaml

View workflow job for this annotation

GitHub Actions / YAML 

390:17 [comments] missing starting space in comment
post:
parameters:
- $ref: '#/components/parameters/user'
Expand Down Expand Up @@ -459,7 +459,7 @@
default:
$ref: '#/components/responses/responseForErroredServiceRequests'
PromptingNewReleaseForUpdatingServerCausesRequestForBroadcastingInfoAboutBackwardCompatibleUpdateOfOperation:
url: #[/core-model-1-4:control-construct/logical-termination-point=eatl-2-1-0-tcp-c-ro-2-1-0-000/layer-protocol=0/tcp-client-interface-1-0:tcp-client-interface-pac/tcp-client-interface-configuration/remote-protocol]://[/core-model-1-4:control-construct/logical-termination-point=eatl-2-1-0-tcp-c-ro-2-1-0-000/layer-protocol=0/tcp-client-interface-1-0:tcp-client-interface-pac/tcp-client-interface-configuration/remote-address/domain-name or /core-model-1-4:control-construct/logical-termination-point=eatl-2-1-0-tcp-c-ro-2-1-0-000/layer-protocol=0/tcp-client-interface-1-0:tcp-client-interface-pac/tcp-client-interface-configuration/remote-address/ip-address/ipv-4-address]:[/core-model-1-4:control-construct/logical-termination-point=eatl-2-1-0-tcp-c-ro-2-1-0-000/layer-protocol=0/tcp-client-interface-1-0:tcp-client-interface-pac/tcp-client-interface-configuration/remote-port][/core-model-1-4:control-construct/logical-termination-point=eatl-2-1-0-op-c-bm-ro-2-1-0-003/layer-protocol=0/operation-client-interface-1-0:operation-client-interface-pac/operation-client-interface-configuration/operation-name]

Check warning on line 462 in spec/ExecutionAndTraceLog.yaml

View workflow job for this annotation

GitHub Actions / YAML 

462:16 [comments] too few spaces before comment
description: >
'This callback belongs to the sequence of actions that have to be done during the bequeath-your-data-and-die process, despite the forwarding gets neither managed nor directly initiated by the /v1/bequeath-your-data-and-die request.
After consuming applications have been redirected to the new release, the new release is triggered (this callback) to request the RegistryOffice for broadcasting information about backward compatible replacements of services.'
Expand Down Expand Up @@ -665,6 +665,7 @@
- 'EATL_ALT_UNKNOWN'
- 'EATL_NOT_REACHABLE'
- 'EATL_UNKNOWN'
- 'EATL_MAXIMUM_WAIT_TIME_TO_RECEIVE_OPERATION_KEY_EXCEEDED'
description: 'Reasons provided by ALT to be pre-fixed with EATL_. If (NOT (200 OR 204)) respond EATL_NOT_REACHABLE'
examples:
if-successful:
Expand Down
3 changes: 3 additions & 0 deletions spec/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
# ExecutionAndTraceLog Specification

### Diagrams
- [Collection of Diagrams](./diagrams)

### ServiceList
- [ExecutionAndTraceLog+services](./ExecutionAndTraceLog+services.yaml)

Expand Down
6 changes: 6 additions & 0 deletions spec/diagrams/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# ExecutionAndTraceLog Diagrams
.
.
![RegardApplicationCausesSequenceForInquiringServiceRecords](./is001_RegardApplicationCausesSequenceForInquiringServiceRecords.png)
.
.
28 changes: 18 additions & 10 deletions spec/diagrams/is001_RegardApplicationCausesSequenceForInquiringServiceRecords.plantuml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
skinparam responseMessageBelowArrow true

title
is001_RegardApplicationCausesSequenceForInquiringServiceRecords
RegardApplicationCausesSequenceForInquiringServiceRecords
end title

participant "RO" as ro
Expand Down Expand Up @@ -52,7 +52,7 @@ eatlRegardApplication <-- altAddOperClient2Link : {client-successfully-added, re
note left eatlRegardApplication
IF (NOT 200) OR (client-successfully-added==false)
end note
ro <-- eatlRegardApplication : { successfully-connected==false, reason-of-failure}
ro <-- eatlRegardApplication : { successfully-connected==false, reason-of-failure }

note over eatlRegardApplication
ELSE
Expand All @@ -78,7 +78,11 @@ eatlUpdateOperationKey -[#Grey]> eatlRegardApplication : Internally informs abou
note left eatlRegardApplication #Orange
IF waiting > maximumWaitTimeToReceiveOperationKey
end note
ro <-- eatlRegardApplication : { successfully-connected==false, reason-of-failure}
ro <-- eatlRegardApplication : { successfully-connected==false, reason-of-failure }

note over eatlRegardApplication
ELSE
end note

note over eatlRegardApplication
After receiving an updated operation-key
Expand All @@ -96,7 +100,7 @@ eatlRegardApplication <-- newAppRedirectSerReqInfo : responseCode : 204
note left eatlRegardApplication
IF (NOT 204)
end note
ro <-- eatlRegardApplication : { successfully-connected==false, reason-of-failure}
ro <-- eatlRegardApplication : { successfully-connected==false, reason-of-failure }

note over eatlRegardApplication
ELSE
Expand Down Expand Up @@ -159,7 +163,7 @@ newApplication => EaTL://v1/record-service-request
end note

eatlRegardApplication -> altAddOperClient2Link : { servingApplicationName == ExecutionAndTraceLog,\n servingApplicationReleaseNumber == 2.1.0,\n operationName == /v1/record-service-request,\n consumingApplicationName == requestBody.newApplicationName,\n consumingApplicationReleaseNumber == requestBody.releaseNumber } (apiKey)
eatlRegardApplication <-- altAddOperClient2Link : {client-successfully-added, reason-of-failure}
eatlRegardApplication <-- altAddOperClient2Link : {client-successfully-added, reason-of-failure }

note left eatlRegardApplication #Orange
IF ( (attempts<=maximumNumberOfAttemptsToCreateLink)
Expand All @@ -179,7 +183,7 @@ end note
note left eatlRegardApplication
IF (NOT 200) OR (client-successfully-added==false)
end note
ro <-- eatlRegardApplication : { successfully-connected==false, reason-of-failure}
ro <-- eatlRegardApplication : { successfully-connected==false, reason-of-failure }

note over eatlRegardApplication
ELSE
Expand All @@ -192,9 +196,9 @@ end note
altAddOperClient2Link -> okmRegardUpdatedLink

note over okmRegardUpdatedLink
OKM generates new operation-key and it will
try to set the new operation-key to the
client application (NewApplication) and the
OKM generates new operation-key and it will
try to set the new operation-key to the
client application (NewApplication) and the
serving application (ExecutionAndTraceLog)
end note

Expand All @@ -205,7 +209,11 @@ eatlUpdateOperationKey -[#Grey]> eatlRegardApplication : Internally informs abou
note left eatlRegardApplication #Orange
IF waiting > maximumWaitTimeToReceiveOperationKey
end note
ro <-- eatlRegardApplication : { successfully-connected==false, reason-of-failure}
ro <-- eatlRegardApplication : { successfully-connected==false, reason-of-failure }

note over eatlRegardApplication
ELSE
end note

note over eatlRegardApplication
After receiving an updated operation-key
Expand Down
Binary file modified spec/diagrams/is001_RegardApplicationCausesSequenceForInquiringServiceRecords.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading