Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

ODRC: expose READ operations for Document resource #38

Closed
4 tasks done
Tracked by #2
sergei-maertens opened this issue Sep 18, 2024 · 4 comments · Fixed by #96
Closed
4 tasks done
Tracked by #2

ODRC: expose READ operations for Document resource #38

sergei-maertens opened this issue Sep 18, 2024 · 4 comments · Fixed by #96
Milestone
Plateau 0 (MVP)

Comments

@sergei-maertens
Copy link
Contributor

sergei-maertens commented Sep 18, 2024 •
edited by bart-maykin
Loading

Depends on #37, split of from #2

Acceptance criteria

Taken from #2

  • Via een API kan een document (data-object) geraadpleegd worden.
  • Het is zowel mogelijk:
    • om één document te raadplegen (op basis van de identifier),
    • om een lijst (array) van documenten op te vragen ,
    • om een lijst (array van alle documenten behorende bij één publicatie op te vragen,
    • Bij het opvragen van een lijst kan sortering en pagination toegepast worden.
  • Optioneel: de raadpleging van een of meerdere documenten wordt gelogd (zie ODRC: Set up foundation for logging/audit trails #16 ). Graag laten weten of dit wordt meegenomen!
  • De API specificatie is bijgewerkt (ReDoc, Swagger)
  • De documentatie is bijgewerkt (Read the Docs)

Developer tasks

  • Add API endpoint /api/v1/documenten with READ operations (list, detail)
  • List endpoint accepts filter parameter on publicatie
  • List endpoint must be paginated
  • List endpoint must support ordering on officieleTitel, verkorteTitel, creatiedatum
@sergei-maertens sergei-maertens mentioned this issue Sep 18, 2024
Closed
11 tasks
@sergei-maertens sergei-maertens moved this to Refinement in GPP-Woo Sep 18, 2024
@sergei-maertens
Copy link
Contributor Author

-> Leaving the READ operation out of scope initially

@sergei-maertens sergei-maertens added this to the 04. ODRC: Beheren publicaties milestone Sep 18, 2024
@sergei-maertens
Copy link
Contributor Author

@MarcoKlerks please double check this story if it matches your expectations

@MarcoKlerks MarcoKlerks modified the milestones: 04. ODRC: Beheren publicaties, 01. ODRC: Basis Sep 18, 2024
bart-maykin added a commit that referenced this issue Oct 23, 2024
@bart-maykin
✨ [#38] document api list endpoint
3ca6d44
bart-maykin added a commit that referenced this issue Oct 23, 2024
@bart-maykin
✅ [#38] created tests for document list and detail point
0717c3a
@bart-maykin bart-maykin mentioned this issue Oct 23, 2024
Merged
@bart-maykin bart-maykin moved this from In progress to In review in GPP-Woo Oct 23, 2024
bart-maykin added a commit that referenced this issue Oct 23, 2024
@bart-maykin
✅ [#38] created tests for document list and detail point
e139af6
bart-maykin added a commit that referenced this issue Oct 23, 2024
@bart-maykin
✅ [#38] created tests for document list and detail point
88f07a4
sergei-maertens pushed a commit that referenced this issue Oct 23, 2024
@bart-maykin @sergei-maertens
✨ [#38] document api list endpoint
3efb16f
sergei-maertens pushed a commit that referenced this issue Oct 23, 2024
@bart-maykin @sergei-maertens
✅ [#38] created tests for document list and detail point
9515202
bart-maykin added a commit that referenced this issue Oct 24, 2024
@bart-maykin
✨ [#38] document api list endpoint
85219e6
bart-maykin added a commit that referenced this issue Oct 24, 2024
@bart-maykin
✅ [#38] created tests for document list and detail point
6996f3e
bart-maykin added a commit that referenced this issue Oct 25, 2024
@bart-maykin
✨ [#38] added uuid field to documents model, changed the api lookup f…
e4b08f7 
…ield from identifier to uuid and added filter to keep the functionality of lookup documents based on identifier
bart-maykin added a commit that referenced this issue Oct 25, 2024
@bart-maykin
✨ [#38] added uuid field to documents model, changed the api lookup f…
fa9a101 
…ield from identifier to uuid and added filter to keep the functionality of lookup documents based on identifier
bart-maykin added a commit that referenced this issue Oct 25, 2024
@bart-maykin
✨ [#38] added uuid field to documents model, changed the api lookup f…
196f68a 
…ield from identifier to uuid and added filter to keep the functionality of lookup documents based on identifier
bart-maykin added a commit that referenced this issue Oct 25, 2024
@bart-maykin
✨ [#38] added uuid field to documents model, changed the api lookup f…
895c7dc 
…ield from identifier to uuid and added filter to keep the functionality of lookup documents based on identifier
bart-maykin added a commit that referenced this issue Oct 25, 2024
@bart-maykin
✨ [#38] added uuid field to documents model, changed the api lookup f…
c42d152 
…ield from identifier to uuid and added filter to keep the functionality of lookup documents based on identifier
bart-maykin added a commit that referenced this issue Oct 30, 2024
@bart-maykin
✨ [#38] document api list endpoint
95cc84e
bart-maykin added a commit that referenced this issue Oct 30, 2024
@bart-maykin
✅ [#38] created tests for document list and detail point
bce615c
bart-maykin added a commit that referenced this issue Oct 30, 2024
@bart-maykin
✨ [#38] added uuid field to documents model, changed the api lookup f…
555eb59 
…ield from identifier to uuid and added filter to keep the functionality of lookup documents based on identifier
bart-maykin added a commit that referenced this issue Oct 30, 2024
@bart-maykin
🎨 [#38] changed markdown on publicatie filter on the document api end…
86a975b 
…point. Changed the way we retrieve TimelineLog instances in tests
bart-maykin added a commit that referenced this issue Oct 30, 2024
@bart-maykin
✨ [#38] document api list endpoint
99633d7
bart-maykin added a commit that referenced this issue Oct 30, 2024
@bart-maykin
✅ [#38] created tests for document list and detail point
cf460c5
bart-maykin added a commit that referenced this issue Oct 30, 2024
@bart-maykin
✨ [#38] added uuid field to documents model, changed the api lookup f…
a277278 
…ield from identifier to uuid and added filter to keep the functionality of lookup documents based on identifier
bart-maykin added a commit that referenced this issue Oct 30, 2024
@bart-maykin
🎨 [#38] changed markdown on publicatie filter on the document api end…
ff8a6de 
…point. Changed the way we retrieve TimelineLog instances in tests
bart-maykin added a commit that referenced this issue Oct 30, 2024
@bart-maykin
🎨 [#38] changed markdown on publicatie filter on the document api end…
0c68572 
…point. Changed the way we retrieve TimelineLog instances in tests
@github-project-automation github-project-automation bot moved this from In review to Done in GPP-Woo Oct 30, 2024
@sergei-maertens
Copy link
Contributor Author

Testing needed :)

@github-project-automation github-project-automation bot moved this from Done to In progress in GPP-Woo Oct 30, 2024
@sergei-maertens sergei-maertens moved this from In progress to In review in GPP-Woo Oct 30, 2024
@MarcoKlerks
Copy link
Contributor

Ik kan dit technisch niet testen. Op grond van de documentatie (ReDoc) lijkt mij dit op orde.

@github-project-automation github-project-automation bot moved this from Testing to Done in GPP-Woo Nov 4, 2024
@MarcoKlerks MarcoKlerks removed their assignment Dec 16, 2024
@MarcoKlerks MarcoKlerks added this to the Plateau 0 (MVP) milestone Dec 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
GPP-Woo
Status: Done
Milestone
Plateau 0 (MVP)
Development

Successfully merging a pull request may close this issue.

Document api read endpoints GPP-Woo/GPP-publicatiebank
3 participants
@sergei-maertens @MarcoKlerks @bart-maykin