search

apolloconfig / apollo

Apollo is a reliable configuration management system suitable for microservice configuration management scenarios.
https://www.apolloconfig.com
Apache License 2.0
29.18k stars 10.21k forks source link

feat: openapi query namespace support not fill item #5249

Closed youngzil closed 2 weeks ago

youngzil commented 1 month ago

What's the purpose of this PR

openapi query namespace support not fill item

Which issue(s) this PR fixes:

Fixes #5243

Brief changelog

XXXXX

Follow this checklist to help us incorporate your contribution quickly and easily:

Summary by CodeRabbit

Summary by CodeRabbit

coderabbitai[bot] commented 1 month ago

Walkthrough

The changes in this pull request involve modifications to several classes within the Apollo project, primarily focusing on enhancing the functionality of methods related to namespace management. Key updates include the addition of a boolean parameter, fillItemDetail, to multiple method signatures, which allows for more control over the retrieval of detailed item information within namespaces. This affects the behavior of both the API endpoints and the internal service methods that interact with namespaces, as well as adjustments to corresponding test cases.

Changes

File Change Summary
.../NamespaceController.java Modified findNamespaces and loadNamespace methods to include fillItemDetail parameter with default value.
.../ConfigsExportController.java Updated exportItems method to include new boolean parameter in loadNamespaceBO method call.
.../ConfigsExportService.java Modified exportNamespaces method to include new boolean parameter in findNamespaceBOs method call.
.../NamespaceService.java Updated findNamespaceBOs, loadNamespaceBO, and transformNamespace2BO methods to include fillItemDetail parameter.
.../ConfigsExportServiceTest.java Adjusted testNamespaceExportImport method to include new parameter in findNamespaceBOs method calls.
.../NamespaceServiceTest.java Updated loadNamespaceBO method to include new boolean parameter.
pom.xml Updated apollo-java version from 2.2.0 to 2.4.0-SNAPSHOT.

Assessment against linked issues

Objective Addressed Explanation
Add parameter to control item detail retrieval in namespace API (5243) ✅

Possibly related PRs

Suggested labels

size:M, lgtm

Suggested reviewers

🐰 "In the code we hop and play,
New parameters lead the way.
With details filled or left behind,
Our namespaces are now refined.
A version bump, we cheer and sing,
In Apollo's realm, we bring the spring!" 🌼

📜 Recent review details **Configuration used: CodeRabbit UI** **Review profile: CHILL**
📥 Commits Files that changed from the base of the PR and between 9c3815944aad4a5d6b995459c7c5a9841303b715 and 093e12d038e8ed45b384e88b6e35c29a76d6025b.
📒 Files selected for processing (2) * CHANGES.md (1 hunks) * apollo-portal/src/main/java/com/ctrip/framework/apollo/openapi/v1/controller/NamespaceController.java (2 hunks)
🚧 Files skipped from review as they are similar to previous changes (2) * CHANGES.md * apollo-portal/src/main/java/com/ctrip/framework/apollo/openapi/v1/controller/NamespaceController.java
--- 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?
❤️ 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)
🪧 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](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
youngzil commented 1 month ago

@nobodyiam This feature requires upgrading the Java SDK version to 2.4.0-SNAPSHOT. Can you help deploy Java SDK 2.4.0-SNAPSHOT to the Maven repository?

nobodyiam commented 3 weeks ago

@nobodyiam This feature requires upgrading the Java SDK version to 2.4.0-SNAPSHOT. Can you help deploy Java SDK 2.4.0-SNAPSHOT to the Maven repository?

It's uploaded now.

https://oss.sonatype.org/content/repositories/snapshots/com/ctrip/framework/apollo/apollo-openapi/2.4.0-SNAPSHOT/

codecov[bot] commented 3 weeks ago

Codecov Report

Attention: Patch coverage is 38.46154% with 8 lines in your changes missing coverage. Please review.

Project coverage is 51.21%. Comparing base (f55b419) to head (fce6ad1). Report is 15 commits behind head on master.

Files with missing lines Patch % Lines
...mework/apollo/portal/service/NamespaceService.java 57.14% 2 Missing and 1 partial :warning:
.../server/service/ServerNamespaceOpenApiService.java 0.00% 2 Missing :warning:
...llo/openapi/v1/controller/NamespaceController.java 0.00% 2 Missing :warning:
...llo/portal/controller/ConfigsExportController.java 0.00% 1 Missing :warning:
Additional details and impacted files ```diff @@ Coverage Diff @@ ## master #5249 +/- ## ============================================ + Coverage 50.30% 51.21% +0.91% - Complexity 2013 2098 +85 ============================================ Files 388 393 +5 Lines 12228 12440 +212 Branches 1209 1230 +21 ============================================ + Hits 6151 6371 +220 + Misses 5712 5681 -31 - Partials 365 388 +23 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.