1
- # go-client-mongodb-realm
1
+ # go-client-mongodb-atlas-app-services (WIP)
2
2
[ ![ PkgGoDev] ( https://pkg.go.dev/badge/go.mongodb.org/realm )] ( https://pkg.go.dev/go.mongodb.org/realm )
3
3
4
- A Go HTTP client for the [ MongoDB Realm API] ( https://docs.mongodb.com/realm/admin/api/v3/ ) .
5
-
6
- Note that Realm only supports the two most recent major versions of Go.
4
+ A Go HTTP client for the [ MongoDB Atlas App Services Admin API] ( https://www.mongodb.com/docs/atlas/app-services/admin/api/v3/ ) .
7
5
8
6
## Usage
9
7
10
8
``` go
11
- import " go.mongodb.org/realm/realm "
9
+ import " go.mongodb.org/atlas-appservices/appservices "
12
10
```
13
11
14
- Construct a new Realm client, then use the various services on the client to
12
+ Construct a new App Services client, then use the various services on the client to
15
13
access different parts of the Atlas API. For example:
16
14
17
15
``` go
18
- client := realm .NewClient (nil )
16
+ client := appservices .NewClient (nil )
19
17
```
20
18
21
19
The services of a client divide the API into logical chunks and correspond to
22
20
the structure of the Atlas API documentation at
23
- https://docs .mongodb.com/realm /admin/api/v3/ .
21
+ https://www .mongodb.com/docs/atlas/app-services /admin/api/v3/ .
24
22
25
23
** NOTE:** Using the [ context] ( https://godoc.org/context ) package, one can easily
26
24
pass cancellation signals and deadlines to various services of the client for
@@ -33,7 +31,7 @@ Each version of the client is tagged, and the version is updated accordingly.
33
31
34
32
To see the list of past versions, run ` git tag ` .
35
33
36
- To release a new version, first ensure that [ Version] ( ./realm/realm .go ) is updated
34
+ To release a new version, first ensure that [ Version] ( ./appservices/appservices .go ) is updated
37
35
(i.e., before running ` git push origin vx.y.z ` , verify that ` Version=x.y.z ` should match the tag being pushed to GitHub)
38
36
39
37
## Roadmap
@@ -48,4 +46,4 @@ See our [CONTRIBUTING.md](CONTRIBUTING.md) Guide.
48
46
49
47
## License
50
48
51
- ` go-client-mongodb-realm ` is released under the Apache 2.0 license. See [ LICENSE] ( LICENSE )
49
+ ` go-client-mongodb-atlas-app-services ` is released under the Apache 2.0 license. See [ LICENSE] ( LICENSE )
0 commit comments