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

Move Data Product Registration code to FastAPI framework #56

Closed
12 tasks
PriyaBasker23 opened this issue Jan 17, 2024 · 1 comment
Closed
12 tasks

Move Data Product Registration code to FastAPI framework #56

PriyaBasker23 opened this issue Jan 17, 2024 · 1 comment

Comments

@PriyaBasker23
Copy link

PriyaBasker23 commented Jan 17, 2024

User Story
In the role of a developer, I aim to establish an API endpoint for the registration of a data product.

Value / Purpose
This initiative is crucial for facilitating connectivity with the frontend and ensuring the successful registration of data products.

End point
/data-products
method - Post
Data product information will be in the body of the call

Proposal

  • Extract the code from the Python base (refer to the initial FastAPI commits in the repository).
  • Repurpose the code for integration into the existing lambda function.
  • Develop a Pydantic model, aiming for a single model for each endpoint to eliminate optional fields.
  • Incorporate unit tests, replicating them from the current application.
  • Illustrate an integration example with the firebreak, showcasing the functionality of the endpoint.
  • For the present, omit the inclusion of authentication requirements.
  • Ensure Documentation of the endpoint is working
  • Add approriate logging which will be useful debugging

Definition of Done

  • Deploy and validate the functionality of the endpoint.
  • Implement unit tests to ensure code integrity.
  • Add integration tests to verify seamless operation.
  • Confirm that registered data products can successfully transmit information to the designated S3 bucket.
@MatMoore
Copy link
Contributor

MatMoore commented Apr 9, 2024

@seanprivett I think we can probably close this for now. We've since changed direction from the original proposal:

  • Decision to use Datahub as a backend instead of s3
  • Decision to delay introducing the data product concept until after launching the catalogue

And we've also already explored this from the perspective of a concierge MVP

During beta we may still need a similar ticket to this, if we develop custom UIs for registering/editing specific metadata items rather than using an automated ingestion source. But I don't think we are ready to plan that just yet.

@tom-webber tom-webber changed the title Move Dataproduct Registration code to new Fastapi framework Move Data Product Registration code to FastAPI framework Apr 10, 2024
@moj-data-platform-robot moj-data-platform-robot transferred this issue from ministryofjustice/analytical-platform Apr 25, 2024
@seanprivett seanprivett closed this as not planned Won't fix, can't repro, duplicate, stale May 2, 2024
@github-project-automation github-project-automation bot moved this from Todo to Done in Data Catalogue May 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done ✅
Development

No branches or pull requests

3 participants