Skip to content

docs: improve DefaultApi.md examples and add common-patterns preamble#105

Merged
sherwinski merged 1 commit into
mainfrom
user-api-updates
Jun 4, 2026
Merged

docs: improve DefaultApi.md examples and add common-patterns preamble#105
sherwinski merged 1 commit into
mainfrom
user-api-updates

Conversation

@onesignal-deploy
Copy link
Copy Markdown
Collaborator

@onesignal-deploy onesignal-deploy commented Jun 4, 2026

Documentation updates

Improvements to the generated DefaultApi.md example snippets:

  • New common-patterns preamble at the top of DefaultApi.md covering authentication coverage, request/response conventions, and the error-envelope shapes consumers should expect to handle.
  • Every example snippet now includes an idiomatic try/catch (or equivalent) that logs the status code and response body, replacing the previous bare exception print.
  • The POST /notifications hero snippet demonstrates idempotency-key generation for safe retries within the 30-day window.
  • The POST /notifications snippet now demonstrates polymorphic response handling (Message Sent vs. Message Not Sent) instead of an unsafe single-shape access.
  • Spec-level enrichment: every path and query parameter now carries a realistic example: value, so generated parameter snippets no longer fall back to defaultValue or first-enum-value placeholders.

Generated from OneSignal/api-client-libraries@3b35d43...6d24a5c.

@sherwinski sherwinski changed the title docs: add v5.7.0 package updates docs: improve DefaultApi.md examples and add common-patterns preamble Jun 4, 2026
@sherwinski sherwinski merged commit 1446466 into main Jun 4, 2026
3 checks passed
@sherwinski sherwinski deleted the user-api-updates branch June 4, 2026 04:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants