Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add custom objects beta API documentation #96

Open
wants to merge 8 commits into
base: main
Choose a base branch
from

Conversation

shivansh
Copy link

@shivansh shivansh commented Oct 1, 2024

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) ✅

Copy link

github-actions bot commented Oct 1, 2024

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

github-actions bot commented Oct 1, 2024

Copy link

github-actions bot commented Oct 1, 2024

Copy link

github-actions bot commented Oct 1, 2024

Copy link

github-actions bot commented Oct 1, 2024

Copy link

github-actions bot commented Oct 1, 2024

Copy link

github-actions bot commented Oct 1, 2024

Copy link

github-actions bot commented Oct 3, 2024

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

github-actions bot commented Oct 3, 2024

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

github-actions bot commented Oct 3, 2024

@shivansh shivansh changed the title docs: add custom objects API documentation docs: add custom objects beta API documentation Oct 3, 2024
@shivansh shivansh marked this pull request as ready for review October 3, 2024 05:11
@shivansh shivansh requested a review from a team as a code owner October 3, 2024 05:11
Comment on lines +71 to +72
"is_custom_leaf_type": true,
"id_prefix": "CAMP"
Copy link

@praneethratna praneethratna Oct 3, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we add definitions about is_custom_leaf_type and id_prefix?

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

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
"$custom_fields.ctype__target_audience",
"$custom_fields.tnt__target_audience",

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice catch!

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

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice catch.

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

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
}
},
"custom_schema_spec": {
"tenant_fragment": true
}

Copy link
Author

@shivansh shivansh Oct 3, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link

github-actions bot commented Oct 3, 2024

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants