Skip to content

Commit 940e2b9

Browse files
committed
Code review fixes.
1 parent ca048a8 commit 940e2b9

File tree

6 files changed

+31
-33
lines changed

6 files changed

+31
-33
lines changed

fern/docs/pages/adaas/delete-phases.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,23 +6,23 @@ In the most common extraction use cases, there is nothing to do and snap-ins may
66
### Triggering event
77

88
Airdrop initiates the data delete phase when the sync is deleted from DevRev.
9-
It is started by sending the worker a message with eventType: `EXTRACTION_DATA_DELETE`.
9+
It is started by sending the worker a message with with event of type `EVENT_TYPE`: `EXTRACTION_DATA_DELETE`.
1010

1111
### Snap-in response
1212

13-
The worker must respond to Airdrop with a message with eventType `EXTRACTION_DATA_DELETE_DONE` when done or
13+
The worker must respond to Airdrop with a message with with event of type `EVENT_TYPE` `EXTRACTION_DATA_DELETE_DONE` when done or
1414
`EXTRACTION_DATA_DELETE_ERROR` in case of an error.
1515

1616
## Attachments deletion
1717

1818

1919
### Triggering event
2020

21-
Airdrop initiates the attachments delete phase when the Sync is deleted from DevRev.
22-
It is started by sending the span-in a message with eventType: `EXTRACTION_ATTACHMENTS_DELETE`.
21+
Airdrop initiates the attachments delete phase when the sync data is deleted from DevRev.
22+
It is started by sending the span-in a message with with event of type `EVENT_TYPE`: `EXTRACTION_ATTACHMENTS_DELETE`.
2323

2424
### Snap-in response
2525

26-
The snap-in must respond to Airdrop with a message with eventType `EXTRACTION_ATTACHMENTS_DELETE_DONE` when done,
26+
The snap-in must respond to Airdrop with a message with with event of type `EVENT_TYPE` `EXTRACTION_ATTACHMENTS_DELETE_DONE` when done,
2727
or `EXTRACTION_ATTACHMENTS_DELETE_ERROR` in case of an error.
2828

fern/docs/pages/adaas/extracting-attachments.mdx

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,27 @@
1-
For the attachment extraction phase of the import process, the extractor has to upload each attachment to DevRev’s S3 using the `S3Interact` API.
1+
For the attachment extraction phase of the import process, the extractor has to upload each attachment to DevRev’s S3
2+
using the `S3Interact` API.
23

34
## Triggering event
45

5-
Airdrop initiates the Attachment Extraction by starting the snap-in with a message with eventType `EXTRACTION_ATTACHMENTS_START`
6-
when transitioning to the Data Extraction phase.
6+
Airdrop initiates the attachment extraction by starting the snap-in with a message with with event of type `EVENT_TYPE` `EXTRACTION_ATTACHMENTS_START`
7+
when after the data is extracted, transformed and loaded to DevRev.
78

8-
During the Attachment Extraction phase,
9-
the snap-in extracts attachments from the External System and uploads them as Artifacts to DevRev.
9+
During the attachment extraction phase,
10+
the snap-in extracts attachments from the external system and uploads them as artifacts to DevRev.
1011

11-
The snap-in must respond to Airdrop with a message with eventType `EXTRACTION_ATTACHMENTS_PROGRESS` together with an optional progress estimate and relevant Artifacts
12+
The snap-in must respond to Airdrop with a message with with event of type `EVENT_TYPE` `EXTRACTION_ATTACHMENTS_PROGRESS` together with an optional progress estimate and relevant Artifacts
1213
when it extracts some data and the maximum snap-in runtime (12 minutes) has been reached.
1314

14-
The snap-in must respond to Airdrop with a message with eventType `EXTRACTION_ATTACHMENTS_DELAY` and specify a back-off time
15-
when the extraction has been rate-limited by the External System and back-off is required.
15+
The snap-in must respond to Airdrop with a message with with event of type `EVENT_TYPE` `EXTRACTION_ATTACHMENTS_DELAY` and specify a back-off time
16+
when the extraction has been rate-limited by the external system and back-off is required.
1617

