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.

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

Add Endpoints for ICAT 5 #373

Closed
1 of 2 tasks
MRichards99 opened this issue Sep 1, 2022 · 0 comments · Fixed by #383
Closed
1 of 2 tasks

Add Endpoints for ICAT 5 #373

MRichards99 opened this issue Sep 1, 2022 · 0 comments · Fixed by #383
Assignees
Labels
enhancement New feature or request icat backend Issues relating to the Python ICAT backend

Comments

@MRichards99
Copy link
Collaborator

MRichards99 commented Sep 1, 2022

Description:
ICAT 5 contains new entities that are not present in ICAT 4. Here's a full list of new entities:

  • Affiliation
  • DataCollectionInvestigation
  • DataPublication
  • DataPublicationDate
  • DataPublicationFunding
  • DataPublicationType
  • DataPublicationUser
  • DatasetInstrument
  • DatasetTechnique
  • FundingReference
  • InvestigationFacilityCycle
  • InvestigationFunding
  • RelatedItem
  • Technique

For each of these entities, there needs to be a new set of endpoints created for them. If we take Technique as an example, that will need (assume a /datagateway-api prefix at the start):

  • /techniques/{id} - GET, PATCH, DELETE
  • /techniques - GET, PATCH, POST
  • /techniques/count - GET
  • /techniques/findone - GET

The focus for now will be to implement these endpoints on the ICAT backend. I will ask whether this work needs to be done on the database backend too.

Acceptance criteria:

  • For each entity, add in new endpoints of each type
  • Ensure the new endpoints are listed in the OpenAPI interface and the openapi.yaml file has the new additions
@MRichards99 MRichards99 added enhancement New feature or request icat backend Issues relating to the Python ICAT backend labels Sep 1, 2022
@Reillyhewitson Reillyhewitson mentioned this issue Oct 5, 2022
6 tasks
@Reillyhewitson Reillyhewitson linked a pull request Oct 5, 2022 that will close this issue
6 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request icat backend Issues relating to the Python ICAT backend
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants