Ne Değişti (Sürüm Farkı)
/api/v1/library/{id}/changes
Ne Değişti (Sürüm Farkı)
Bir regülasyonun metni kaynağında yerinde güncellendiğinde, önceki metinle yeni metin arasındaki farkı ve revizyon geçmişini döner.
Parametre
id— regülasyon doküman ID'si (/libraryyanıtındakiid).
Yanıt
documentId— sorgulanan belge.latestRevisionNumber— en son uygulanmış revizyonun sıra numarası.truncated— fark, boyut sınırına takılıp kısaltıldıysatrue.latestDiff[]— düz (birleşik) fark; her satırtypevetexttaşır.oldLines[]/newLines[]— yan yana gösterim için satır satır hizalanmış iki pano.oldLines[i]ilenewLines[i]aynı satıra karşılık gelir.detectedAt,previousTitle,newTitle— son revizyonun başlık bilgisi.revisions[]— tüm revizyon geçmişi:revisionNumber,detectedAt,titleChanged,previousTitle,newTitle.files[]— yalnız zip paketlerinde: son revizyonun dosya bazında farkı (aşağıda). Paket olmayan belgede ve dosya farkı kaydedilmemiş eski revizyonlardanull(boş dizi değil).note— son revizyonun Türkçe notu ya danull. Doluysa değişiklik duyurulmuş ama yeni içerik okunamamıştır (örneğin kaynağın yayımladığı yeni paket boyut sınırını aştı); gösterilen içerik önceki sürümdür. Bu durumdalatestDiff,oldLinesvenewLinesboş,filesnullgelir — istemci fark yerine notu göstermelidir.
Paketlerde dosya bazında fark: files[]
Paketin değişmeyen dosyaları listede yoktur; paketin içindekiler listesi farka girmez. Her öğe:
path— dosyanın paket içindeki yolu.change— değişikliğin türü:added— dosya pakete eklendi.removed— dosya paketten çıkarıldı.changed— dosyanın metni değişti; metni karşılaştırılamayan bir dosyada (tablo, görüntü, metni olmayan dosya) dosyanın kendisi değişti.unreadable— dosya pakette duruyor ama artık okunamıyor (bozuk, şifreli ya da bir sınır nedeniyle işlenmedi). Okunamaz olan dosya hiçbir zamanremovedgösterilmez.
contentComparable—true:lines[]dosyanın metninin farkıdır.false: dosyanın karşılaştırılan bir metni yoktur; öğe yalnız dosyanın adını ve değişikliğin türünü söyler,lines[]boştur.lines[]— fark satırları,latestDiffile aynı şema.truncated— dosyanın farkı satır sınırında kısaltıldıysatrue.
Fark satırlarındaki type değerleri: unchanged, inserted, deleted, modified ve imaginary. imaginary yalnızca iki panoyu satır satır hizalamak için eklenen dolgu satırıdır — lineNumber alanı null'dır ve ekranda içerik olarak gösterilmemelidir. modified satırlarında kelime düzeyinde vurgulama için segments dizisi de dolabilir.
latestDiff geriye dönük uyumluluk için korunur; yeni istemciler yan yana panoları kullanabilir.
Boş yanıt hata değildir
İçerik değişikliği takibi yalnızca bunun açık olduğu kaynaklarda çalışır. Takibin kapalı olduğu bir kaynakta veya belgenin hiç revizyonu yoksa uç nokta boş listelerle 200 döner. 404 yalnızca belge yoksa veya boru hattı tamamlanmamışsa gelir.
30 dakikalık önbellek
Yanıt sunucu tarafında 30 dakika önbelleklenir.
Aynı şema Bilgi Kütüphanesinde de geçerlidir
GET /api/v1/informative-library/{id}/changes tamamen aynı yanıt şemasını döner; aynı istemci görüntüleyicisini iki külliyat için de kullanabilirsiniz.
Yetki ve kota
Api.Library.Detail iznini gerektirir ve detay uç noktasıyla aynı kota kovasından düşer.
Parametreler
| İsim | Konum | Tip | Zorunlu | Açıklama |
|---|---|---|---|---|
id |
Path | uuid |
Evet | Regülasyon doküman ID'si. |