docs: add custom objects beta API documentation #96

shivansh · 2024-10-01T06:32:29Z

https://app.devrev.ai/devrev/works/ISS-121317

The PR will be ready for review as soon as the custom object APIs are beta (in-progress) ✅

github-actions · 2024-10-01T06:36:04Z

Published docs preview URL: https://devrev-preview-80827ce4-234f-4e03-9b54-682e2ff467ba.docs.buildwithfern.com

github-actions · 2024-10-01T06:42:31Z

Published docs preview URL: https://devrev-preview-c9daac9c-4f3b-40c1-8778-722b694bf285.docs.buildwithfern.com

github-actions · 2024-10-01T06:43:57Z

Published docs preview URL: https://devrev-preview-a174b917-394c-4579-9adc-c0d2d0479ee1.docs.buildwithfern.com

fern/docs/pages/custom-objects.mdx

github-actions · 2024-10-01T06:45:08Z

Published docs preview URL: https://devrev-preview-52c08aaa-8d09-4720-83fd-0eb3ba3c126a.docs.buildwithfern.com

github-actions · 2024-10-01T07:17:58Z

Published docs preview URL: https://devrev-preview-affe9991-5843-429c-be3c-55785b001cd8.docs.buildwithfern.com

github-actions · 2024-10-01T07:25:29Z

Published docs preview URL: https://devrev-preview-52430336-ad60-4490-89ef-b19ec8899079.docs.buildwithfern.com

github-actions · 2024-10-01T07:28:34Z

Published docs preview URL: https://devrev-preview-a6ef437b-ebd2-4b04-9722-b13cbd0f4a04.docs.buildwithfern.com

github-actions · 2024-10-03T03:59:19Z

Published docs preview URL: https://devrev-preview-cb941932-2b3e-45b4-90b3-6488f9963567.docs.buildwithfern.com

github-actions · 2024-10-03T04:08:22Z

Published docs preview URL: https://devrev-preview-7d3760b2-117c-497d-aeec-21919a474458.docs.buildwithfern.com

github-actions · 2024-10-03T05:00:33Z

Published docs preview URL: https://devrev-preview-83c87e71-9d10-41fe-ac9b-82bdaa4bbfed.docs.buildwithfern.com

praneethratna · 2024-10-03T06:57:45Z

fern/docs/pages/custom-objects.mdx

+    "is_custom_leaf_type": true,
+    "id_prefix": "CAMP"


Can we add definitions about is_custom_leaf_type and id_prefix?

praneethratna · 2024-10-03T06:58:06Z

fern/docs/pages/custom-objects.mdx

+    "leaf_type": "campaign",
+    "filter": [
+      "eq",
+      "$custom_fields.ctype__target_audience",


Suggested change

"$custom_fields.ctype__target_audience",

"$custom_fields.tnt__target_audience",

Nice catch!

praneethratna · 2024-10-03T06:58:45Z

fern/docs/pages/custom-objects.mdx

+            "name": "campaigns",
+            "field_type": "array",
+            "base_type": "id",
+            "id_type": "custom_object.campaign",


Suggested change

"id_type": "custom_object.campaign",

"id_type": ["custom_object.campaign"],

Nice catch.

praneethratna · 2024-10-03T06:59:48Z

fern/docs/pages/custom-objects.mdx

+    "id": "don:core:dvrv-us-1:devo/demo:custom_object/campaign/1",
+    "custom_fields": {
+        "tnt__budget": 15000
+    }


Suggested change

}

},

"custom_schema_spec": {

"tenant_fragment": true

}

As discussed IRL, let's omit this as things work fine.

github-actions · 2024-10-03T11:00:59Z

Published docs preview URL: https://devrev-preview-1d949b8f-95be-44e5-af13-20df5b5977d7.docs.buildwithfern.com

github-actions · 2024-10-03T19:32:06Z

🌟 EkLine Reviewer

