Skip to content

Commit a3e61b2

Browse files
authored
Rate limiting and other minor updates (#25)
- Updated proxy server so that now you don't need export `PROXY_BASE_URL` variable anymore (and we set the proxy in conformance test script) - Minor updates in the `devrev-snapin-template.plain` - Update `docs/attachments-extraction.md` according to suggestions from https://codeplain.slack.com/archives/C08KCS9A830/p1758790879392599 - Added a generic template for data extraction in file `templates/data_extraction_acceptance_test.plain`, which should be utilized in any data extraction-related functional requirement. ## Related issues https://app.devrev.ai/devrev/works/ISS-161566
1 parent 9754609 commit a3e61b2

File tree

5 files changed

+330
-168
lines changed

5 files changed

+330
-168
lines changed

devrev-snapin-template.plain

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,10 @@
1111
- Please note that EventContextIn and EventContextOut interfaces are deprecated.
1212

1313
- The External Domain Metadata is a JSON object that describes the logical domain model of an external system. It defines the types of external record types, the relationships between those record types, and the metadata associated with each field, including the field’s data type, human-readable name, and other descriptive attributes.
14-
- Note: Resource "attachments" should not be included in The External Domain Metadata JSON object even if the external system supports attachments. This is handled automatically by The Airdrop SDK Library.
14+
- Note: Resource "attachments" *MUST NOT* be included in The External Domain Metadata JSON object even if the external system supports attachments. This is handled automatically by The Airdrop SDK Library.
1515

1616
- The Initial Domain Mapping is a JSON object that defines how the logical domain model described by The External Domain Metadata maps to the target domain model in DevRev. It specifies the correspondence between each external record type and DevRev leaf type, as well as the mapping of individual fields, including transformation logic, value conversions, and any fixed or default values.
17-
- Note: Resource "attachments" should not be included in The Initial Domain Mapping JSON object even if the external system supports attachments. This is handled automatically by The Airdrop SDK Library.
17+
- Note: Resource "attachments" *MUST NOT* be included in The Initial Domain Mapping JSON object even if the external system supports attachments. This is handled automatically by The Airdrop SDK Library.
1818

1919
- The External Sync Unit Item Count is a numeric field representing the total number of items (such as cards) contained within a given external sync unit. It is accessible as "item_count" field of the external sync unit.
2020

docs/attachments-extraction.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,7 @@ import {
3333

3434
const getAttachmentStream = async ({
3535
item,
36+
event,
3637
}: ExternalSystemAttachmentStreamingParams): Promise<ExternalSystemAttachmentStreamingResponse> => {
3738
// IMPORTANT: "url" is not necessarily deployed on the base URL of The API. It could also be an external URL (e.g. https://example.com/attachment.pdf, https://devrev.ai, ...)
3839
const { id, url } = item;
@@ -44,7 +45,7 @@ const getAttachmentStream = async ({
4445
responseType: 'stream',
4546
headers: {
4647
'Accept-Encoding': 'identity',
47-
'Authorization': ... // TODO: Authorization if needed
48+
'Authorization': ... // TODO: Authorization if needed. Credentials should be read from event["payload"]["connection_data"]["key"]
4849
},
4950
});
5051

0 commit comments

Comments
 (0)