Skip to content

Commit 73ead62

Browse files
themantissagssbzn
andauthored
INTMDB-157: Add deprecation notice (#165)
* Add deprecation notice Add deprecation notice to both programmatic key whitelist and project ip whitelist, replaced with access list. * format to fix errors * Added deprecated via go doc Per https://github.com/golang/go/wiki/Deprecated added deprecated wording to alert tools that check. * move lower in code and remove from tests * PR comments Co-authored-by: Gustavo Bazan <[email protected]>
1 parent 8dd299f commit 73ead62

File tree

2 files changed

+12
-0
lines changed

2 files changed

+12
-0
lines changed

mongodbatlas/project_ip_whitelist.go

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,13 @@ const projectIPWhitelistPath = "groups/%s/whitelist"
1111

1212
// ProjectIPWhitelistService is an interface for interfacing with the Project IP Whitelist
1313
// endpoints of the MongoDB Atlas API.
14+
//
1415
// See more: https://docs.atlas.mongodb.com/reference/api/whitelist/
16+
//
17+
// Deprecated: ProjectIPAccessListService replaces ProjectIPWhitelistService.
18+
// Atlas now refers to its cluster firewall management as IP Access Lists.
19+
// Atlas has deprecated the whitelist resource and will disable it in June 2021.
20+
// Please update any dependent work to use ProjectIPWhitelistService
1521
type ProjectIPWhitelistService interface {
1622
List(context.Context, string, *ListOptions) ([]ProjectIPWhitelist, *Response, error)
1723
Get(context.Context, string, string) (*ProjectIPWhitelist, *Response, error)

mongodbatlas/whitelist_api_keys.go

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,13 @@ const whitelistAPIKeysPath = "orgs/%s/apiKeys/%s/whitelist"
1010

1111
// WhitelistAPIKeysService is an interface for interfacing with the Whitelist API Keys
1212
// endpoints of the MongoDB Atlas API.
13+
//
1314
// See more: https://docs.atlas.mongodb.com/reference/api/apiKeys/#organization-api-key-endpoints
15+
//
16+
// Deprecated: AccessListAPIKeysService replaces WhitelistAPIKeysService.
17+
// Atlas now refers to programmatic API key whitelists as access lists.
18+
// Atlas has deprecated the whitelist method and will disable it in June 2021.
19+
// Please update any dependent work to use WhitelistAPIKeysService
1420
type WhitelistAPIKeysService interface {
1521
List(context.Context, string, string, *ListOptions) (*WhitelistAPIKeys, *Response, error)
1622
Get(context.Context, string, string, string) (*WhitelistAPIKey, *Response, error)

0 commit comments

Comments
 (0)