Hello! I’m here to help improve your docs. I’ve reviewed your pull request, and left in-line suggestions for quick fixes. For details, visit the Analytics Page.

For questions or feedback, please email support@ekline.io.

fern/docs/pages/custom-objects.mdx

bc-devrev · 2024-10-03T19:36:31Z

fern/docs/pages/custom-objects.mdx

+1. **Leaf Type**: The base type of your custom object (e.g., "campaign"). Note that for custom objects, `is_custom_leaf_type` must be set to `true` to differentiate it from standard DevRev objects.
+2. **Subtype**: A more specific categorization within a leaf type (e.g., "promotion" or "advertising" for a "campaign" leaf type).
+3. **Custom Fields**: User-defined fields that store specific data for your custom object.
+4. **Unique Key**: The `unique_key` is a unique identifier for each custom object. This is useful for maintaining idempotency when retrying custom object creation requests.


Suggested change

4. **Unique Key**: The `unique_key` is a unique identifier for each custom object. This is useful for maintaining idempotency when retrying custom object creation requests.

4. **Unique key**: A unique identifier for each custom object. This is useful for maintaining idempotency when retrying custom object creation requests.

fern/docs/pages/custom-objects.mdx

bc-devrev · 2024-10-03T19:38:01Z

fern/docs/pages/custom-objects.mdx

+For more details on customization concepts, please refer to the
+[Customization](./object-customization) documentation.
+
+## Custom object lifecycle


Move the contents of this section up to the lifecycle operations reference.

fern/docs/pages/custom-objects.mdx

github-actions · 2024-10-09T09:37:16Z

Published docs preview URL: https://devrev-preview-f2fafc2a-fe30-4c12-8e62-77d30370b4f0.docs.buildwithfern.com

github-actions · 2024-10-09T11:25:24Z

Published docs preview URL: https://devrev-preview-e63d971a-141c-43e8-8c1d-e1136a4ee4fa.docs.buildwithfern.com

github-actions · 2024-10-09T12:05:38Z

Published docs preview URL: https://devrev-preview-a5c87d67-6ca7-4e6a-8b48-5418e7973094.docs.buildwithfern.com

github-actions · 2024-10-11T06:17:31Z

Published docs preview URL: https://devrev-preview-56efe02c-4b4a-4206-9a49-c862bde7e19c.docs.buildwithfern.com

github-actions · 2024-10-11T06:20:42Z

Published docs preview URL: https://devrev-preview-fb91538d-0515-4085-b122-8943e187a46b.docs.buildwithfern.com

github-actions · 2024-10-11T06:32:59Z

Published docs preview URL: https://devrev-preview-03fa1e10-479a-4a1a-a863-50b4dd0f7a20.docs.buildwithfern.com

github-actions · 2024-10-11T07:40:25Z

Published docs preview URL: https://devrev-preview-d433d0c9-c833-4300-86b7-aea7f6305786.docs.buildwithfern.com

shivansh force-pushed the shivansh/custom-objects-docs branch from a414340 to 338f6d2 Compare October 1, 2024 06:38

docs: add custom objects API documentation

1e3a97d

shivansh force-pushed the shivansh/custom-objects-docs branch from 338f6d2 to 1e3a97d Compare October 1, 2024 06:40

Add link to customization.mdx

f817a42

shivansh commented Oct 1, 2024

View reviewed changes

fern/docs/pages/custom-objects.mdx Outdated Show resolved Hide resolved

Fix API payloads after local testing

c20a43a

shivansh added 2 commits October 1, 2024 12:51

Attempt to fix the reference to customization docs

713a782

Update headings as per guidelines

d60f276

Fix heading

6e378f0

shivansh force-pushed the shivansh/custom-objects-docs branch from 3d81199 to b26dec3 Compare October 3, 2024 04:06

Add extended use cases

dd654c9

shivansh force-pushed the shivansh/custom-objects-docs branch from b26dec3 to dd654c9 Compare October 3, 2024 04:58

