Skip to content

CASSGO-55 - User API doc enhancement #1863

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

Open
wants to merge 1 commit into
base: trunk
Choose a base branch
from

Conversation

tengu-alt
Copy link
Contributor

@tengu-alt tengu-alt commented Feb 12, 2025

Some of the user-exposed API is not documented which can cause misuse. This PR provides doc update fo the public methods and interfaces. Also, some deprecated features were removed.
Fix for the #1601

@tengu-alt tengu-alt changed the title User API doc enhancement WIP - User API doc enhancement Feb 12, 2025
@tengu-alt tengu-alt changed the title WIP - User API doc enhancement WIP - CASSGO-55 - User API doc enhancement Feb 12, 2025
@tengu-alt tengu-alt force-pushed the update-public-methods-doc branch from 4c82386 to 2ec07af Compare February 17, 2025 14:09
@tengu-alt tengu-alt changed the title WIP - CASSGO-55 - User API doc enhancement CASSGO-55 - User API doc enhancement Feb 17, 2025
@tengu-alt tengu-alt force-pushed the update-public-methods-doc branch from 2ec07af to 171d258 Compare February 18, 2025 14:33
@tengu-alt tengu-alt force-pushed the update-public-methods-doc branch from 171d258 to 044b4f5 Compare March 21, 2025 13:18
filters.go Outdated
@@ -61,12 +62,6 @@ func DataCenterHostFilter(dataCenter string) HostFilter {
})
}

// Deprecated: Use DataCenterHostFilter instead.
// DataCentreHostFilter is an alias that doesn't use the preferred spelling.
func DataCentreHostFilter(dataCenter string) HostFilter {
Copy link
Contributor

Choose a reason for hiding this comment

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

This was deprecated very recently for the 2.0 release, we don't want to remove it now.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Got it, I have returned it.

Copy link
Contributor

@joao-r-reis joao-r-reis left a comment

Choose a reason for hiding this comment

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

Added 1 comment. #1868 will change the query and batch API so I'd like to get that merged before merging this one.

@tengu-alt tengu-alt closed this Mar 26, 2025
@tengu-alt tengu-alt force-pushed the update-public-methods-doc branch from 044b4f5 to 63b6d78 Compare March 26, 2025 08:57
@tengu-alt tengu-alt reopened this Mar 26, 2025
@tengu-alt
Copy link
Contributor Author

Sorry for that, I've accidentally pushed without changes.

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.

2 participants