FLCRM-21226: Document RAG document selections API#78
Draft
javoweb-fc wants to merge 1 commit into
Draft
Conversation
Adds OpenAPI documentation for the new offline RAG endpoints introduced
alongside the reference-document selection feature:
- GET /v2/forms/{form_id}/rag_document_selections.json
- PATCH /v2/forms/{form_id}/rag_document_selections/{id}.json
Also documents the new rag_enabled, rag_bundle_version, and
rag_bundle_download_url fields on the Form response object.
New schemas: RagDocumentSelection, RagDocumentSelectionsResponse,
RagDocumentSelectionResponse, RagDocumentSelectionUpdateRequest,
ForbiddenResponse.
Contributor
There was a problem hiding this comment.
Pull request overview
Note
Copilot couldn't run its full agentic review because no GitHub Actions runner was available. Make sure your repository has a runner available to run Copilot's review, or add a copilot-setup-steps.yml file specifying one with the runs-on attribute. See the docs for more details.
Documents the new offline RAG (reference document sync) API surface by extending the OpenAPI spec with new form fields, schemas, and endpoints for listing/updating document selection state.
Changes:
- Added new Form fields:
rag_enabled,rag_bundle_version,rag_bundle_download_url. - Introduced new schemas for RAG document selection resources and responses (including a 403 schema).
- Added endpoints to list selections and toggle selection state for a reference document.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+4363
to
+4374
| "id": { | ||
| "type": "integer", | ||
| "description": "Selection record ID" | ||
| }, | ||
| "form_resource_id": { | ||
| "type": "string", | ||
| "description": "The form this selection belongs to" | ||
| }, | ||
| "attachment_resource_id": { | ||
| "type": "string", | ||
| "description": "The reference file (attachment) this selection points to" | ||
| }, |
Comment on lines
+14027
to
+14033
| "name": "id", | ||
| "in": "path", | ||
| "description": "Attachment (reference file) resource ID", | ||
| "schema": { | ||
| "type": "string" | ||
| }, | ||
| "required": true |
Comment on lines
+14052
to
+14060
| "requestBody": { | ||
| "content": { | ||
| "application/json": { | ||
| "schema": { | ||
| "$ref": "#/components/schemas/RagDocumentSelectionUpdateRequest" | ||
| } | ||
| } | ||
| } | ||
| }, |
Comment on lines
+3461
to
+3473
| "rag_bundle_version": { | ||
| "type": [ | ||
| "string", | ||
| "null" | ||
| ], | ||
| "description": "The active bundle UUID compiled for offline use" | ||
| }, | ||
| "rag_bundle_download_url": { | ||
| "type": [ | ||
| "string", | ||
| "null" | ||
| ], | ||
| "description": "The secure CDN pre-signed download URL for the bundled RAG package" |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Documents the new offline RAG (reference document sync) API surface introduced in FLCRM-21226 (
fulcrumapp/fulcrumPR #10867).Changes
GET /v2/forms/{form_id}/rag_document_selections.json— list a form's reference documents merged with their offline RAG selection state.PATCH /v2/forms/{form_id}/rag_document_selections/{id}.json— enable/disable a reference document for offline RAG.rag-offline-syncfeature flag (403 if disabled).rag_enabled,rag_bundle_version,rag_bundle_download_url.RagDocumentSelection,RagDocumentSelectionsResponse,RagDocumentSelectionResponse,RagDocumentSelectionUpdateRequest,ForbiddenResponse.Related PRs (fulcrumapp/fulcrum)
Keeping this as a draft until the fulcrum-side PRs are green and reviewed.