Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add note on preserving API response case style for kinds from non-asset APIs #1853

Merged

Conversation

phalbert
Copy link
Contributor

Description

  • Introduced a new section in the examples documentation to explain the use of preserveApiResponseCaseStyle in the selector configuration.
  • Provided examples for pubsub.googleapis.com/Subscription and pubsub.googleapis.com/Topic.
  • Clarified the purpose of this configuration to maintain camelCase format from the GCP API response.

Updated docs pages

Please also include the path for the updated docs

  • GCP Installation - Mapping Extra Resources (/docs\build-your-software-catalog\sync-data-to-catalog\cloud-providers\gcp\examples\mapping_extra_resources.md)

…kinds

- Introduced a new section in the examples documentation to explain the use of `preserveApiResponseCaseStyle` in the selector configuration.
- Provided examples for `pubsub.googleapis.com/Subscription` and `pubsub.googleapis.com/Topic`.
- Clarified the purpose of this configuration to maintain camelCase format from the GCP API response.
@phalbert phalbert self-assigned this Dec 11, 2024
@phalbert phalbert requested a review from matan84 December 11, 2024 15:36
Copy link

This pull request is automatically being deployed by Amplify Hosting (learn more).

Access this pull request here: https://pr-1853.d2ngvl90zqbob8.amplifyapp.com

Copy link
Member

@mk-armah mk-armah left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Left some comments and recommendations

mk-armah and others added 3 commits December 12, 2024 09:07
- Added explicit list of supported APIs and their endpoints for case style preservation
- Clarified default behavior when preserveApiResponseCaseStyle is not set
- Added explanation of use cases and downstream compatibility
- Improved structure with clear sections for better readability
- Added examples showing how to enable the feature
…than-camel' of https://github.com/port-labs/port-docs into PORT-11122-bug-gcp-returns-pubsub-in-snake-case-rather-than-camel
Copy link
Member

@mk-armah mk-armah left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

need some clarifications

@phalbert phalbert marked this pull request as draft December 12, 2024 12:12
@phalbert phalbert marked this pull request as ready for review December 12, 2024 12:13
Copy link
Member

@mk-armah mk-armah left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@hadar-co hadar-co merged commit c43e336 into main Dec 14, 2024
1 check passed
@hadar-co hadar-co deleted the PORT-11122-bug-gcp-returns-pubsub-in-snake-case-rather-than-camel branch December 14, 2024 09:42
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.

3 participants