README
¶
go-client-mongodb-realm
A Go HTTP client for the MongoDB Realm API.
Note that Realm only supports the two most recent major versions of Go.
Usage
import "go.mongodb.org/realm/realm"
Construct a new Realm client, then use the various services on the client to access different parts of the Atlas API. For example:
client := realm.NewClient(nil)
The services of a client divide the API into logical chunks and correspond to the structure of the Atlas API documentation at https://docs.mongodb.com/realm/admin/api/v3/.
NOTE: Using the context package, one can easily
pass cancellation signals and deadlines to various services of the client for
handling a request. In case there is no context available, then context.Background()
can be used as a starting point.
Versioning
Each version of the client is tagged, and the version is updated accordingly.
To see the list of past versions, run git tag.
To release a new version, first ensure that Version is updated
(i.e., before running git push origin vx.y.z, verify that Version=x.y.z should match the tag being pushed to GitHub)
Roadmap
This library is being initially developed for Atlas Terraform Provider so API methods will likely be implemented in the order that they are needed by those projects.
Contributing
See our CONTRIBUTING.md Guide.
License
go-client-mongodb-realm is released under the Apache 2.0 license. See LICENSE
Directories