Qstash and search devops #564

mtahasylmz · 2025-10-24T14:24:31Z

Added QStash and Search Endpoints openapi documentation to developerAPI docs.
Added stats endpoint for vector
Changed vector transfer endpoint so that it does not say one can transfer to a personal account.

added endpoints
"GET /vector/index/{id}/stats"
"GET /vector/index/stats"
"GET /search",
"GET /search/{id}",
"GET /search/stats",
"GET /search/{id}/stats",
"POST /search",
"POST /search/{id}/reset-password",
"POST /search/{id}/transfer",
"POST /search/{id}/rename",
"DELETE /search/{id}"
"GET /qstash/user",
"GET /qstash/stats",
"POST /qstash/user/rotatetoken",
"POST /qstash-upgrade"

Copilot

Pull Request Overview

This PR adds comprehensive API documentation for QStash and Search endpoints, expands Vector statistics endpoints, and updates the vector transfer operation description to clarify that transfers are team-only.

Key Changes

Added global and per-index statistics endpoints for Vector and Search indices
Added complete CRUD operations and management endpoints for Search indices
Added QStash user management, statistics, and plan upgrade endpoints

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.

File	Description
docs.json	Added navigation entries for new Vector stats endpoints, Search endpoints group, and QStash endpoints group
devops/developer-api/openapi.yml	Added OpenAPI specifications for Vector stats, Search CRUD/management operations, QStash user management, and corresponding schema definitions

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2025-10-27T11:14:13Z

devops/developer-api/openapi.yml

-                  description: The ID of the target account. If the target is a team, then use the format `team:<TEAM_ID>`, else if the target is your personal account use the format `<YOUR_EMAIL>`.
-                  example: "team:team-id-1"
+                  description: The team ID of the target team.
+                  example: "team-id-1"


The description and example are inconsistent with the actual request body structure. Based on line 1364, the target_account should be a full team UUID (e.g., '2c670cd0-5a4d-4242-9300-b0a01548y612'), not a simple team ID string like 'team-id-1'. Update the example to match the format used in the search transfer endpoint.

Suggested change

example: "team-id-1"

example: "2c670cd0-5a4d-4242-9300-b0a01548y612"

Copilot · 2025-10-27T11:14:13Z

devops/developer-api/openapi.yml

+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/VectorStats'


The schema reference should be '#/components/schemas/SearchStats' or a generic stats schema, not 'VectorStats'. Search indices may have different statistics than vector indices, and using VectorStats for search statistics is semantically incorrect and could be misleading.

Suggested change

$ref: '#/components/schemas/VectorStats'

$ref: '#/components/schemas/SearchStats'

they have the same schema

Copilot · 2025-10-27T11:14:14Z

devops/developer-api/openapi.yml

+          type: string
+          format: uuid
+          description: Unique identifier for the QStash user account
+          example: 0639864f-ece6-429c-8118-86a2808


Corrected UUID format - the example UUID is incomplete/truncated.

Suggested change

example: 0639864f-ece6-429c-8118-86a2808

example: 0639864f-ece6-429c-8118-86a2808e7b2

Copilot

Pull Request Overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated 6 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2025-10-28T19:49:24Z

devops/developer-api/openapi.yml

                  type: string
-                  description: The ID of the target account. If the target is a team, then use the format `team:<TEAM_ID>`, else if the target is your personal account use the format `<YOUR_EMAIL>`.
-                  example: "team:team-id-1"
+                  description: The team ID of the target team.


The updated description 'The team ID of the target team' is less informative than the original. Consider revising to clarify what format the team ID should take (e.g., 'The UUID of the target team account') and whether personal accounts are supported for transfers, matching the detail level of the new search transfer endpoint at line 1363.

Suggested change

description: The team ID of the target team.

description: The UUID of the target team account to which the index will be transferred. Only team accounts are supported; personal accounts are not supported for transfers.

Copilot · 2025-10-28T19:49:25Z

devops/developer-api/openapi.yml

+          type: integer
+          description: Maximum size for events
+          example: 100000
+        max_dlq_retention_time_milis:


Corrected spelling of 'milis' to 'millis' in the field name. This is a typo in 'milliseconds'.

Suggested change

max_dlq_retention_time_milis:

max_dlq_retention_time_millis:

Copilot · 2025-10-28T19:49:25Z

devops/developer-api/openapi.yml

+            Array of day names for the measurement period, typically representing the current month.
+            It also includes the upcoming days of the month.


The description is unclear. It states the array includes 'upcoming days of the month,' which is confusing. Clarify whether this means future dates within the current month or if it extends beyond the current month, and explain the practical purpose of including future days in historical statistics.

Suggested change

Array of day names for the measurement period, typically representing the current month.

It also includes the upcoming days of the month.

Array of day names for the measurement period, typically representing all days in the current month.

This includes both past and future dates within the current month, so the array covers the entire month regardless of the current day.

Future days are included to align with other daily metrics arrays, allowing for consistent indexing and potential forecasting or placeholder values.

Copilot · 2025-10-28T19:49:25Z

devops/developer-api/openapi.yml

+           Request counts for the requested time period
+           If 1h is specified, it shows 60 data points for every 1 minute within the last 1 hour.


