chore: enhance bpdm interface documentation #237
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jjeroch
commented
Jan 26, 2024
| @@ -230,7 +231,7 @@ The call itself is not a API triggered call but automated by the process worker. | |||
| However the administrator of the platform has the chance to retrigger the process in the scenario of an failure. | |||
|
|
|||
| ```diff | |||
| ! POST /api/administration/registration/application/{applicationId}/trigger-bpn | |||
| ! GET /api/catena/sharing-state | |||
| ``` | |||
There was a problem hiding this comment.
@Phil91 in this section we need to add the additional endpoint details of the second called endpoint to retrieve the BPN ++ can you please explain shortly inside the interface contract why we call 2 endpoints? Thanks!
Phil91
changed the title
evegufy
force-pushed
the
enhance/bpdm-interface-documentation
branch
from
90045a6 to
149bb36
Compare
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Adjusted BPDM interface contract documentation
Why
Changes in the interface implementation as well as correction of incorrect mentioned details
Issue
n/a
Checklist