17-
In both cases, Airdrop starts the snap-in with a message with eventType `EXTRACTION_ATTACHMENTS_CONTINUE`.
18+
In both cases, Airdrop starts the snap-in with a message with with event of type `EVENT_TYPE` `EXTRACTION_ATTACHMENTS_CONTINUE`.
1819
The restart is immediate (in case of `EXTRACTION_ATTACHMENTS_PROGRESS`) or delayed
1920
(in case of `EXTRACTION_ATTACHMENTS_DELAY`).
2021

21-
Once the Attachment Extraction phase is done, the snap-in must respond to Airdrop with a message with eventType `EXTRACTION_ATTACHMENTS_DONE`.
22+
Once the attachment extraction phase is done, the snap-in must respond to Airdrop with a message with with event of type `EVENT_TYPE` `EXTRACTION_ATTACHMENTS_DONE`.
2223

23-
If Attachment Extraction failed, the snap-in must respond to Airdrop with a message with eventType `EXTRACTION_ATTACHMENTS_ERROR`.
24+
If attachment extraction failed, the snap-in must respond to Airdrop with a message with with event of type `EVENT_TYPE` `EXTRACTION_ATTACHMENTS_ERROR`.
2425

2526
## Snap-in response
2627

fern/docs/pages/adaas/extracting-data.mdx

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,25 +8,25 @@ so that it can extract only items created and/or updated since this date in the
88

99
## Triggering event
1010

11-
Airdrop initiates data extraction by starting the snap-in with a message with eventType `EXTRACTION_DATA_START`
11+
Airdrop initiates data extraction by starting the snap-in with a message with with event of type `EVENT_TYPE` `EXTRACTION_DATA_START`
1212
when transitioning to the data extraction phase.
1313

1414
During the data extraction phase, the snap-in extracts data from an external system,
1515
prepares batches of data and uploads them in the form of Artifacts to DevRev.
1616

17-
The snap-in must respond to Airdrop with a message with eventType `EXTRACTION_DATA_PROGRESS`,
17+
The snap-in must respond to Airdrop with a message with with event of type `EVENT_TYPE` `EXTRACTION_DATA_PROGRESS`,
1818
together with an optional progress estimate and relevant artifacts
1919
when it extracts some data and the maximum ADaaS snap-in runtime (12 minutes) has been reached.
2020

2121
If the extraction has been rate-limited by the external system and back-off is required, the snap-in must respond to
22-
Airdrop with a message with eventType `EXTRACTION_DATA_DELAY` and specifying back-off time with `delay` attribute.
22+
Airdrop with a message with with event of type `EVENT_TYPE` `EXTRACTION_DATA_DELAY` and specifying back-off time with `delay` attribute.
2323

24-
In both cases, Airdrop starts the snap-in with a message with eventType `EXTRACTION_DATA_CONTINUE`.
24+
In both cases, Airdrop starts the snap-in with a message with with event of type `EVENT_TYPE` `EXTRACTION_DATA_CONTINUE`.
2525
The restarting is immediate (in case of `EXTRACTION_DATA_PROGRESS`) or delayed (in case of `EXTRACTION_DATA_DELAY`).
2626

27-
Once the data extraction is done, the snap-in must respond to Airdrop with a message with eventType `EXTRACTION_DATA_DONE`.
27+
Once the data extraction is done, the snap-in must respond to Airdrop with a message with with event of type `EVENT_TYPE` `EXTRACTION_DATA_DONE`.
2828

29-
If data extraction failed in any moment of extraction, the snap-in must respond to Airdrop with a message with eventType `EXTRACTION_DATA_ERROR`.
29+
If data extraction failed in any moment of extraction, the snap-in must respond to Airdrop with a message with with event of type `EVENT_TYPE` `EXTRACTION_DATA_ERROR`.
3030

3131
## Snap-in response
3232

