fix: Remove optional params as null in docs #229
Merged
Conversation
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
kschrief
approved these changes
Nov 18, 2024
kschrief
pushed a commit
that referenced
this pull request
Nov 18, 2024
# [3.2.0-next.9](v3.2.0-next.8...v3.2.0-next.9) (2024-11-18) ### Bug Fixes * Remove optional params as null in documentation ([#229](#229)) ([95808ef](95808ef))
Contributor
|
🎉 This PR is included in version 3.2.0-next.9 🎉 The release is available on: Your semantic-release bot 📦🚀 |
kschrief
pushed a commit
that referenced
this pull request
Feb 28, 2025
# [3.2.0](v3.1.3...v3.2.0) (2025-02-28) ### Bug Fixes * Add open-rpc to generated C++ SDK ([#217](#217)) ([a02980a](a02980a)) * C++ Auto-Reconnect ([#237](#237)) ([dde6753](dde6753)) * C++ Auto-Reconnect typo ([#240](#240)) ([bbd5813](bbd5813)) * C++ Pascal casing method name ([#233](#233)) ([ed1106f](ed1106f)) * Do not hard-code SDK Version in CI processes ([#228](#228)) ([45b513e](45b513e)) * Documentation generation enhancements ([#227](#227)) ([7fe212b](7fe212b)) * Events - Change promise all to reduce for sequential resolving ([#230](#230)) ([43f3ad3](43f3ad3)) * For C++ Capabilities.info ([#224](#224)) ([c21e49a](c21e49a)) * Generate full SDKs in CI for tooling changes ([#226](#226)) ([953f533](953f533)) * Make nested objects show in typescript .d.ts file and in the doc… ([#231](#231)) ([31217ce](31217ce)) * Native SDK unit tests support framework ([#223](#223)) ([819cc21](819cc21)) * Remove optional params as null in documentation ([#229](#229)) ([95808ef](95808ef)) ### Features * Cpp global subscriber type ([#218](#218)) ([45cbf0a](45cbf0a)) * Make private method and private events more hidden ([#216](#216)) ([d3d5bdd](d3d5bdd))
Contributor
|
🎉 This PR is included in version 3.2.0 🎉 The release is available on: Your semantic-release bot 📦🚀 |
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.
When generating documentation from the OpenRPC, some methods have optional fields in either the request or response. These fields don't have to be present AT ALL if not needed.
Due to how the tooling is interpreting the schema vs the examples, documentation is being generated that infers that you must pass or receive these fields with "null" as the value instead of having the option to omit them entirely.
This PR fixes the documentation so that null is not passed as the value of an optional parameter that is not used in the examples section for a method.
If a method has multiple optional parameters and there is an example that sets the second optional parameter,
undefinedwill be used as the first parameter.