Write Postman Tests for Embeddings AI Endpoints - Githubissues

dotCMS / core

Headless/Hybrid Content Management System for Enterprises

http://dotcms.com

Other

803 stars 460 forks source link

Write Postman Tests for Embeddings AI Endpoints #28721

Open victoralfaro-dotcms opened 1 month ago

victoralfaro-dotcms commented 1 month ago

Parent Issue

https://github.com/dotCMS/core/issues/27973

User Story

As a Java developer, I want to write Postman tests for the following Embeddings AI Endpoints:

/api/v1/ai/embeddings | POST
/api/v1/ai/embeddings | DELETE
/api/v1/ai/embeddings/db | DELETE
/api/v1/ai/embeddings/indexCount | GET

Acceptance Criteria

Postman test collection includes tests for:
- /api/v1/ai/embeddings (POST)
- /api/v1/ai/embeddings (DELETE)
- /api/v1/ai/embeddings/db (DELETE)
- /api/v1/ai/embeddings/indexCount (GET)
Tests validate successful response status and structure.
Tests include various valid and invalid input scenarios.
Test results are documented and shared with the team.

dotCMS Version

master

Proposed Objective

Quality Assurance

Proposed Priority

Priority 2 - Important

External Links... Slack Conversations, Support Tickets, Figma Designs, etc.

Slack Conversation: [link]
Support Ticket: [link]
API Documentation: [link]

Assumptions & Initiation Needs

Access to the Embeddings AI endpoints.
Valid API keys or tokens for authentication.
Sample input data for embeddings operations.

Quality Assurance Notes & Workarounds

Ensure that tests cover a wide range of scenarios including edge cases.
Verify that the API responses match the expected structure and content.
Perform regression testing to ensure no existing functionality is broken by these tests.

Sub-Tasks & Estimates

Review API documentation for Embeddings AI endpoints (2 hours)
Set up Postman environment and variables (2 hours)
Write tests for /api/v1/ai/embeddings (POST) (3 hours)
Write tests for /api/v1/ai/embeddings (DELETE) (3 hours)
Write tests for /api/v1/ai/embeddings/db (DELETE) (3 hours)
Write tests for /api/v1/ai/embeddings/indexCount (GET) (3 hours)
Validate tests with various scenarios and inputs (4 hours)
Document test results and share with the team (2 hours)
Update documentation to reflect the new tests (1 hour)

Total Estimate: 23 hours

victoralfaro-dotcms commented 1 week ago

PR: https://github.com/dotCMS/core/pull/28913