Skip to content

Release/4.3.2 docs#3

Open
orichter wants to merge 20 commits intomainfrom
release/4.3.2-docs
Open

Release/4.3.2 docs#3
orichter wants to merge 20 commits intomainfrom
release/4.3.2-docs

Conversation

@orichter
Copy link
Copy Markdown
Collaborator

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 are
flagged for the upstream SDK documentation team.

1. datapolicies and dataprotection share com.nutanix.dat import prefix

Both 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-client and dataprotection-java-client
in the same project will have an ApiClient class from each, both in the
com.nutanix.dat.java.client package. This may cause classpath conflicts or require
fully-qualified class names. Consider clarifying this in both READMEs.

2. dataprotection README uses placeholder sample code

The dataprotection/README.md "Invoking an operation" section uses generic placeholder
names (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-case

This should be updated to use actual dataprotection API classes.

3. ntnxsaas namespace excluded

The ntnxsaas directory exists in the source repo but was excluded from this sync
because:

  • It is not published to Maven Central (com.nutanix.api namespace has no
    ntnxsaas-java-client artifact)
  • It is not listed in the deployment manifest.json

If this namespace is intended to be published in a future release, it should be added
to the manifest first, then synced here.

4. storage namespace appears stale

The storage namespace (API v4.0.a3, package 4.0.2-alpha-3) was last published to
Maven Central in February 2023. The volumes namespace (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 storage may 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) contains
internal-facing content including:

  • References to nutanix-core/ntnx-api-java-sdk-external (internal staging repo)
  • POM URL rewriting instructions
  • Internal contact list with individual email addresses
  • Architecture diagram referencing internal infrastructure

The namespace-level READMEs correctly link to developers.nutanix.com and
search.maven.org so no URL fixups were needed for those.

orichter added 20 commits March 24, 2026 13:07
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
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.

1 participant