add description on /api/v1/index/retrieve endpoint (#1073)

Signed-off-by: Bob Callaway <bcallaway@google.com> Signed-off-by: Bob Callaway <bcallaway@google.com>
sigstore · Sep 23, 2022 · da0e085 · da0e085
1 parent 25f429c
commit da0e085
Show file tree

Hide file tree

Showing 4 changed files with 18 additions and 2 deletions.
diff --git 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
diff --git a/pkg/generated/restapi/embedded_spec.go b/pkg/generated/restapi/embedded_spec.go
diff --git a/pkg/generated/restapi/operations/index/search_index.go b/pkg/generated/restapi/operations/index/search_index.go