Skip to content

Commit 0effb93

Browse files
CLOUDP-221643: Document the meaning of read/write only fields (#254)
1 parent 1a1a2ce commit 0effb93

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

docs/doc_1_concepts.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,15 @@ Note: The `experimental` label refers specifically to the Atlas Go SDK methods.
5555

5656
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).
5757

58+
## Read Only and Write Only Fields
59+
60+
Each SDK request and response might contain read or write only fields as identified by the [documentation](https://github.com/mongodb/atlas-sdk-go/blob/main/docs/doc_last_reference.md#documentation-for-models) and the Go doc comments.
61+
62+
We use GoDoc comments to annotate fields as read and write only:
63+
64+
- `// Read Only field.` means that the field is included in responses but not in requests
65+
- `// Write Only field.` means that the field may be included in requests but not in responses
66+
5867
## Example
5968

6069
To learn more about using the SDK, see the [basic example](https://github.com/mongodb/atlas-sdk-go/blob/main/examples/basic/basic.go).

0 commit comments

Comments
 (0)