@openfn/language-mongodb 1.0.4 → 1.0.6

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -4,15 +4,12 @@ Language Pack for building expressions and operations for use with MongoDB.
4
4
 
5
5
  ## Documentation
6
6
 
7
- ### sample configuration
8
-
9
- ```json
10
- {
11
- "username": "something",
12
- "password": "secret",
13
- "clusterUrl": "yourCluster-xxxyzzz.mongodb.net"
14
- }
15
- ```
7
+ ### Configuration
8
+
9
+ View all the required and optional properties for `state.configuration` in the
10
+ official
11
+ [configuration-schema](https://docs.openfn.org/adaptors/packages/mongodb-configuration-schema/)
12
+ definition.
16
13
 
17
14
  ### insertDocuments
18
15
 
@@ -42,8 +39,6 @@ findDocuments({
42
39
  });
43
40
  ```
44
41
 
45
- [Docs](docs/index)
46
-
47
42
  ## Development
48
43
 
49
44
  Clone the [adaptors monorepo](https://github.com/OpenFn/adaptors). Follow the
@@ -6,20 +6,29 @@
6
6
  "type": "string",
7
7
  "description": "Your MongoDB cluster / host URL",
8
8
  "format": "uri",
9
- "minLength": 1
9
+ "minLength": 1,
10
+ "examples": [
11
+ "yourCluster-xxxyzzz.mongodb.net"
12
+ ]
10
13
  },
11
14
  "username": {
12
15
  "title": "Username",
13
16
  "type": "string",
14
17
  "description": "Your MongoDB instance username",
15
- "minLength": 1
18
+ "minLength": 1,
19
+ "examples": [
20
+ "admin"
21
+ ]
16
22
  },
17
23
  "password": {
18
24
  "title": "Password",
19
25
  "type": "string",
20
26
  "description": "Your MongoDB instance password",
21
27
  "writeOnly": true,
22
- "minLength": 1
28
+ "minLength": 1,
29
+ "examples": [
30
+ "@secret(!)Pass"
31
+ ]
23
32
  }
24
33
  },
25
34
  "type": "object",
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@openfn/language-mongodb",
3
- "version": "1.0.4",
3
+ "version": "1.0.6",
4
4
  "description": "A language package for working with MongoDb",
5
5
  "main": "dist/index.cjs",
6
6
  "author": "Open Function Group",