Open
Conversation
Synced from nutanix-core/ntnx-api-java-sdk-external main branch. Made-with: Cursor
Synced from nutanix-core/ntnx-api-java-sdk-external main branch. Made-with: Cursor
Synced from nutanix-core/ntnx-api-java-sdk-external main branch. Made-with: Cursor
Synced from nutanix-core/ntnx-api-java-sdk-external main branch. Made-with: Cursor
Synced from nutanix-core/ntnx-api-java-sdk-external main branch. Made-with: Cursor
Synced from nutanix-core/ntnx-api-java-sdk-external main branch. Made-with: Cursor
Synced from nutanix-core/ntnx-api-java-sdk-external main branch. Made-with: Cursor
Synced from nutanix-core/ntnx-api-java-sdk-external main branch. Made-with: Cursor
Synced from nutanix-core/ntnx-api-java-sdk-external main branch. Made-with: Cursor
Synced from nutanix-core/ntnx-api-java-sdk-external main branch. Made-with: Cursor
Synced from nutanix-core/ntnx-api-java-sdk-external main branch. Made-with: Cursor
Synced from nutanix-core/ntnx-api-java-sdk-external main branch. Made-with: Cursor
Synced from nutanix-core/ntnx-api-java-sdk-external main branch. Made-with: Cursor
Synced from nutanix-core/ntnx-api-java-sdk-external main branch. Made-with: Cursor
Synced from nutanix-core/ntnx-api-java-sdk-external main branch. Made-with: Cursor
Synced from nutanix-core/ntnx-api-java-sdk-external main branch. Made-with: Cursor
Synced from nutanix-core/ntnx-api-java-sdk-external main branch. Made-with: Cursor
Synced from nutanix-core/ntnx-api-java-sdk-external main branch. Made-with: Cursor
Synced from nutanix-core/ntnx-api-java-sdk-external main branch. Made-with: Cursor
… doc - Updated namespace table from 9 to 20 namespaces with current versions - Updated Maven/Gradle dependency examples to current versions - Updated Maven Central link to new Sonatype URL - Added DISCREPANCIES.md flagging issues in source documentation: datapolicies/dataprotection shared import prefix, dataprotection placeholder sample code, ntnxsaas exclusion, storage staleness Made-with: Cursor
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
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.
Source Documentation Discrepancies
Issues found while syncing README documentation from the internal source repository
(
nutanix-core/ntnx-api-java-sdk-external) to this public repository. These areflagged for the upstream SDK documentation team.
1.
datapoliciesanddataprotectionsharecom.nutanix.datimport prefixBoth namespace READMEs instruct users to import
com.nutanix.dat.java.client.ApiClient.The two are distinguished only by their model packages:
com.nutanix.dp1.dat.dataprotection.v4.config.*com.nutanix.dp1.dat.datapolicies.v4.config.*A user who depends on both
datapolicies-java-clientanddataprotection-java-clientin the same project will have an
ApiClientclass from each, both in thecom.nutanix.dat.java.clientpackage. This may cause classpath conflicts or requirefully-qualified class names. Consider clarifying this in both READMEs.
2.
dataprotectionREADME uses placeholder sample codeThe
dataprotection/README.md"Invoking an operation" section uses generic placeholdernames (
SampleApi,SampleGetResponse,getSampleByExtId) instead of real API classes.All other namespace READMEs use real class names (e.g.,
ImagesApi,CategoriesApi).The README also includes the comment:
// this sample code is not usable directly for real use-caseThis should be updated to use actual
dataprotectionAPI classes.3.
ntnxsaasnamespace excludedThe
ntnxsaasdirectory exists in the source repo but was excluded from this syncbecause:
com.nutanix.apinamespace has nontnxsaas-java-clientartifact)manifest.jsonIf this namespace is intended to be published in a future release, it should be added
to the manifest first, then synced here.
4.
storagenamespace appears staleThe
storagenamespace (API v4.0.a3, package 4.0.2-alpha-3) was last published toMaven Central in February 2023. The
volumesnamespace (API v4.2, package 4.2.2)appears to be its successor. Both exist in the source repo and are included in this
sync, but
storagemay need to be deprecated or removed in a future update.5. Source README contains internal staging URLs
The source repo's root
README.md(which was NOT copied to this repo) containsinternal-facing content including:
nutanix-core/ntnx-api-java-sdk-external(internal staging repo)The namespace-level READMEs correctly link to
developers.nutanix.comandsearch.maven.orgso no URL fixups were needed for those.