mirror of
https://github.com/prowler-cloud/prowler.git
synced 2026-01-25 02:08:11 +00:00
7f2fa275c6
Co-authored-by: Rubén De la Torre Vico <ruben@prowler.com> Co-authored-by: Adrián Jesús Peña Rodríguez <adrianjpr@gmail.com> Co-authored-by: Pepe Fagoaga <pepe@prowler.com>
22 lines
628 B
Markdown
22 lines
628 B
Markdown
# API Documentation
|
|
|
|
## Local Documentation
|
|
|
|
For API-related patterns, see:
|
|
|
|
- `api/src/backend/api/models.py` - Models, Providers, UID validation
|
|
- `api/src/backend/api/v1/views.py` - ViewSets, RBAC patterns
|
|
- `api/src/backend/api/v1/serializers.py` - Serializers
|
|
- `api/src/backend/api/rbac/permissions.py` - RBAC functions
|
|
- `api/src/backend/tasks/tasks.py` - Celery tasks
|
|
- `api/src/backend/api/db_utils.py` - rls_transaction
|
|
|
|
## Contents
|
|
|
|
The documentation covers:
|
|
- Row-Level Security (RLS) implementation
|
|
- RBAC permission system
|
|
- Provider validation patterns
|
|
- Celery task orchestration
|
|
- JSON:API serialization format
|