docs: add README

raystack · May 30, 2022 · 34a8450 · 34a8450
1 parent 7bee671
commit 34a8450
Show file tree

Hide file tree

Showing 3 changed files with 40 additions and 1 deletion.
diff --git a/docs/docs/reference/extractors.md b/docs/docs/reference/extractors.md
@@ -41,6 +41,7 @@ Meteor currently support metadata extraction on these data sources. To perform e
 | Type                                                                                     | Email | Username | FullName | Title | IsActive | ManagerEmail | Profiles | Memberships | facets | common |
 |:-----------------------------------------------------------------------------------------|:------|:---------|:---------|:------|:---------|:-------------|:---------|:------------|:-------|:-------|
 | [`github`](https://github.com/odpf/meteor/tree/main/plugins/extractors/github/README.md) | ✅     | ✅        | ✅        | ☐     | ✅        | ☐            | ☐        | ☐           | ☐      | ☐      |
+| [`shield`](https://github.com/odpf/meteor/tree/main/plugins/extractors/shield/README.md) | ✅     | ✅        | ✅        | ☐     | ✅        | ☐            | ☐        | ✅           | ✅      | ☐      |
 
 ### Bucket
 

diff --git a/plugins/extractors/shield/README.md b/plugins/extractors/shield/README.md
@@ -0,0 +1,38 @@
+# shield
+
+## Usage
+
+```yaml
+source:
+  type: shield
+  config:
+    host: shield.com:80
+```
+
+## Inputs
+
+| Key | Value | Example | Description |    |
+| :-- | :---- | :------ | :---------- | :- |
+| `host` | `string` | `shield.com:80` | Shield' GRPC host | *required* |
+
+## Outputs
+
+| Field                   | Sample Value                              |
+|:------------------------|:------------------------------------------|
+| `resource.urn`          | `shield::https://shield-host.com/jonsnow` |
+| `resource.name`         | `Jon Snow`                                |
+| `resource.service`      | `shield`                                  |
+| `resource.type`         | `user`                                    |
+| `resource.description`  | `sample user description`                 |
+| `email`                 | `[email protected]`                      |
+| `username`              | `jonsnow`                                 |
+| `full_name`             | `Jon Snow`                                |
+| `status`                | `active`                                  |
+| `memberships.group_urn` | `grpname:grpId`                           |
+| `memberships.role`      | `rolename`                                |
+| `timestamp.create_time` | `12432`                                   |
+| `timestamp.updatetime`  | `90242`                                   |
+
+## Contributing
+
+Refer to the [contribution guidelines](../../../docs/contribute/guide.md#adding-a-new-extractor) for information on contributing to this module.
diff --git a/plugins/extractors/shield/testdata/expected.json b/plugins/extractors/shield/testdata/expected.json
@@ -57,4 +57,4 @@
       }
     ]
   }
-]
+]
-Original file line number
+Diff line change
@@ Expand Up / @@ -57,4 +57,4 @@ @@
           }
         ]
       }
-    ]
+    ]