API endpoint: IDs objektu

JanMeritus commented 3 years ago

Lze se dotazovat na denni IDs sklizni (den -> IDs sklizni + IDks jejich kolekci (pokud je maji) ) #468

Kazda sklizen ma sve ID a lze jeji JSON servirovat po dotazu, obsahuje taky IDks sklizni.

Kazda interni kolekce a kazda externi kolekce ma sve ID a lze se cez toto (IDk) na ne dotazovat via API. (vazba #592)

Dynamicke kolekce (typ M1-M12, ArchiveIt, Test, OneShot) sve ID prozatim postradaji. (vazba #402)

Fasand commented 3 years ago

Dávám sem návrh jak by endpointy mohly vypadat

Denní / By Date

/seeder/api/harvest/date/<dd-mm-YYYY> : napadá mě formát { harvestId : [internalCollectionIds] } jestli může být. Např. pokud mám sklizně 1,2 a kolekce 11,12: {1: [], 2: [11,12]}

Harvest JSON

/seeder/api/harvest/<id harvest>/json : vlastně celá #402

Tématické kolekce

/seeder/api/tc_internal/<id internal tc>/json : může vrátit JSON kolekce tak, jak by se zobrazil v Harvest JSONu /seeder/api/tc_external/<id external tc> : podobně pro externí kolekce, ale co by v tomto případě měla vlastně vrátit? Prostě všechna svá pole + třeba IDs interních kolekcí? Nebo rovnou ten JSON co vrátí endpoint pro interní kolekce?

Udělal bych to přes rest framework, takže zatím může být přístup pro přihlášené a potom to změním třeba na token, zároveň to API bude částečně "před-generované", takže bude mít automaticky List a Detail pro ID. Jde mi tedy trochu o sémantiku: u Harvest JSONu mi dává smysl přidat /json, protože to není jenom výpis polí ale je to něco custom, každopádně u externí kolekce můžu prakticky jen vypsat ta pole, takže mi tam to /json nesedí.

JanMeritus commented 3 years ago

@Fasand

Denni / By Date

vrati spet datum, pocet sklizni ID jedntolivych sklizni a ich aktualni stav

{ date: dd-mm-YYYY, harvestCount: integer, harvests: [ harvestID : harvestStatus, harvestID : harvestStatus ]}

Harvest JSON

ok

Kolekce

ano, nazev ale ne tc_internal, tc_external ale:

collections/internal//json
collections/external/ (vrati pole a ID internich kolekci)
collections/internal collections/external (vrati IDy externich i internich kolekci)

mariehaskovcova commented 6 months ago

příležitostně prosím zhodnoť @dragounv, díky

WebarchivCZ / Seeder