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.

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

#152 Add discovery proxy transactions scaffold and actor description.… #303

Merged
merged 1 commit into from
Sep 3, 2024

Conversation

ToddCooper
Copy link
Collaborator

… (#300)

Initial updates to add a transaction name to the TF-0 Transactions listing + the SDPi-P Actor model update & transaction table update & placeholder for the DP option description section.

Updated DP TF-1 content, specifically to the SDPi-P transaction table, the Actors and Options section (with its own table) and the Discovery Proxy Option section.

Content is rough but sufficient for discussion.

  • Updated Sequence Diagram & Actor Diagram

Sequence Diagram - added secure groupings for all transactions Actor Diagram - simplified to "Discovery Proxy"
Updated Change Log with #152 addition
A fix to the TF-1 SDPiP Transactions table to re-enable rendering of the end notes ... hopefully!

  • Trying to Fix SDPi-P Transaction Table Notes

Notes are not appearing on last row of the transaction table. Also changed the note numbering based on order from the top of the table.

  • Fixed SDPi-P Transactions Table Notes

Found the extra vertical bar!

  • Updated DP Transaction Names & PUML Diagram Titles & SDPi Transaction Table Updates

  • Removed "SDPi" from many of the TF-2 transaction sequence diagram titles - transactions are not profile specific

  • Refactored DEV-46 and DEV-47 transaction names + reference label text

  • changed the DP transactions in the SDPi-P Actors & Transactions table to "O" vs. "C"

  • Integrated comments from David's review of the option bullets

  • Commented out the version text box from the options section but in the comments kept the potential future options,.

  • Updated TF-1 DP Option Text

Converted the bulleted content into something readable and (generally) tagged.

Left over changes

  • Editorial Updates based on review & DCC discussion

Numerous updates including ...

  • removing "SOMDS" from "Discovery Proxy" actor name

  • Discovery Proxy actor brief description more generic

  • Use of "Transaction" for a specific transaction now uppercase "T"

  • Managed Discovery Option renamed (from Discovery Proxy Option)

  • Added "heartbeat" requirement for DP as part of managed discovery behaviour Others ...

  • Fixed PUML file name error

Refactoring PUML file name inserted a space in the file name ... !

  • Fixed another file name error

Or didn't fix it previously?

  • Highlighted "shall" statements for review & requirements block addition

#shall# added in option block to ensure review and either rewording, removal, or requirements block addition

  • Updates to Discovery Proxy Option & DEV-47 Title

Changed include:

  • Reset "Transaction" to lowercase "transaction" per guidance from Mary J.

  • Simplified DEV-47 to "Retrieve Network Presence", leaving off "Metadata"

  • Added requirements blocks for the option "shall" statements

  • Transaction Description Updates + MD Option Updates

  • Updated DEV-46 & DEV-47 transaction summaries to match the updated transaction names

  • Added as a test, additional requirement metadata to the MD Option section

  • Changed the arrow direction of the Bye() message for DEV-47

  • Test of Inter-Requirement Links

Added forward / backward requirement anchor references to R1023. fingers crossed

  • Tweak update because workflow automation failed

2nd try at triggering build workflow

  • Updates from SDPi Friday Review

Updates from review corrections.


📑 Description

☑ Mandatory Tasks

The following aspects have been respected by the pull request assignee and at least one reviewer:

  • Changelog update (necessity checked and entry added or not added respectively)
    • Pull Request Assignee
    • Reviewer

…#300)

* #152 Add discovery proxy transactions scaffold and actor description.

* #152 Add more content; add ack message to transaction sequence.

* #152 Tweak register message text

* #152 Add DEV-47, apply tweaks von DEV-46

* #152 Add DEV-47 probe and resolve

* #152 Various fixes

* #152 Various fixes

* #152 Add MDPWS binding contents for DEV-46

* #152 Add MDPWS binding contents for DEV-47; minor fixes to adhoc message excerpts

* #152 Add MDPWS binding contents to outline.

* #152 Fixes to DEV-47

* #152 Fixes to DEV-47

* Fix yml to use new versions of github action plugins

* Fix yml to use new versions of github action plugins

* #152 Update references to DEV-47 outlines

* Replace gradle-build-action with newer setup-gradle

* #152 Add discovery proxy sources and additional chapter

* Change path of setup-gradle@v3

* Use setup-gradle@v4

* Use setup-gradle@v4

* Use setup-gradle@v4

* #152 Fix findings

* DP Updates to TF-0 & TF-1 - Initial

Initial updates to add a transaction name to the TF-0 Transactions listing + the SDPi-P Actor model update & transaction table update & placeholder for the DP option description section.

* #152 Add discovery proxy basic sequence diagram

* #152 Enrich OID table caption in the discovery proxy section

* TF-1 Updates

Updated DP TF-1 content, specifically to the SDPi-P transaction table, the Actors and Options section (with its own table) and the Discovery Proxy Option section.

Content is rough but sufficient for discussion.

* Updated Sequence Diagram & Actor Diagram

Sequence Diagram - added secure groupings for all transactions
Actor Diagram - simplified to "Discovery Proxy"
Updated Change Log with #152 addition
A fix to the TF-1 SDPiP Transactions table to re-enable rendering of the end notes ... hopefully!

* Trying to Fix SDPi-P Transaction Table Notes

Notes are not appearing on last row of the transaction table.
Also changed the note numbering based on order from the top of the table.

* Fixed SDPi-P Transactions Table Notes

Found the extra vertical bar!

* Updated DP Transaction Names & PUML Diagram Titles & SDPi Transaction Table Updates

* Removed "SDPi" from many of the TF-2 transaction sequence diagram titles - transactions are not profile specific

* Refactored DEV-46 and DEV-47 transaction names + reference label text

* changed the DP transactions in the SDPi-P Actors & Transactions table to "O" vs. "C"

* Integrated comments from David's review of the option bullets

* Commented out the version text box from the options section but in the comments kept the potential future options,.

* Updated TF-1 DP Option Text

Converted the bulleted content into something readable and (generally) tagged.

* #152 Fix formatting

* #152 Fix formatting

* #152 Try to fix wrong directory for PUML includes in CI

* #152 Minor fixes

* #152 Add more space to images, tables and listings.

* Changed "SOMDS Discovery Proxy" to "Discovery Proxy"

Left over changes

* Editorial Updates based on review & DCC discussion

Numerous updates including ...
* removing "SOMDS" from "Discovery Proxy" actor name
* Discovery Proxy actor brief description more generic
* Use of "Transaction" for a specific transaction now uppercase "T"
* Managed Discovery Option renamed (from Discovery Proxy Option)
* Added "heartbeat" requirement for DP as part of managed discovery behaviour
Others ...

* Fixed PUML file name error

Refactoring PUML file name inserted a space in the file name ... !

* Fixed another file name error

Or didn't fix it previously?

* Highlighted "shall" statements for review & requirements block addition

#shall# added in option block to ensure review and either rewording, removal, or requirements block addition

* Updates to Discovery Proxy Option & DEV-47 Title

Changed include:
* Reset "Transaction" to lowercase "transaction" per guidance from Mary J.
* Simplified DEV-47 to "Retrieve Network Presence", leaving off "Metadata"
* Added requirements blocks for the option "shall" statements

* Transaction Description Updates + MD Option Updates

* Updated DEV-46 & DEV-47 transaction summaries to match the updated transaction names
* Added as a test, additional requirement metadata to the MD Option section
* Changed the arrow direction of the Bye() message for DEV-47

* Test of Inter-Requirement Links

Added forward / backward requirement anchor references to R1023.  fingers crossed

* Tweak update because workflow automation failed

2nd try at triggering build workflow

* Updates from SDPi Friday Review

Updates from review corrections.

---------

Co-authored-by: Todd "AFC!" Cooper <[email protected]>
@ToddCooper
Copy link
Collaborator Author

@kenjfuchs -- I just want to get the master updates into the r1.4 requirements interoperability branch.

@ToddCooper ToddCooper self-assigned this Sep 3, 2024
@ToddCooper ToddCooper marked this pull request as ready for review September 3, 2024 23:16
@ToddCooper ToddCooper merged commit 6ad30b5 into 299-sdpi-ri-for-r14 Sep 3, 2024
2 checks passed
ToddCooper added a commit that referenced this pull request Sep 17, 2024
* Initial Requirements Glossary Allocation

Created place holder for the requirements glossary in the specification introduction section.

* TF-1C Requirements Model Update

Updated the core requirements model (added IHE Profile) and some of the text in the subsequent table.

* Updated requirement type documentation

Incremental updates to the requirement documentation for IHE Profile & Tech Feature

* TF-1A Initial Cleanup & Extension

Changes include:
1) removed editors note at top of appendix - no longer relevant
2) added descriptive detail to the hanging gardens model
3) added detail to the core requirements model & elements
4) "cleaned up" other areas that were either stale (deleted) or were incomplete

