Skip to content

Import Route Rehearsals

Import route rehearsals are non-default gateway proofs for docx-import-service. They keep deploy/gateway/routes.json legacy-safe while exercising one native slice at a time.

Static Targets

Run the route-table guards before live or browser proof:

bash
make test-gateway-route-examples
make test-import-create-routes
make test-teacher-docx-fast-routes
make test-import-ocr-mathtype-routes
make test-import-status-routes
make test-import-approval-routes
make test-import-review-roundtrip-routes

test-import-review-roundtrip-routes validates both the single-route split tables and the combined table:

  • deploy/gateway/routes.import-review-native-{example,localhost-example}.json
  • deploy/gateway/routes.import-detail-native-{example,localhost-example}.json
  • deploy/gateway/routes.import-review-roundtrip-native-{example,localhost-example}.json

test-gateway-route-examples validates the local native DOCX QAS demo table:

  • deploy/gateway/routes.native-example.json

test-import-ocr-mathtype-routes validates the owner-scoped OCR/MathType candidate tables:

  • deploy/gateway/routes.import-ocr-mathtype-native-example.json
  • deploy/gateway/routes.import-ocr-mathtype-native-localhost-example.json

They route browser multipart upload only to document-service /v1/import-sources, then route OCR/MathType create, reprocess, MathType artifact download, and job detail to docx-import-service. Every route requires auth, organization, and ADMIN/TEACHER; the default table must contain none of these native names and keeps broad /api/exam-import legacy.

test-teacher-docx-fast-routes validates the bounded Teacher DOCX Fast table:

  • deploy/gateway/routes.teacher-docx-fast-native-example.json
  • deploy/gateway/routes.teacher-docx-fast-native-localhost-example.json

It permits only owner-scoped multipart source upload, DOCX Fast create, exact job detail reload, review save, and Question Bank approval before the broad legacy import route. Use the localhost table for a candidate browser rehearsal; it is not a default route promotion.

The end-to-end Physics candidate composes this DOCX slice with Question Bank, exam, print export, and attempt routes in DOCX Physics Gateway Attempt Proof.

Live Runtime

For save-then-reload review proof, start the gateway with:

bash
GATEWAY_ROUTE_TABLE=deploy/gateway/routes.import-review-roundtrip-native-localhost-example.json

For a single route investigation, use the matching split table:

bash
GATEWAY_ROUTE_TABLE=deploy/gateway/routes.import-review-native-localhost-example.json
GATEWAY_ROUTE_TABLE=deploy/gateway/routes.import-detail-native-localhost-example.json

Do not promote default import routes from static route proof alone. Browser or live runtime proof must use frontend-through-gateway traffic and record the exact route table.

Rollback

Rollback is switching api-gateway back to:

bash
GATEWAY_ROUTE_TABLE=deploy/gateway/routes.json

After rollback, rerun the static target for the changed slice and confirm the default table still does not include the native import route names.

Go-platform documentation is generated from repository Markdown.