Skip to content
Merged
Show file tree
Hide file tree
Changes from 5 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
blank_issues_enabled: false
contact_links:
- name: MongoDB Realm Support
- name: MongoDB Atlas App Services Support
url: https://support.mongodb.com/
about: Support is provided under MongoDB support plans. Please submit support questions within the Realm UI.
- name: MongoDB Realm
url: https://www.mongodb.com/realm
about: Learn more about MongoDB Realm
- name: MongoDB MongoDB Atlas App Services
url: https://www.mongodb.com/docs/atlas/app-services/
about: Learn more about MongoDB MongoDB Atlas App Services
6 changes: 3 additions & 3 deletions .github/workflows/pr.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ jobs:
- name: Install Go
uses: actions/setup-go@v5
with:
go-version: 1.18
go-version: 1.23
- name: lint
uses: golangci/[email protected]
with:
Expand All @@ -27,8 +27,8 @@ jobs:
strategy:
matrix:
golang:
- 1.18
- 1.19
- 1.23

steps:
- name: Checkout repository
uses: actions/checkout@v4
Expand Down
2 changes: 2 additions & 0 deletions CODEOWNERS
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# Maintained by the MongoDB APIx-Integrations team
* @mongodb-labs/apix-integrations
4 changes: 4 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,10 @@ COVERAGE=coverage.out
export PATH := ./bin:$(PATH)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

are we using COVERAGE?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

GOLANCI_VERSION can be updated to v1.62.2 as in TF repo

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

are we using COVERAGE?

yes

GOLANCI_VERSION can be updated to v1.62.2 as in TF repo

done

export GO111MODULE := on

.PHONY: build
build:
go install $(SOURCE_FILES)

.PHONY: setup
setup: ## Install dev tools
@echo "==> Installing dependencies..."
Expand Down
18 changes: 8 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,24 @@
# go-client-mongodb-realm
# go-client-mongodb-atlas-app-services (WIP)
[![PkgGoDev](https://pkg.go.dev/badge/go.mongodb.org/realm)](https://pkg.go.dev/go.mongodb.org/realm)

A Go HTTP client for the [MongoDB Realm API](https://docs.mongodb.com/realm/admin/api/v3/).

Note that Realm only supports the two most recent major versions of Go.
A Go HTTP client for the [MongoDB Atlas App Services Admin API](https://www.mongodb.com/docs/atlas/app-services/admin/api/v3/).

## Usage

```go
import "go.mongodb.org/realm/realm"
import "go.mongodb.org/atlas-appservices/appservices"
```

Construct a new Realm client, then use the various services on the client to
Construct a new App Services client, then use the various services on the client to
access different parts of the Atlas API. For example:

```go
client := realm.NewClient(nil)
client := appservices.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/.
https://www.mongodb.com/docs/atlas/app-services/admin/api/v3/.

**NOTE:** Using the [context](https://godoc.org/context) package, one can easily
pass cancellation signals and deadlines to various services of the client for
Expand All @@ -33,7 +31,7 @@ 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](./realm/realm.go) is updated
To release a new version, first ensure that [Version](./appservices/appservices.go) 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
Expand All @@ -48,4 +46,4 @@ See our [CONTRIBUTING.md](CONTRIBUTING.md) Guide.

## License

`go-client-mongodb-realm` is released under the Apache 2.0 license. See [LICENSE](LICENSE)
`go-client-mongodb-atlas-app-services` is released under the Apache 2.0 license. See [LICENSE](LICENSE)
2 changes: 1 addition & 1 deletion realm/apps.go → appservices/apps.go
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
// See the License for the specific language governing permissions and
// limitations under the License.

package realm
package appservices

import (
"context"
Expand Down
2 changes: 1 addition & 1 deletion realm/apps_test.go → appservices/apps_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
// See the License for the specific language governing permissions and
// limitations under the License.

package realm
package appservices

import (
"fmt"
Expand Down
3 changes: 2 additions & 1 deletion realm/realm.go → appservices/appservices.go
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
// See the License for the specific language governing permissions and
// limitations under the License.

package realm // import "go.mongodb.org/realm/realm"
package appservices // import "go.mongodb.org/realm/realm"

import (
"bytes"
Expand All @@ -28,6 +28,7 @@ import (
"strings"

"github.com/google/go-querystring/query"

"go.mongodb.org/atlas/mongodbatlas"
)

Expand Down
2 changes: 1 addition & 1 deletion realm/realm_test.go → appservices/appservices_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
// See the License for the specific language governing permissions and
// limitations under the License.

package realm
package appservices

import (
"context"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
// See the License for the specific language governing permissions and
// limitations under the License.

package realm
package appservices

import (
"context"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
// See the License for the specific language governing permissions and
// limitations under the License.

package realm
package appservices

import (
"encoding/json"
Expand Down
4 changes: 2 additions & 2 deletions go.mod
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
module go.mongodb.org/realm
module go.mongodb.org/atlas-appservices

go 1.18
go 1.23

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

as this is a module to be used by other programs, consider defining toolchain

Copy link
Collaborator Author

@maastha maastha Feb 21, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@lantoli can you educate me a bit on what exactly is the benefit of that?
Also, can you confirm if the latest version of toolchain should be used? I've added 1.23.1 for now

require (
github.com/go-test/deep v1.1.1
Expand Down
Loading