* RI Metadata Test (links + JSON)

Testing both linking requirements from one AsciiDoc file to another AND documenting content export to JSON.

* Fixed Test Requirement Documentation

that was misinterpreted by the converter tool

* Fix Try #2

Commented out most everything

* Fix Try #3

remove reference to requirement in other file

* Fix #4 ... removed ALL requirement test section

Start from scratch

* Fix #5 test

Duplicated MDPWS requirement ... changed number ... work?

* Fix #6 Test - Additional Metadata

Added in the profile AIPO metadata

* Fix #7 updated core text

note and simple requirement test content

* Fix #8 - Added "shall" keyword

into the requirement block text

* Test #9 - added R0500 Link

from TF-1A to TF-2A

* #152 Add discovery proxy transactions scaffold and actor description. (#300) (#303)

* #152 Add discovery proxy transactions scaffold and actor description.

* #152 Add more content; add ack message to transaction sequence.

* #152 Tweak register message text

* #152 Add DEV-47, apply tweaks von DEV-46

* #152 Add DEV-47 probe and resolve

* #152 Various fixes

* #152 Various fixes

* #152 Add MDPWS binding contents for DEV-46

* #152 Add MDPWS binding contents for DEV-47; minor fixes to adhoc message excerpts

* #152 Add MDPWS binding contents to outline.