shivansh changed the title ~~docs: add custom objects API documentation~~ docs: add custom objects beta API documentation Oct 3, 2024

shivansh marked this pull request as ready for review October 3, 2024 05:11

shivansh requested a review from a team as a code owner October 3, 2024 05:11

praneethratna reviewed Oct 3, 2024

View reviewed changes

praneethratna approved these changes Oct 3, 2024

View reviewed changes

Address review comments

20ddcc8

Atul-Butola requested a review from bc-devrev October 3, 2024 11:01

bc-devrev added the No EkLine Skip EkLine automated QA label Oct 3, 2024

bc-devrev requested changes Oct 3, 2024

View reviewed changes

Address review comments

66f7b03

Remove unnecessary heading

5020388

Update text after reordering the sections

b4654fb

Add final fixes

f834ec6

Add callout

8ea1468

Address automated review comments

6e50d96

shivansh requested a review from bc-devrev October 11, 2024 06:42

Add type metadata to code blocks

393a1f9

bc-devrev approved these changes Oct 11, 2024

View reviewed changes

shivansh merged commit 82d6d4f into main Oct 14, 2024
3 checks passed

shivansh deleted the shivansh/custom-objects-docs branch October 14, 2024 10:24

	"$custom_fields.ctype__target_audience",
	"$custom_fields.tnt__target_audience",

	"id_type": "custom_object.campaign",
	"id_type": ["custom_object.campaign"],

-    }
+    },
+    "custom_schema_spec": {
+        "tenant_fragment": true
+    }

	4. Unique Key: The `unique_key` is a unique identifier for each custom object. This is useful for maintaining idempotency when retrying custom object creation requests.
	4. Unique key: A unique identifier for each custom object. This is useful for maintaining idempotency when retrying custom object creation requests.

docs: add custom objects beta API documentation #96

docs: add custom objects beta API documentation #96

Uh oh!

Conversation

shivansh commented Oct 1, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented Oct 1, 2024

Uh oh!

github-actions bot commented Oct 1, 2024

Uh oh!

github-actions bot commented Oct 1, 2024

Uh oh!

Uh oh!

github-actions bot commented Oct 1, 2024

Uh oh!

github-actions bot commented Oct 1, 2024

Uh oh!

github-actions bot commented Oct 1, 2024

Uh oh!

github-actions bot commented Oct 1, 2024

Uh oh!

github-actions bot commented Oct 3, 2024

Uh oh!

github-actions bot commented Oct 3, 2024

Uh oh!

github-actions bot commented Oct 3, 2024

Uh oh!

praneethratna Oct 3, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

praneethratna Oct 3, 2024

Choose a reason for hiding this comment

Uh oh!

shivansh Oct 3, 2024

Choose a reason for hiding this comment

Uh oh!

praneethratna Oct 3, 2024

Choose a reason for hiding this comment

Uh oh!

shivansh Oct 3, 2024

Choose a reason for hiding this comment

Uh oh!

praneethratna Oct 3, 2024

Choose a reason for hiding this comment

Uh oh!

shivansh Oct 3, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Oct 3, 2024

Uh oh!

github-actions bot commented Oct 3, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🌟 EkLine Reviewer

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

bc-devrev Oct 3, 2024

Choose a reason for hiding this comment

Uh oh!

Uh oh!

bc-devrev Oct 3, 2024

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

github-actions bot commented Oct 9, 2024

Uh oh!

github-actions bot commented Oct 9, 2024

Uh oh!

github-actions bot commented Oct 9, 2024

Uh oh!

github-actions bot commented Oct 11, 2024

Uh oh!

github-actions bot commented Oct 11, 2024

shivansh commented Oct 1, 2024 •

edited

Loading

praneethratna Oct 3, 2024 •

edited

Loading

shivansh Oct 3, 2024 •

edited

Loading

github-actions bot commented Oct 3, 2024 •

edited

Loading