Referans Islem Modelleri

İşlem, SQL, endpoint ve parametre alanları

English · Türkçe · Languages / Diller

Kapsam: JSON API Forge 0.5.1 · İnceleme: 17 Eylül 2026 · Dil: Türkçe

Bu tablo sabit committeki Pydantic modeli ve JSON Schema’dan üretilmiştir. Kullanım açıklamaları: SQL RPC, Python hooks.

“Zorunlu” alanın JSON’da bulunma zorunluluğudur; null kabulü ayrı bir tür kuralıdır. Model() varsayılanı, ilgili modelin bu sayfalardaki varsayılanlarıyla oluşturulmasıdır. Boş liste/nesne varsayılanları her model için ayrı üretilir. —, varsayılan veya o sütunda şema sınırı olmadığını belirtir.

Tablodaki sınırlara ek olarak alanlar arası doğrulayıcılar vardır: izin/public seçimi, URL/host güvenliği, tenant/owner sütunları, cache/idempotency/transaction birlikteliği, şema çakışmaları ve güvenli regex bunlara dahildir. JSON Schema doğrulaması tek başına forge validate yerine geçmez. extra="forbid" nedeniyle bilinmeyen alanlar reddedilir.

OperationConfig

Alan	Tür	Zorunlu	Varsayılan	Şema sınırları
name	string	Evet	—	—
path	string | null	Hayır	null	—
method	enum ["GET","POST","PUT","PATCH","DELETE"]	Hayır	"POST"	—
database	string	Hayır	"primary"	—
public	boolean	Hayır	false	—
permission	string | null	Hayır	null	—
transaction	boolean	Hayır	true	—
input_schema	object | null	Hayır	null	—
parameters	list[RequestParameterSpec]	Hayır	[]	—
statements	list[SQLStatementConfig]	Hayır	[]	—
allow_ddl	boolean	Hayır	false	—
idempotency	boolean	Hayır	false	—
idempotency_ttl_seconds	integer	Hayır	86400	min=60; max=31536000
idempotency_cleanup_batch_size	integer	Hayır	1000	min=10; max=50000
idempotency_max_response_bytes	integer	Hayır	262144	min=1024; max=16777216
cache	OperationCacheConfig	Hayır	OperationCacheConfig()	—
invalidate_resources	list[string]	Hayır	[]	—
invalidate_operations	list[string]	Hayır	[]	—
summary	string | null	Hayır	null	—
description	string | null	Hayır	null	—
tags	list[string]	Hayır	[]	—
deprecated	boolean	Hayır	false	—
background_hooks	list[string]	Hayır	[]	—
dependencies	list[string]	Hayır	[]	—

SQLStatementConfig

Alan	Tür	Zorunlu	Varsayılan	Şema sınırları
sql	string	Evet	—	—
mode	enum ["execute","fetch_one","fetch_all","scalar"]	Hayır	"execute"	—
params	object	Hayır	{}	—
result_name	string | null	Hayır	null	—
max_rows	integer	Hayır	1000	min=1; max=100000
require_rowcount_min	integer | null	Hayır	null	min=0
require_rowcount_max	integer | null	Hayır	null	min=0

OperationCacheConfig

Alan	Tür	Zorunlu	Varsayılan	Şema sınırları
enabled	boolean	Hayır	false	—
ttl_seconds	integer	Hayır	15	min=1
stale_ttl_seconds	integer | null	Hayır	null	min=0
vary_by_principal	boolean	Hayır	true	—

CustomEndpointConfig

Alan	Tür	Zorunlu	Varsayılan	Şema sınırları
path	string	Evet	—	—
method	string	Hayır	"GET"	—
public	boolean	Hayır	false	—
permission	string | null	Hayır	null	—
handler	string	Evet	—	—
summary	string | null	Hayır	null	—
description	string | null	Hayır	null	—
tags	list[string]	Hayır	[]	—
deprecated	boolean	Hayır	false	—
include_in_schema	boolean	Hayır	true	—
input_schema	object | null	Hayır	null	—
input_mode	enum ["json","form","text","bytes","none"]	Hayır	"json"	—
parameters	list[RequestParameterSpec]	Hayır	[]	—
dependencies	list[string]	Hayır	[]	—
background_hooks	list[string]	Hayır	[]	—
response	ResponseSpec	Hayır	ResponseSpec()	—
openapi_extra	object | null	Hayır	null	—

DependencySpec

Alan	Tür	Zorunlu	Varsayılan	Şema sınırları
name	string	Evet	—	—
callable	string	Evet	—	—
use_cache	boolean	Hayır	true	—

RequestParameterSpec

Alan	Tür	Zorunlu	Varsayılan	Şema sınırları
name	string	Evet	—	—
location	enum ["query","header","cookie","path"]	Hayır	"query"	—
type	enum ["string","integer","number","boolean"]	Hayır	"string"	—
required	boolean	Hayır	false	—
default	Any	Hayır	null	—
description	string | null	Hayır	null	—
enum	list[Any] | null	Hayır	null	—
minimum	number | null	Hayır	null	—
maximum	number | null	Hayır	null	—
min_length	integer | null	Hayır	null	min=0
max_length	integer | null	Hayır	null	min=0
pattern	string | null	Hayır	null	—

ResponseSpec

Alan	Tür	Zorunlu	Varsayılan	Şema sınırları
kind	enum ["json","text","html","redirect","stream","file","empty"]	Hayır	"json"	—
media_type	string | null	Hayır	null	—
headers	dict[str, string]	Hayır	{}	—
filename	string | null	Hayır	null	—
status_code	integer | null	Hayır	null	—

Kaynak ve doğrulama

Bu sayfa aşağıdaki sabit commitlerdeki davranışı açıklar. Yeni bir sürümde aynı davranışın sürdüğünü varsaymayın.

• main/framework/config.py
• main/schemas/project.schema.json
• main/framework/validation.py

---

Wiki ana sayfa · Tüm sayfalar · Sürüm ve bakım