docs: improve DefaultApi.md examples and add common-patterns preamble#58
Merged
Conversation
a7dbc83 to
fc98fcb
Compare
sherwinski
approved these changes
Jun 4, 2026
This file contains hidden or 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
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.
Documentation updates
Improvements to the generated
DefaultApi.mdexample snippets:DefaultApi.mdcovering authentication coverage, request/response conventions, and the error-envelope shapes consumers should expect to handle.try/catch(or equivalent) that logs the status code and response body, replacing the previous bare exception print.POST /notificationshero snippet demonstrates idempotency-key generation for safe retries within the 30-day window.POST /notificationssnippet now demonstrates polymorphic response handling (Message Sent vs. Message Not Sent) instead of an unsafe single-shape access.example:value, so generated parameter snippets no longer fall back todefaultValueor first-enum-value placeholders.Generated from OneSignal/api-client-libraries@3b35d43...6d24a5c.