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

Index a Project via HTTP API #11

Open
4 tasks
farhoud opened this issue Jul 31, 2024 · 0 comments
Open
4 tasks

Index a Project via HTTP API #11

farhoud opened this issue Jul 31, 2024 · 0 comments
Assignees
Labels

Comments

@farhoud
Copy link
Member

farhoud commented Jul 31, 2024

Title: Implement Endpoint to Index a Project

Description:
Create an HTTP API endpoint to index a project by providing the project path and main function.

Acceptance Criteria:

  • Implement a POST endpoint at /index.
  • The endpoint should accept a JSON body with path and main fields.
  • Return a success message upon successful indexing.

Request Example:

{
  "path": "/path/to/your/project",
  "main": "main.py"
}

Response Example:

{
  "status": "success",
  "message": "Project indexed successfully."
}

Tasks:

  • Define the /index endpoint.
  • Validate the input fields (path and main).
  • Implement the indexing functionality.
  • Return a JSON response with the status and message.
@farhoud farhoud self-assigned this Jul 31, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

1 participant