Skip to content

DOCSP-45972: clarification regarding Database Trigger update endpoint #886

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.

Sign up for GitHub

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

Merged
hunter-mongo merged 3 commits into from
Jun 9, 2025
Merged

DOCSP-45972: clarification regarding Database Trigger update endpoint #886

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9bf5745
DOCSP-45972: clarification regarding Database Trigger update endpoint…
hunter-mongo Jun 6, 2025
95257e9
Added error message and resolution advice
hunter-mongo Jun 9, 2025
9b13526
Clearer and more accurate refinement
hunter-mongo Jun 9, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions source/openapi-admin-v3.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7431,8 +7431,9 @@ components:
description: |-
The name of a database in the linked data source. If you
omit this parameter, the Source Type changes to
"Deployment," unless you are on a shared tier, in which
case App Services will not let you save the trigger.
"Deployment," unless you are on a shared tier. If you are,
Copy link
Copy Markdown
Collaborator

@dacharyc dacharyc Jun 9, 2025

Choose a reason for hiding this comment

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

I think, per the ticket, we could be a little more explicit with our guidance here. It might be helpful to actually list the specific error message a user will get if they omit the database param. That way, a user can search for the specific error message and will find a result that explains the issue and how to resolve the problem.

Can you update this to include the error message, and advise shared-tier users to specify the database param to resolve this error?

Copy link
Copy Markdown
Collaborator

@dacharyc dacharyc Jun 9, 2025

Choose a reason for hiding this comment

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

Thanks for making this change, @hunter-mongo ! I think we can probably refine the wording further.

First, based on the error message we're documenting, I think the "unless you are on a shared tier" element is not quite accurate. Based on the error message, it seems that even on a shared tier, when you omit the DB param the Source Type still attempts to change to "Deployment." But because shared tier infrastructure does not support deployment changestreams, we reject the change. This may be pedantic, but I would say we could reword this description to something like:

If you omit this parameter, the Source Type changes to "Deployment." However, shared tier infrastructure does not support deployment changestreams. If you omit the database parameter, you receive the deployment changestreams are not supported on shared tier clusters error. Supply the database parameter to resolve this error.

It's more verbose, but I also think it's clearer and more accurate. What do you think?

Copy link
Copy Markdown
Contributor Author

@hunter-mongo hunter-mongo Jun 9, 2025

Choose a reason for hiding this comment

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

That is great and I agree that it is clearer!

App Services will not let you save the trigger unless
you include this parameter.
collection:
type: string
description: |-
Expand Down
Loading
⚡