Generate Client using OpenAPI spec, Update Setup Guide and Quickstart #2
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
java21 is set by default and not supported by the current version of ballerina. Downgraded to java17 to make build succesful. Can potentially upgrade to java21 on next release of Ballerina Swanlake (Update 11)
|
|
The backgroundColor property of 'PublicButtonStyleSettings' schema
has an incorrect type of 'object' which generates an error during
payload binding. Changing it to 'string' fixes the issue. The
sanitation details has been documented.
Co-authored-by: MohamedSabthar <[email protected]>
…tion The sendOnPublish property of 'PublicEmails' schema is set as required. However the API response contains emails without this property, leading to an error. Removing it from the required list fixes the error. The sanitation details have been documented.
Previously the test case checked whether the length of response results array was equal to the time span given. However the API returns results of length 1 if no email is sent during that time, regardless of the duration of the timespan between starting and ending timestamps. As a result the test case would fail sometimes and this fix would prevent it from failing in the above mentioned valid case.
Added testcase for clone endpoint and modified the retrieve endpoint to check retrieving newly cloned email too.
Previously the last element of the result array returned from the /emails endpoint was checked to have the id of the email cloned in the test case above and the second last element was checked to be the email created in the first testcase. However on certain runs they are returned out of order, causing the test to fail unnecessarily.
The prefix of /marketing/v3/emails common to all API paths is added to the base URL path for ease of use. API paths have been updated accordingly by removing the common prefix. Sanitaiton documented in docs/spec/sanitations.md
Change property of PublicVersionEmail schema. Sanitation explained in detail in the sanitation.md.
Co-authored-by: Thisaru Guruge <[email protected]>
Added suggestions from code review.
Example of retrieving and logging statistics on marketing emails using the API has been added along with its documentation.
Co-authored-by: Thisaru Guruge <[email protected]>
to correct two missed relative links that hadn't been changed earlier.
Added slight change to the description of step 3 of the quickstart guide as previously it was not as clear. Copied over the same change to all three files mentioned.
Add mock tests to test the client without connecting to the Hubspot server. ballerina/test/mock_service.bal simulates responses for three endpoints. To run the mock tests `useMockServer` environment variable must be set to "true" and test must be run with `bal test --groups mock_tests`
Co-authored-by: Thisaru Guruge <[email protected]>
Run the new openapi command with license generation to add license header to generated files. New command has been updated in sanitations.md
Change the useMockServer to isLiveServer and set the enable to isLiveServer on test cases that can only run on the live server. This ensures that by default only the mock tests are executed.
Added licence header
ThisaruGuruge
approved these changes
Jan 10, 2025
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
Initial setup of the connector
Examples
Checklist