Skip to content

Document how groups filter the search, page content and assistant APIs #8428

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

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

Document how groups filter the search, page content and assistant APIs #8428

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e60f251
Document how groups filter the search, page content and assistant APIs
cursoragent Nov 12, 2026
83031d6
Describe groups filtering as on for every site
cursoragent Nov 12, 2026
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
6 changes: 3 additions & 3 deletions discovery-openapi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -242,7 +242,7 @@
"items": {
"type": "string"
},
"description": "Optional array of group identifiers to filter results. The assistant can retrieve protected content unless you pass `groups`. Mintlify doesn't verify group membership, so your backend must choose the groups for each user."
"description": "Optional groups of the user the assistant answers for. When you pass `groups`, the assistant reads public pages, pages open to any signed-in user, and pages restricted to at least one of these groups. An empty array means a signed-in user with no groups. If you omit `groups`, the assistant can retrieve all content, including protected pages. `<Visibility>` sections for signed-in readers or for specific groups follow the same rules. Mintlify doesn't verify group membership, so your backend must choose the groups for each user."
}
},
"description": "Optional filter criteria for the search."
Expand Down Expand Up @@ -362,7 +362,7 @@
"items": {
"type": "string"
},
"description": "Optional documentation groups that narrow results. The assistant API key can read all content, including protected pages. If omitted or empty, includes protected pages in results. Mintlify doesn't verify group membership, so your backend must choose the groups for each user. On password-protected deployments, `groups` doesn't restrict anything."
"description": "Optional groups of the user you're reading for. When you pass groups, the content includes public pages, pages open to any signed-in user, and pages restricted to at least one of these groups, and `<Visibility>` sections the user can't see are removed from the page. An empty array means a signed-in user with no groups. If you omit `groups`, the API key can read all content, including protected pages. Mintlify doesn't verify group membership, so your backend must choose the groups for each user. On password-protected deployments, `groups` doesn't restrict anything."
}
}
}
Expand Down Expand Up @@ -492,7 +492,7 @@
"items": {
"type": "string"
},
"description": "Optional documentation groups that narrow results. The assistant API key can read all content, including protected pages. If omitted or empty, includes protected pages in results. Mintlify doesn't verify group membership, so your backend must choose the groups for each user. On password-protected deployments, `groups` doesn't restrict anything."
"description": "Optional groups of the user you're searching for. When you pass `groups`, results include public pages, pages open to any signed-in user, and pages restricted to at least one of these groups. An empty array means a signed-in user with no groups. If you omit `groups`, the API key can read all content, including protected pages. `<Visibility>` sections for signed-in readers or for specific groups follow the same rules. Mintlify doesn't verify group membership, so your backend must choose the groups for each user. On password-protected deployments, `groups` doesn't restrict anything."
}
}
}
Expand Down
Loading