Skip to content

Commit e3fa581

Browse files
orabeCopilot
andcommitted
Update README.md to include new script for removing certificates and enhance student lookup instructions
Co-authored-by: Copilot <copilot@github.com>
1 parent 941d901 commit e3fa581

1 file changed

Lines changed: 12 additions & 1 deletion

File tree

backend/README.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ backend/
2525
security.py
2626
scripts/
2727
create_certificate.py
28+
remove_certificate.py
2829
seed_demo_data.py
2930
requirements.txt
3031
README.md
@@ -58,10 +59,19 @@ backend/
5859
- `GET /health` — API health check
5960
- `GET /verify/{certificate_id}` — Verify a certificate
6061
- `POST /admin/certificates` — Create a certificate (admin, API key required)
61-
- `DELETE /admin/certificates/{certificate_id}` — Delete a certificate (admin, API key required)
62+
- `GET /admin/students/{student_id}` — Look up a student and their certificates (admin, API key required)
63+
- `DELETE /admin/certificates/student/{student_id}` — Delete all certificates for a student (admin, API key required)
6264

6365
## Issuing a Certificate
6466
- Use the admin API or run `python scripts/create_certificate.py` interactively.
67+
- The script now asks for a `student_id` primary key and the student name.
68+
69+
## Removing a Certificate
70+
- Run `python scripts/remove_certificate.py S12345`
71+
72+
## Looking Up a Student
73+
- Run `python scripts/view_student.py S12345`
74+
- Or call the admin API: `GET /admin/students/{student_id}`
6575

6676
## Revocation
6777
Revocation support has been removed from this codebase. Certificates cannot be revoked via the API.
@@ -86,6 +96,7 @@ Revocation support has been removed from this codebase. Certificates cannot be r
8696

8797
## Certificate PDF Integration
8898
- Each certificate should display:
99+
- Student ID
89100
- Certificate ID (e.g. MCL-2026-XXXXXX)
90101
- Verification URL: `https://mathcodelab.de/verify/?id={certificate_id}`
91102
- (Optional) QR code to the same URL

0 commit comments

Comments
 (0)