fern/docs/pages/adaas/extracting-external-sync-units.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,12 +17,12 @@ For GitHub, this would be the repository, for example `cli` in `github.com/devre
1717

1818
External sync unit extraction is executed only during the initial import.
1919
It extracts external sync units available in the external system,
20-
so that the end user can choose which external sync unit should be airdropped.
20+
so that the end user can choose which external sync unit should be airdropped during the creation of an **Import** on DevRev App.
2121

22-
Airdrop initiates the external sync unit extraction phase by starting the worker with a message with eventType:
22+
Airdrop initiates the external sync unit extraction phase by starting the worker with a message with with event of type `EVENT_TYPE`:
2323
`EXTRACTION_EXTERNAL_SYNC_UNITS_START` to start the external sync unit extraction.
2424

25-
The snap-in must respond to Airdrop with a message with `eventType` `EXTRACTION_EXTERNAL_SYNC_UNITS_DONE`
25+
The snap-in must respond to Airdrop with a message with `with event of type `EVENT_TYPE`` `EXTRACTION_EXTERNAL_SYNC_UNITS_DONE`
2626
with a list of external sync units as a payload, or `EXTRACTION_EXTERNAL_SYNC_UNITS_ERROR` in case of an error.
2727

2828
## Snap-in response

fern/docs/pages/adaas/extracting-metadata.mdx

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,18 @@
11

22
During the extract metadata phase, the ADaaS snap-in must provide an `external_domain_metadata.json` file on each sync run. This file provides a structured way of describing external system's domain system, describe its domain entities, types, and what are their relationships, and other metadata.
33

4-
The `external_domain_metadata.json` is submitted in each sync run and is one of the input for the transformation phase.
5-
64
The extraction function of the snap-in must provide a valid metadata file. DevRev provides a JSON schema and a CLI tool `chef-cli` to validate the proposed schema.
75

86

97
## Triggering event
108

11-
Airdrop initiates the Metadata Extraction by starting the snap-in with a message with eventType: `EXTRACTION_METADATA_START`.
9+
Airdrop initiates the Metadata Extraction by starting the snap-in with a message with with event of type `EVENT_TYPE`: `EXTRACTION_METADATA_START`.
1210

1311
During the Metadata Extraction phase,
1412
the snap-in extracts relevant metadata from an External System
1513
to prepare and upload the Initial Domain Mapping to DevRev.
1614

17-
The snap-in must respond to Airdrop with a message with eventType `EXTRACTION_METADATA_DONE` when done,
15+
The snap-in must respond to Airdrop with a message with with event of type `EVENT_TYPE` `EXTRACTION_METADATA_DONE` when done,
1816
or `EXTRACTION_METADATA_ERROR` in case of an error.
1917

2018
## Snap-in response

fern/docs/pages/adaas/getting-started.mdx

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ then `Create a new repository`.
1010
- [nodejs](https://nodejs.org/en/download/package-manager) (version 18.x.x+ or higher)
1111
4. Copy `Makefile.variable.example` to `Makefile.variable` and fill in the required variables.
1212
5. Configure a keyring for the external system in the `manifest.yaml`.
13-
See [Creating a Keyring](https://www.notion.so/Creating-a-Keyring-aa497671dc1b423fae70f7a0c14fba3a?pvs=21).
13+
See [Keyrings](../references/keyrings/introduction.mdx).
1414
6. Deploy a draft version of your Snap-In to you DevOrg using `make deploy`.
1515
7. Install the snap-in in your DevRev DevOrg on the web by navigating to **Settings** -> **Snap-ins** -> **Install snap-in**.
1616
8. Define the `Connection`.
@@ -24,7 +24,8 @@ They are called **Connections** in the DevRev app.
2424

2525
Keyrings provide a secure way to store and manage credentials within your DevRev Snap-In.
2626
This eliminates the need to expose sensitive information like passwords
27-
or access tokens directly within your code or configuration files, enhancing overall security.
27+
or access tokens directly within your code or configuration files, enhancing overall security. They also provide a valid
28+
token by abstracting Oauth token renewal from the end user.
2829

2930
A keyring is used by a worker to authenticate to the external system in API calls. They includes the key (for example,
3031
a PAT token or API key), its type, the organization ID for which a key is valid, and in some cases the organization name.
@@ -34,8 +35,6 @@ Read more about keyrings in the [developer documentation](/snapin-development/re
3435

3536
## Observability
3637

37-
snap-ins are snap-ins, and they inherit observability methodology from snap-ins.
38-
3938
To observe logs from your snap-in in your development environment use `devrev snap_in_package logs | jq`.
4039
To open logs in your favorite editor use `devrev snap_in_package logs | code -`
4140

0 commit comments

Comments
 (0)