documents modülü belge türlerini, varlıklara bağlı belgeleri, dosya indirmeli belge sürümlerini ve sürüm onay yaşam döngüsünü sunar. 23 uç noktanın tamamı /api/v1/documents altındadır. İş anlamı için Documents modülü sayfasına bakın.
Grup olguları¶
| Öğe | Değer | Kaynak |
|---|---|---|
| Temel yol | /api/v1/documents |
src/cluster_erp/core/module_base.py:37-38, src/cluster_erp/modules/documents/module.py:59 |
| Yönlendiriciler | 2 dosyada 2 yönlendirici nesnesi; Uç nokta özeti bölümünde listelenir | src/cluster_erp/modules/documents/module.py:48 |
| Uç noktalar | 23; register_routes ile bağlanan yönlendiricilerin yol dekoratörleri ve add_api_route çağrılarından sayıldı |
src/cluster_erp/modules/documents/documents/routes.py, src/cluster_erp/modules/documents/settings/routes.py |
| Kimlik doğrulama | Bearer başlığı veya oturum çerezi, get_current_user ile çözülür; bkz. Kimlik doğrulama ve başlıklar |
src/cluster_erp/modules/auth/guards.py:85-167 |
| Yetki koruması | 23 yolun 23 tanesi require_permission bildirir |
src/cluster_erp/modules/auth/guards.py:205-240 |
| Uygulama yetkilendirme kapısı | bağlanan her yönlendiricide require_app("documents") |
src/cluster_erp/modules/documents/module.py:63 |
| Hata biçimi | JSON gövdesi {"error": {...}}; bkz. Hatalar |
src/cluster_erp/server/error_handler.py:33-46 |
Uç nokta özeti¶
Alt modül klasörü başına bir satır. Yönlendirici öneki temel yola eklenir.
| Alt modül | Yönlendiriciler | Uç noktalar | Yönlendirici kaynağı |
|---|---|---|---|
settings |
router (/settings) |
7 | src/cluster_erp/modules/documents/settings/routes.py:20 |
documents |
router |
16 | src/cluster_erp/modules/documents/documents/routes.py:38 |
Belge türleri uç noktaları¶
Belge türü kayıtları ve varsayılanların tohumlanması.
| Yöntem | Yol | İşleyici | Yetki | İstek | Sorgu | Yanıt | Durum | Kaynak |
|---|---|---|---|---|---|---|---|---|
GET |
/api/v1/documents/settings/document-types/ |
list_document_types |
document_type.read |
yok | active_only, search |
list[DocumentTypeRead] |
200 (varsayılan) | src/cluster_erp/modules/documents/settings/routes.py:23 |
POST |
/api/v1/documents/settings/document-types/ |
create_document_type |
document_type.create |
DocumentTypeCreate |
yok | DocumentTypeRead |
201 |
src/cluster_erp/modules/documents/settings/routes.py:41 |
POST |
/api/v1/documents/settings/document-types/seed-defaults |
seed_document_type_defaults |
document_type.seed |
yok | yok | dict[str, int] |
200 (varsayılan) | src/cluster_erp/modules/documents/settings/routes.py:52 |
GET |
/api/v1/documents/settings/document-types/{type_id} |
get_document_type |
document_type.read |
yok | yok | DocumentTypeRead |
200 (varsayılan) | src/cluster_erp/modules/documents/settings/routes.py:61 |
PUT |
/api/v1/documents/settings/document-types/{type_id} |
update_document_type |
document_type.update |
DocumentTypeUpdate |
yok | DocumentTypeRead |
200 (varsayılan) | src/cluster_erp/modules/documents/settings/routes.py:74 |
POST |
/api/v1/documents/settings/document-types/bulk-delete |
bulk_delete_document_types |
document_type.bulk_delete |
BulkDeleteRequest |
yok | BulkDeleteResponse |
200 (varsayılan) | src/cluster_erp/modules/documents/settings/routes.py:88 |
DELETE |
/api/v1/documents/settings/document-types/{type_id} |
delete_document_type |
document_type.delete |
yok | yok | yok | 204 |
src/cluster_erp/modules/documents/settings/routes.py:99 |
Belgeler ve sürümler uç noktaları¶
Belge kayıtları, varlık türleri listesi, belge başına sürümler, sürüm dosyası indirme, onaya gönderme, etkinleştirme ve geri çekme.
| Yöntem | Yol | İşleyici | Yetki | İstek | Sorgu | Yanıt | Durum | Kaynak |
|---|---|---|---|---|---|---|---|---|
GET |
/api/v1/documents/documents/ |
list_documents |
document.read |
yok | search, active_only, document_type_id, entity_type, entity_id, limit, offset |
dict |
200 (varsayılan) | src/cluster_erp/modules/documents/documents/routes.py:59 |
GET |
/api/v1/documents/documents/entity-types |
list_document_entity_types |
document.read |
yok | yok | list |
200 (varsayılan) | src/cluster_erp/modules/documents/documents/routes.py:98 |
POST |
/api/v1/documents/documents/ |
create_document |
document.create |
DocumentCreate |
yok | DocumentRead |
201 |
src/cluster_erp/modules/documents/documents/routes.py:124 |
GET |
/api/v1/documents/documents/{document_id} |
get_document |
document.read |
yok | yok | DocumentRead |
200 (varsayılan) | src/cluster_erp/modules/documents/documents/routes.py:136 |
PUT |
/api/v1/documents/documents/{document_id} |
update_document |
document.update |
DocumentUpdate |
yok | DocumentRead |
200 (varsayılan) | src/cluster_erp/modules/documents/documents/routes.py:150 |
POST |
/api/v1/documents/documents/bulk-delete |
bulk_delete_documents |
document.bulk_delete |
BulkDeleteRequest |
yok | BulkDeleteResponse |
200 (varsayılan) | src/cluster_erp/modules/documents/documents/routes.py:165 |
DELETE |
/api/v1/documents/documents/{document_id} |
delete_document |
document.delete |
yok | yok | yok | 204 |
src/cluster_erp/modules/documents/documents/routes.py:177 |
GET |
/api/v1/documents/documents/{document_id}/versions |
list_versions |
document_version.read |
yok | yok | list[DocumentVersionRead] |
200 (varsayılan) | src/cluster_erp/modules/documents/documents/routes.py:194 |
POST |
/api/v1/documents/documents/{document_id}/versions |
create_version |
document_version.create |
DocumentVersionCreate |
yok | DocumentVersionRead |
201 |
src/cluster_erp/modules/documents/documents/routes.py:209 |
GET |
/api/v1/documents/versions/{version_id} |
get_version |
document_version.read |
yok | yok | DocumentVersionRead |
200 (varsayılan) | src/cluster_erp/modules/documents/documents/routes.py:226 |
GET |
/api/v1/documents/versions/{version_id}/file |
download_version_file |
document_version.read |
yok | yok | Response |
200 (varsayılan) | src/cluster_erp/modules/documents/documents/routes.py:240 |
PUT |
/api/v1/documents/versions/{version_id} |
update_version |
document_version.update |
DocumentVersionUpdate |
yok | DocumentVersionRead |
200 (varsayılan) | src/cluster_erp/modules/documents/documents/routes.py:270 |
DELETE |
/api/v1/documents/versions/{version_id} |
delete_version |
document_version.delete |
yok | yok | yok | 204 |
src/cluster_erp/modules/documents/documents/routes.py:285 |
POST |
/api/v1/documents/versions/{version_id}/submit-approval |
submit_for_approval |
document_version.submit_approval |
yok | yok | DocumentVersionRead |
200 (varsayılan) | src/cluster_erp/modules/documents/documents/routes.py:302 |
POST |
/api/v1/documents/versions/{version_id}/activate |
activate_version |
document_version.activate |
yok | yok | DocumentVersionRead |
200 (varsayılan) | src/cluster_erp/modules/documents/documents/routes.py:354 |
POST |
/api/v1/documents/versions/{version_id}/withdraw |
withdraw_version |
document_version.withdraw |
yok | yok | DocumentVersionRead |
200 (varsayılan) | src/cluster_erp/modules/documents/documents/routes.py:371 |
Hata kodları¶
Tablo, src/cluster_erp/modules/documents/ altındaki kodun attığı hata kodlarını listeler. Kodlar, AppError(...) çağrıları, src/cluster_erp/core/errors.py içindeki fabrikalar (not_found, conflict, protected, permission_denied, privilege_escalation, check_version) ve HTTPException(...) için yapılan bir sözdizimi ağacı taramasıyla bulundu. 400 durumu AppError varsayılanıdır (src/cluster_erp/core/errors.py:23). Koruma hataları (401, 403), yetkilendirme kodları ve doğrulama hataları (422) her yol için geçerlidir ve Hatalar sayfasında listelenir.
| Kod | HTTP durumu | Atıldığı yer | İlk konum |
|---|---|---|---|
APPROVAL_INVALID_STATE |
400 |
documents |
src/cluster_erp/modules/documents/documents/routes.py:319 |
DOCUMENT_NO_ATTACHMENT |
400 |
documents |
src/cluster_erp/modules/documents/documents/services.py:270 |
DOCUMENT_VERSION_INVALID_STATUS |
400, 404 |
documents |
src/cluster_erp/modules/documents/documents/services.py:230 |
RESOURCE_NOT_FOUND |
404 |
documents, settings |
src/cluster_erp/modules/documents/documents/routes.py:146 |
Yayımlanan olaylar¶
Tablo, src/cluster_erp/modules/documents/ altındaki kodun EventBus.emit çağrısına doğrudan verdiği sözleşme sınıflarını listeler; sözdizimi ağacı taramasıyla bulundu. Önce bir değişkene kurulan olaylar sayılmaz. Sözleşmeler Sözleşmeler başvurusu sayfasında anlatılır.
| Sözleşme | Konum sayısı | İlk konum |
|---|---|---|
DocumentCreated |
1 | src/cluster_erp/modules/documents/documents/services.py:121 |
DocumentVersionActivated |
1 | src/cluster_erp/modules/documents/documents/services.py:286 |
DocumentVersionSuperseded |
1 | src/cluster_erp/modules/documents/documents/services.py:330 |
İlgili sayfalar¶
92f8051 numaralı commit ile 2026-11-13 tarihinde doğrulandı.