search

formancehq / stack

Open Source Infrastructure for the Financial Internet
https://www.formance.com
Other
362 stars 50 forks source link

feat: update API configuration and security schemes #1717

Closed flemzord closed 2 months ago

flemzord commented 2 months ago
coderabbitai[bot] commented 2 months ago

Walkthrough

The changes encompass updates across various files in the Go SDK, primarily focusing on the handling of security credentials. Modifications include transitioning the ClientID and ClientSecret fields to utilize pointer types, enhancing the handling of optional values. Additionally, the initialization of these fields has been standardized to use the v2.String function, and documentation has been updated to reflect these changes. New functionalities for server URL management have also been introduced, allowing for dynamic configuration based on organization and environment variables.

Changes

File Path Change Summary
releases/sdks/go/.speakeasy/gen.lock Updated docChecksum value in the management section.
releases/sdks/go/README.md Modified ClientID initialization to use v2.String(""), updated server URL documentation, and added variable setting options.
releases/sdks/go/USAGE.md Changed ClientID initialization to use v2.String("").
releases/sdks/go/docs/pkg/models/shared/security.md Changed ClientID, ClientSecret, and TokenURL from required to optional fields in documentation.
releases/sdks/go/docs/sdks/formance/README.md Removed ClientSecret from shared.Security initialization, updated ClientID to use v2.String("").
releases/sdks/go/docs/sdks/formanceorchestrationv1/README.md Updated ClientID initialization and removed ClientSecret across multiple examples.
releases/sdks/go/docs/sdks/formancepaymentsv1/README.md Updated ClientID initialization and removed ClientSecret in various function definitions.
releases/sdks/go/docs/sdks/formancereconciliationv1/README.md Updated ClientID initialization and removed ClientSecret in several request structures.
releases/sdks/go/docs/sdks/formancesearchv1/README.md Updated ClientID initialization and removed ClientSecret in multiple instances.
releases/sdks/go/docs/sdks/formancev1/README.md Updated ClientID initialization to use v2.String(""), ClientSecret remains unchanged.
releases/sdks/go/docs/sdks/formancev2/README.md Updated ClientID initialization to use v2.String(""), removed ClientSecret.
releases/sdks/go/docs/sdks/formancewalletsv1/README.md Updated ClientID initialization and removed ClientSecret in various request structures.
releases/sdks/go/docs/sdks/formancewebhooksv1/README.md Updated ClientID initialization and removed ClientSecret in several functions.
releases/sdks/go/docs/sdks/v1/README.md Updated ClientID initialization to use v2.String(""), removed ClientSecret.
releases/sdks/go/docs/sdks/v2/README.md Updated ClientID initialization to use v2.String(""), removed ClientSecret.
releases/sdks/go/formance.go Introduced new structure for dynamic server URL management, added new SDK options for organization and environment.
releases/sdks/go/internal/hooks/clientcredentials.go Added nil checks for ClientID and ClientSecret in getCredentials method to prevent runtime errors.
releases/sdks/go/pkg/models/shared/security.go Changed ClientID, ClientSecret, and tokenURL fields to pointer types for optional value handling.

Possibly related PRs

Poem

🐰 In the meadow where bunnies play,
Security fields now lead the way.
With pointers to guide, and strings that sing,
Our SDK dances, oh what a thing!
Dynamic URLs, a joyful cheer,
Hopping along, we have nothing to fear! 🌼

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

:heart: Share - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
:placard: Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit , please review it.` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` - `@coderabbitai help me debug CodeRabbit configuration file.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (Invoked using PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. ### Other keywords and placeholders - Add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. - Add `@coderabbitai summary` to generate the high-level summary at a specific location in the PR description. - Add `@coderabbitai` anywhere in the PR title to generate the title automatically. ### CodeRabbit Configuration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.