Inconsistent indentation in multi-line description. Line 2954 has 11 spaces while line 2955 has 11 spaces, but they should align consistently with the YAML structure. Other similar descriptions in the file maintain proper indentation.

Suggested change

Request counts for the requested time period

If 1h is specified, it shows 60 data points for every 1 minute within the last 1 hour.

Request counts for the requested time period

If 1h is specified, it shows 60 data points for every 1 minute within the last 1 hour.

Copilot · 2025-10-28T19:49:25Z

devops/developer-api/openapi.yml

+           Workflow usage metrics for the requested time period
+           If 1h is specified, it shows 60 data points for every 1 minute within the last 1 hour.


Inconsistent indentation in multi-line description. Line 2964 has 11 spaces while line 2965 has 11 spaces. This should match the consistent indentation pattern used elsewhere in the schema definitions.

Suggested change

Workflow usage metrics for the requested time period

If 1h is specified, it shows 60 data points for every 1 minute within the last 1 hour.

Workflow usage metrics for the requested time period

If 1h is specified, it shows 60 data points for every 1 minute within the last 1 hour.

Copilot · 2025-10-28T19:49:26Z

devops/developer-api/openapi.yml

+           Bandwidth usage for the requested time period
+           If 1h is specified, it shows 60 data points for every 1 minute within the last 1 hour.


Inconsistent indentation in multi-line description. Line 3010 has 11 spaces while line 3011 has 11 spaces. This should be consistent with the YAML structure and match formatting used in other parts of the file.

Suggested change

Bandwidth usage for the requested time period

If 1h is specified, it shows 60 data points for every 1 minute within the last 1 hour.

Bandwidth usage for the requested time period

If 1h is specified, it shows 60 data points for every 1 minute within the last 1 hour.

Copilot

Pull Request Overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2025-10-29T06:34:48Z

devops/developer-api/openapi.yml

+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/VectorStats'


The search index stats endpoint references 'VectorStats' schema, but this should likely reference a 'SearchStats' schema or be clearly documented that search indices use the same statistics structure as vector indices. If the schemas are intentionally identical, consider adding a comment explaining this design decision.

Copilot · 2025-10-29T06:34:49Z

devops/developer-api/openapi.yml

+          type: integer
+          description: Maximum size for events
+          example: 100000
+        max_dlq_retention_time_milis:


Corrected spelling of 'milis' to 'millis' (standard abbreviation for milliseconds).

Suggested change

max_dlq_retention_time_milis:

max_dlq_retention_time_millis:

Taha added 3 commits October 24, 2025 15:47

qstash and search docs are done

1628429

added vector stats and query param for stats

d256c4c

vector cant be transferred to a personal acc.

225e7d5

buggyhunter requested a review from Copilot October 27, 2025 11:12

Copilot AI reviewed Oct 27, 2025

View reviewed changes

qstash stats is detailed, quick fixes

f747b00

mtahasylmz requested a review from Copilot October 28, 2025 19:46

Copilot AI reviewed Oct 28, 2025

View reviewed changes

transfer-index-detailed

6c34f49

mtahasylmz requested a review from Copilot October 29, 2025 06:32

Copilot AI reviewed Oct 29, 2025

View reviewed changes

	example: "team-id-1"
	example: "2c670cd0-5a4d-4242-9300-b0a01548y612"

	$ref: '#/components/schemas/VectorStats'
	$ref: '#/components/schemas/SearchStats'

	example: 0639864f-ece6-429c-8118-86a2808
	example: 0639864f-ece6-429c-8118-86a2808e7b2

	description: The team ID of the target team.
	description: The UUID of the target team account to which the index will be transferred. Only team accounts are supported; personal accounts are not supported for transfers.

		Array of day names for the measurement period, typically representing the current month.
		It also includes the upcoming days of the month.

-            Array of day names for the measurement period, typically representing the current month.
-            It also includes the upcoming days of the month.
+            Array of day names for the measurement period, typically representing all days in the current month.
+            This includes both past and future dates within the current month, so the array covers the entire month regardless of the current day.
+            Future days are included to align with other daily metrics arrays, allowing for consistent indexing and potential forecasting or placeholder values.

		Request counts for the requested time period
		If 1h is specified, it shows 60 data points for every 1 minute within the last 1 hour.

		Workflow usage metrics for the requested time period
		If 1h is specified, it shows 60 data points for every 1 minute within the last 1 hour.

		Bandwidth usage for the requested time period
		If 1h is specified, it shows 60 data points for every 1 minute within the last 1 hour.

Qstash and search devops #564

Are you sure you want to change the base?

Qstash and search devops #564

Uh oh!

Conversation

mtahasylmz commented Oct 24, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Key Changes

Reviewed Changes

Uh oh!

Copilot AI Oct 27, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Oct 27, 2025

Choose a reason for hiding this comment

Uh oh!

mtahasylmz Oct 28, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Oct 27, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Uh oh!

Copilot AI Oct 28, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Oct 28, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Oct 28, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Oct 28, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Oct 28, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Oct 28, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Uh oh!

Copilot AI Oct 29, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Oct 29, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant