Skip to content

Commit 1e27c67

Browse files
authored
CLOUDP-194380: revisit experimental section in docs (#160)
1 parent 84b55c7 commit 1e27c67

File tree

3 files changed

+5
-6
lines changed

3 files changed

+5
-6
lines changed

docs/doc_1_concepts.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -49,12 +49,11 @@ Use the `{Operation}()` method to perform modifications. For example:
4949

5050
## Experimental Methods
5151

52-
Please note that we have some methods marked as experimental, denoted by the [experimental] tag in the operation description.
53-
This signifies that the method might be changed in the future without compatibility guarantees.
52+
GO SDK uses `experimental` label in documentation and codebase to mark newly introduced methods that have not yet undergone extensive usage and testing.
5453

55-
If you encounter any problems with methods marked as experimental, feel free to raise a [Github issue](https://github.com/mongodb/atlas-sdk-go/issues/new/choose) and the team will work to resolve it.
54+
> NOTE: `Experimental` label is specifically associated with GO SDK methods, and does not pertain to the underlying Atlas feature itself.
5655
57-
If you belive a method should be marked as stable, feel free to raise a PR appending the method's OperationId to our [operations.stable.json](https://github.com/mongodb/atlas-sdk-go/blob/main/tools/transformer/src/operations.stable.json) set.
56+
If you encounter any problems with methods marked as experimental, feel free to raise a [Github issue](https://github.com/mongodb/atlas-sdk-go/issues/new/choose).
5857

5958
## Example
6059

docs/doc_last_reference.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
All URIs are relative to *https://cloud.mongodb.com*
66

7-
Class | Method | HTTP request | Description | Stability level
7+
Class | Method | HTTP request | Description | [SDK Maturity](https://github.com/mongodb/atlas-sdk-go/blob/main/docs/doc_1_concepts.md#experimental-methods)
88
------------ | ------------- | ------------- | ------------- | -------------
99
*AWSClustersDNSApi* | [GetAWSCustomDNS](./docs/AWSClustersDNSApi.md#getawscustomdns) | **Get** /api/atlas/v2/groups/{groupId}/awsCustomDNS | Return One Custom DNS Configuration for Atlas Clusters on AWS | Experimental
1010
*AWSClustersDNSApi* | [ToggleAWSCustomDNS](./docs/AWSClustersDNSApi.md#toggleawscustomdns) | **Patch** /api/atlas/v2/groups/{groupId}/awsCustomDNS | Toggle State of One Custom DNS Configuration for Atlas Clusters on AWS | Experimental

tools/config/go-templates/README.mustache

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
All URIs are relative to *{{basePath}}*
66

7-
Class | Method | HTTP request | Description | Stability level
7+
Class | Method | HTTP request | Description | [SDK Maturity](https://github.com/mongodb/atlas-sdk-go/blob/main/docs/doc_1_concepts.md#experimental-methods)
88
------------ | ------------- | ------------- | ------------- | -------------
99
{{#apiInfo}}{{#apis}}{{#operations}}{{#operation}}*{{classname}}* | [{{operationId}}](./{{apiDocPath}}{{classname}}.md#{{operationIdLowerCase}}) | **{{httpMethod}}** {{path}} | {{summary}} | {{#vendorExtensions.x-xgen-experimental}}Experimental{{/vendorExtensions.x-xgen-experimental}}{{^vendorExtensions.x-xgen-experimental}}Stable{{/vendorExtensions.x-xgen-experimental}}
1010
{{/operation}}{{/operations}}{{/apis}}{{/apiInfo}}

0 commit comments

Comments
 (0)