Revamp transforming message formats tutorial
#8233
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
|
(L17) let's add a full stop. |
|
(L255) The parameter name should be reservation not payload. |
|
(L262-L267) We decided to remove log statements except for error logs. |
mindula
reviewed
Nov 10, 2023
swan-lake/integration-tutorials/transforming-message-formats.md
Outdated
Show resolved
Hide resolved
|
(L60) Shall we change the appointment number to 1? |
|
(L351) Should be [reservation.hospitalId] |
mindula
reviewed
Nov 10, 2023
swan-lake/integration-tutorials/transforming-message-formats.md
Outdated
Show resolved
Hide resolved
mindula
reviewed
Nov 10, 2023
swan-lake/integration-tutorials/transforming-message-formats.md
Outdated
Show resolved
Hide resolved
…vamp-transform-message-formats # Conflicts: # swan-lake/integration-tutorials/content-based-message-routing.md # swan-lake/integration-tutorials/service-orchestration.md
mindula
approved these changes
Nov 10, 2023
mindula
merged commit d052e79
into
ballerina-platform:integration-tutorials
1 check passed
MaryamZi
reviewed
Nov 13, 2023
| Import the | ||
| - `ballerina/http` module to develop the REST API and define the client that can be used to send requests to the backend services | ||
| - `ballerina/log` module to log debug, error, or info level information for each client request | ||
| 3. Generate record types corresponding to the payloads from the hospital service and input/output of the transforming function by providing samples of the expected JSON payloads. |
There was a problem hiding this comment.
We haven't spoken about a "transforming function" before we get here, so may not make sense to the user.
I would have
- if there is a request payload, show generating the record for that. if not, show generating a record for the payload from the backend.
- if there are other request or response payloads, say "Similarly, generate records ...". Don't have to give the JSON payloads and/or show generating records here.
- then say "The generated record types will be as follows." for all.
So basically, show one JSON -> record generation for whatever we encounter first. And then say generate similarly for others and show the records.
MaryamZi
reviewed
Nov 13, 2023
| > **Note:** | ||
| > When the fields of the JSON objects are expected to be exactly those specified in the sample payload, the generated records can be updated to be [closed records](https://ballerina.io/learn/by-example/controlling-openness/), which would indicate that no other fields are allowed or expected. | ||
|
|
||
| 4. Define the [HTTP service (REST API)](https://ballerina.io/learn/by-example/#rest-service) that has the resource that accepts user requests, retrieves relevant details from the backend service, and responds to the request. |
There was a problem hiding this comment.
Better to include something about transforming here.
MaryamZi
reviewed
Nov 13, 2023
|
|
||
| return <http:InternalServerError> {body: resp.message()}; | ||
| ``` | ||
| - If the response is not a `ReservationResponse` record, log the information at `ERROR` level. Return a "NotFound" response if the response from the hospital service is an `http:ClientRequestError` response or an "InternalServerError" response otherwise. |
There was a problem hiding this comment.
Fix "NotFound" -> http:NotFound.
Same for "InternalServerError".
MaryamZi
reviewed
Nov 13, 2023
|
|
||
| > **Note:** | ||
| > When the fields of the JSON objects are expected to be exactly those specified in the sample payload, the generated records can be updated to be [closed records](https://ballerina.io/learn/by-example/controlling-openness/), which would indicate that no other fields are allowed or expected. | ||
|
|
There was a problem hiding this comment.
Add a note about making ssn an array of fixed-length (and maybe link to a BBE).
13 tasks
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.
Purpose
$title
Checklist
Page addition
permalinkto pages.Page removal
redirect_fromon the alternative page.redirections.jsfile.Page rename
redirect_from.redirect_to:(if applicable).Page restrcuture
permalinkto pages.redirect_from.redirect_to:(if applicable).