docs: add frontend API validation guide#134
Open
SHAURYAKSHARMA24 wants to merge 1 commit into
Open
Conversation
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
Closes #132.
Adds frontend/API validation documentation for OpenShield covering the React/Vite frontend, Flask API endpoints, JWT behaviour, CORS/error handling, live mode setup, and frontend-to-backend data flow.
Changes
docs/validation/FRONTEND_API_TESTING.mddocs/validation/TEST_RESULTS.mdVITE_API_URLand JWT token handlingValidation Results
npm install: Passnpm run lint: Failed — 65 lint errors, mostly unused React importsnpm run build: Passnpm run dev: Pass — Vite starts on localhost:5173pytest: Failed —DATABASE_URLnot configured for PostgreSQL-backed testsKey Findings
api/app.pyfrontend/API_ENDPOINTS.txtappears outdated in areas including port references, AI endpoint paths, demo/live mode description, and endpoint statusDATABASE_URLSecurity
No secrets, JWT values, Azure credentials, database credentials,
.envfiles, or local environment files were committed.