Irish-Left-Archive/ILAv2
Irish-Left-Archive/ILAv2
1
0
Fork 0
Code Issues 20 Pull requests Projects 4 Wiki Activity

API Endpoints #22

New issue
Open
opened 2025-05-29 06:40:04 +00:00 by aonrud · 0 comments
aonrud commented 2025-05-29 06:40:04 +00:00
Owner
Copy link

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.
Sign in to join this conversation.
No Branch/Tag specified
Branches Tags
main
No results found.
Labels
Clear labels   
bug

Something is not working

  
duplicate

This issue or pull request already exists

  
feature

New feature

  
invalid

Something is wrong

  
needs research
No labels
bug
duplicate
feature
invalid
needs research
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
Assignees
Clear assignees
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
No description provided.
Delete branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?