* #152 Fixes to DEV-47

* #152 Fixes to DEV-47

* Fix yml to use new versions of github action plugins

* Fix yml to use new versions of github action plugins

* #152 Update references to DEV-47 outlines

* Replace gradle-build-action with newer setup-gradle

* #152 Add discovery proxy sources and additional chapter

* Change path of setup-gradle@v3

* Use setup-gradle@v4

* Use setup-gradle@v4

* Use setup-gradle@v4

* #152 Fix findings

* DP Updates to TF-0 & TF-1 - Initial

Initial updates to add a transaction name to the TF-0 Transactions listing + the SDPi-P Actor model update & transaction table update & placeholder for the DP option description section.

* #152 Add discovery proxy basic sequence diagram

* #152 Enrich OID table caption in the discovery proxy section

* TF-1 Updates

Updated DP TF-1 content, specifically to the SDPi-P transaction table, the Actors and Options section (with its own table) and the Discovery Proxy Option section.

Content is rough but sufficient for discussion.

* Updated Sequence Diagram & Actor Diagram

Sequence Diagram - added secure groupings for all transactions
Actor Diagram - simplified to "Discovery Proxy"
Updated Change Log with #152 addition
A fix to the TF-1 SDPiP Transactions table to re-enable rendering of the end notes ... hopefully!

* Trying to Fix SDPi-P Transaction Table Notes

Notes are not appearing on last row of the transaction table.
Also changed the note numbering based on order from the top of the table.

* Fixed SDPi-P Transactions Table Notes

Found the extra vertical bar!

* Updated DP Transaction Names & PUML Diagram Titles & SDPi Transaction Table Updates

* Removed "SDPi" from many of the TF-2 transaction sequence diagram titles - transactions are not profile specific

* Refactored DEV-46 and DEV-47 transaction names + reference label text

* changed the DP transactions in the SDPi-P Actors & Transactions table to "O" vs. "C"

* Integrated comments from David's review of the option bullets

* Commented out the version text box from the options section but in the comments kept the potential future options,.

* Updated TF-1 DP Option Text

Converted the bulleted content into something readable and (generally) tagged.

* #152 Fix formatting

* #152 Fix formatting

* #152 Try to fix wrong directory for PUML includes in CI

* #152 Minor fixes

* #152 Add more space to images, tables and listings.

* Changed "SOMDS Discovery Proxy" to "Discovery Proxy"

Left over changes

* Editorial Updates based on review & DCC discussion

Numerous updates including ...
* removing "SOMDS" from "Discovery Proxy" actor name
* Discovery Proxy actor brief description more generic
* Use of "Transaction" for a specific transaction now uppercase "T"
* Managed Discovery Option renamed (from Discovery Proxy Option)
* Added "heartbeat" requirement for DP as part of managed discovery behaviour
Others ...

* Fixed PUML file name error

Refactoring PUML file name inserted a space in the file name ... !

* Fixed another file name error

Or didn't fix it previously?

* Highlighted "shall" statements for review & requirements block addition

#shall# added in option block to ensure review and either rewording, removal, or requirements block addition

* Updates to Discovery Proxy Option & DEV-47 Title

Changed include:
* Reset "Transaction" to lowercase "transaction" per guidance from Mary J.
* Simplified DEV-47 to "Retrieve Network Presence", leaving off "Metadata"
* Added requirements blocks for the option "shall" statements

* Transaction Description Updates + MD Option Updates

* Updated DEV-46 & DEV-47 transaction summaries to match the updated transaction names
* Added as a test, additional requirement metadata to the MD Option section
* Changed the arrow direction of the Bye() message for DEV-47

* Test of Inter-Requirement Links

Added forward / backward requirement anchor references to R1023.  fingers crossed

* Tweak update because workflow automation failed

2nd try at triggering build workflow

* Updates from SDPi Friday Review

Updates from review corrections.

---------

Co-authored-by: David Gregorczyk <[email protected]>

* Integrated SDPi-P DP Content + Updated Requirements Model

Integrated the master branch, including the Discovery Proxy content
Updated the TF-1A requirements model

* Thursday End Updates

Updates from TF-1A edits
Update for CHANGELOG.md
AsciiDoc labeling fix for "bibliography"
Pushed publication date to September 13

* Friday Updates

Updated the versioning information (to review notes are not hard wired)
Updated change log
Expanded content in the TF-1A discussion

* Fix build_document.bat

* Bump Java version used by asciidoc-converter; bump Kotlin version; fix Github request error.

* Checking Push Capability

Changed the release date to verify that this branch can now be pushed (by Old Man Cooper)

* Final (candidate) TF-1A RI Info Content

First full pass through RI for 1.4 content.

---------

Co-authored-by: David Gregorczyk <[email protected]>
Co-authored-by: David Gregorczyk <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

3 participants