diff --git a/openapi.yaml b/openapi.yaml index a46f66882..d56ddce57 100644 --- a/openapi.yaml +++ b/openapi.yaml @@ -32,6 +32,11 @@ paths: /api/v1/index/retrieve: post: summary: Searches index by entry metadata + description: > + EXPERIMENTAL - this endpoint is offered as best effort only and may be changed or removed in future releases. + + The results returned from this endpoint may be incomplete. + deprecated: true operationId: searchIndex tags: - index diff --git a/pkg/generated/client/index/index_client.go b/pkg/generated/client/index/index_client.go index 35964c0d6..cf5a83ca2 100644 --- a/pkg/generated/client/index/index_client.go +++ b/pkg/generated/client/index/index_client.go @@ -50,7 +50,11 @@ type ClientService interface { } /* -SearchIndex searches index by entry metadata + SearchIndex searches index by entry metadata + + EXPERIMENTAL - this endpoint is offered as best effort only and may be changed or removed in future releases. + +The results returned from this endpoint may be incomplete. */ func (a *Client) SearchIndex(params *SearchIndexParams, opts ...ClientOption) (*SearchIndexOK, error) { // TODO: Validate the params before sending diff --git a/pkg/generated/restapi/embedded_spec.go b/pkg/generated/restapi/embedded_spec.go index d5d85b647..f2b241389 100644 --- a/pkg/generated/restapi/embedded_spec.go +++ b/pkg/generated/restapi/embedded_spec.go @@ -53,11 +53,13 @@ func init() { "paths": { "/api/v1/index/retrieve": { "post": { + "description": "EXPERIMENTAL - this endpoint is offered as best effort only and may be changed or removed in future releases.\nThe results returned from this endpoint may be incomplete.\n", "tags": [ "index" ], "summary": "Searches index by entry metadata", "operationId": "searchIndex", + "deprecated": true, "parameters": [ { "name": "query", @@ -955,11 +957,13 @@ func init() { "paths": { "/api/v1/index/retrieve": { "post": { + "description": "EXPERIMENTAL - this endpoint is offered as best effort only and may be changed or removed in future releases.\nThe results returned from this endpoint may be incomplete.\n", "tags": [ "index" ], "summary": "Searches index by entry metadata", "operationId": "searchIndex", + "deprecated": true, "parameters": [ { "name": "query", diff --git a/pkg/generated/restapi/operations/index/search_index.go b/pkg/generated/restapi/operations/index/search_index.go index f3c1ac6ca..97972a3c1 100644 --- a/pkg/generated/restapi/operations/index/search_index.go +++ b/pkg/generated/restapi/operations/index/search_index.go @@ -48,7 +48,10 @@ func NewSearchIndex(ctx *middleware.Context, handler SearchIndexHandler) *Search /* SearchIndex swagger:route POST /api/v1/index/retrieve index searchIndex -Searches index by entry metadata +# Searches index by entry metadata + +EXPERIMENTAL - this endpoint is offered as best effort only and may be changed or removed in future releases. +The results returned from this endpoint may be incomplete. */ type SearchIndex struct { Context *middleware.Context