API Endpoints

No labels

No milestone

No project

No assignees

1 participant

Notifications

Due date

The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference

Irish-Left-Archive/ILAv2#22

aonrud commented

2025-05-29 06:40:04 +00:00

Owner

API endpoints to give access to all models.

Filtering to be determined (depends on overlap with search implementation) – likely requirements:

Item – filter be organisation, periodical, person
Periodical – filter by organisation
People – filter by org., periodical

Basic endpoints:

Core

/item/<id>/
- Expand identifiers, errata etc. directly
/items/

Organisations

/organisation/<id>/
/organisations/
/organisations/timeline/
- Timeline orgs. Filtered by active; includes additional group/row info.

Expand relationships in parent entry (but see #20).

Periodicals

/periodical/<id>/
/periodicals/

People

/person/<id>/
/people/

Collections, Articles, Subjects

Depends on #3 and if modelled as 3 discrete things.

Resources

/resources/

Is single endpoint needed?

Calendar

TODO.

API endpoints to give access to all models. Filtering to be determined (depends on overlap with search implementation) – likely requirements: * Item – filter be organisation, periodical, person * Periodical – filter by organisation * People – filter by org., periodical Basic endpoints: ### Core * [ ] /item/\<id\>/ * Expand identifiers, errata etc. directly * [ ] /items/ ### Organisations * [ ] /organisation/\<id\>/ * [ ] /organisations/ * [ ] /organisations/timeline/ * Timeline orgs. Filtered by active; includes additional group/row info. Expand relationships in parent entry (but see #20). ### Periodicals * [ ] /periodical/\<id\>/ * [ ] /periodicals/ ### People * [ ] /person/\<id\>/ * [ ] /people/ ### Collections, Articles, Subjects Depends on #3 and if modelled as 3 discrete things. ### Resources * [ ] /resources/ Is single endpoint needed? ### Calendar TODO.

Rows
Columns

API Endpoints #22