STAC-24149: process feedback

Remove 'View' from schema names and drop viewId from request/response

Author: deontaljaard

cmd/topology/topology_inspect.go

@@ -86,15 +86,15 @@ func RunInspectCommand(
 		true,
 	)
 
-	request := stackstate_api.NewViewSnapshotRequest(
-		"ViewSnapshotRequest",
+	request := stackstate_api.NewSnapshotRequest(
+		"SnapshotRequest",
 		query,
 		"0.0.1",
 		*metadata,
 	)
 
 	result, resp, err := api.SnapshotApi.QuerySnapshot(cli.Context).
-		ViewSnapshotRequest(*request).
+		SnapshotRequest(*request).
 		Execute()
 	if err != nil {
 		return common.NewResponseError(err, resp)
@@ -104,7 +104,7 @@ func RunInspectCommand(
 	components, parseErr := parseSnapshotResponse(result, cli.CurrentContext.URL)
 	if parseErr != nil {
 		// Check if the error is a typed error from the response by examining the _type discriminator
-		if typedErr := handleViewSnapshotError(result.ViewSnapshotResponse, resp); typedErr != nil {
+		if typedErr := handleSnapshotError(result.SnapshotResponse, resp); typedErr != nil {
 			return typedErr
 		}
 		return common.NewExecutionError(parseErr)
@@ -166,8 +166,8 @@ type ComponentMetadata struct {
 	Environments   map[int64]string
 }
 
-// handleViewSnapshotError checks if the response is a typed error by examining the _type discriminator
-func handleViewSnapshotError(respMap map[string]interface{}, resp *http.Response) common.CLIError {
+// handleSnapshotError checks if the response is a typed error by examining the _type discriminator
+func handleSnapshotError(respMap map[string]interface{}, resp *http.Response) common.CLIError {
 	if respMap == nil {
 		return nil
 	}
@@ -177,6 +177,7 @@ func handleViewSnapshotError(respMap map[string]interface{}, resp *http.Response
 		return nil
 	}
 
+	// Note: the `View` prefix on the error types comes from the existing (Scala) DTO types
 	switch responseType {
 	case "ViewSnapshotFetchTimeout":
 		if usedTimeoutSeconds, ok := respMap["usedTimeoutSeconds"].(float64); ok {
@@ -217,18 +218,19 @@ func parseSnapshotResponse(
 	result *stackstate_api.QuerySnapshotResult,
 	baseURL string,
 ) ([]Component, error) {
-	// ViewSnapshotResponse is already typed as map[string]interface{} from the generated API
-	respMap := result.ViewSnapshotResponse
+	// SnapshotResponse is already typed as map[string]interface{} from the generated API
+	respMap := result.SnapshotResponse
 	if respMap == nil {
 		return nil, fmt.Errorf("response data is nil")
 	}
 
-	// Check if this is a ViewSnapshot (success) or an error type
+	// Check if this is a Snapshot (success) or an error type
 	respType, ok := respMap["_type"].(string)
 	if !ok {
 		return nil, fmt.Errorf("response has no _type discriminator")
 	}
 
+	// Note: the `View` prefix on response type comes from the existing (Scala) DTO types
 	// If it's not a ViewSnapshot, it's an error type - return empty components and let error handler deal with it
 	if respType != "ViewSnapshot" {
 		return nil, fmt.Errorf("response is an error type: %s", respType)
@@ -263,7 +265,7 @@ var metadataFieldMapping = []struct {
 }
 
 // parseMetadata extracts component type, layer, domain, and environment metadata
-// from the opaque ViewSnapshot response using a table-driven approach.
+// from the opaque Snapshot response using a table-driven approach.
 func parseMetadata(respMap map[string]interface{}) ComponentMetadata {
 	metadata := ComponentMetadata{
 		ComponentTypes: make(map[int64]string),

cmd/topology/topology_inspect_test.go

@@ -21,7 +21,7 @@ func setInspectCmd(t *testing.T) (*di.MockDeps, *cobra.Command) {
 func mockSnapshotResponse() sts.QuerySnapshotResult {
 	return sts.QuerySnapshotResult{
 		Type: "QuerySnapshotResult",
-		ViewSnapshotResponse: map[string]interface{}{
+		SnapshotResponse: map[string]interface{}{
 			"_type": "ViewSnapshot",
 			"components": []interface{}{
 				map[string]interface{}{
@@ -121,7 +121,7 @@ func TestTopologyInspectWithTags(t *testing.T) {
 
 	// Verify query contains both tags ANDed
 	call := calls[0]
-	request := call.PviewSnapshotRequest
+	request := call.PsnapshotRequest
 	expectedQuery := `type = "test type" AND label = "service.namespace:test" AND label = "service.name:myservice"`
 	assert.Equal(t, expectedQuery, request.Query)
 }
@@ -141,7 +141,7 @@ func TestTopologyInspectWithIdentifiers(t *testing.T) {
 
 	// Verify query contains identifiers in IN clause
 	call := calls[0]
-	request := call.PviewSnapshotRequest
+	request := call.PsnapshotRequest
 	expectedQuery := `type = "test type" AND identifier IN ("urn:test:1", "urn:test:2")`
 	assert.Equal(t, expectedQuery, request.Query)
 }
@@ -150,7 +150,7 @@ func TestTopologyInspectNoResults(t *testing.T) {
 	cli, cmd := setInspectCmd(t)
 	cli.MockClient.ApiMocks.SnapshotApi.QuerySnapshotResponse.Result = sts.QuerySnapshotResult{
 		Type: "QuerySnapshotResult",
-		ViewSnapshotResponse: map[string]interface{}{
+		SnapshotResponse: map[string]interface{}{
 			"_type":      "ViewSnapshot",
 			"components": []interface{}{},
 			"metadata": map[string]interface{}{
@@ -178,7 +178,7 @@ func TestTopologyInspectMultipleIdentifiers(t *testing.T) {
 	cli, cmd := setInspectCmd(t)
 	responseData := mockSnapshotResponse()
 	// Modify to include multiple identifiers
-	components := responseData.ViewSnapshotResponse["components"].([]interface{})
+	components := responseData.SnapshotResponse["components"].([]interface{})
 	comp := components[0].(map[string]interface{})
 	comp["identifiers"] = []interface{}{"urn:test:1", "urn:test:2", "urn:test:3"}
 	cli.MockClient.ApiMocks.SnapshotApi.QuerySnapshotResponse.Result = responseData
@@ -199,7 +199,7 @@ func TestTopologyInspectURLEncoding(t *testing.T) {
 	cli, cmd := setInspectCmd(t)
 	responseData := mockSnapshotResponse()
 	// Set identifier with special characters
-	components := responseData.ViewSnapshotResponse["components"].([]interface{})
+	components := responseData.SnapshotResponse["components"].([]interface{})
 	comp := components[0].(map[string]interface{})
 	comp["identifiers"] = []interface{}{"urn:opentelemetry:namespace/service:component/name"}
 	cli.MockClient.ApiMocks.SnapshotApi.QuerySnapshotResponse.Result = responseData
@@ -219,11 +219,11 @@ func TestTopologyInspectWithEnvironment(t *testing.T) {
 	cli, cmd := setInspectCmd(t)
 	responseData := mockSnapshotResponse()
 	// Add environment to component
-	components := responseData.ViewSnapshotResponse["components"].([]interface{})
+	components := responseData.SnapshotResponse["components"].([]interface{})
 	comp := components[0].(map[string]interface{})
 	comp["environment"] = float64(123)
 	// Add environment to metadata
-	metadata := responseData.ViewSnapshotResponse["metadata"].(map[string]interface{})
+	metadata := responseData.SnapshotResponse["metadata"].(map[string]interface{})
 	metadata["environments"] = []interface{}{
 		map[string]interface{}{
 			"id":   float64(123),
@@ -273,23 +273,26 @@ func TestTopologyInspectWithBaseURL(t *testing.T) {
 	cli.MockClient.ApiMocks.SnapshotApi.QuerySnapshotResponse.Result = mockSnapshotResponse()
 	cli.CurrentContext.URL = "https://stackstate.example.com:8080"
 
-	di.ExecuteCommandWithContextUnsafe(&cli.Deps, cmd, "--type", "test type")
+	di.ExecuteCommandWithContextUnsafe(&cli.Deps, cmd, "--type", "test type", "-o", "json")
 
 	// Verify base URL is included in the link
-	tableCalls := *cli.MockPrinter.TableCalls
-	assert.Len(t, tableCalls, 1)
+	jsonCalls := *cli.MockPrinter.PrintJsonCalls
+	assert.Len(t, jsonCalls, 1)
+
+	jsonData := jsonCalls[0]
+	// Components are serialized from []Component struct
+	components := jsonData["components"].([]Component)
+	assert.NotNil(t, components)
 
-	table := tableCalls[0]
-	row := table.Data[0]
 	expectedLink := "https://stackstate.example.com:8080/#/components/urn:test:component:1"
-	assert.Equal(t, expectedLink, row[3])
+	assert.Equal(t, expectedLink, components[0].Link)
 }
 
 func TestTopologyInspectFetchTimeout(t *testing.T) {
 	cli, cmd := setInspectCmd(t)
 	cli.MockClient.ApiMocks.SnapshotApi.QuerySnapshotResponse.Result = sts.QuerySnapshotResult{
 		Type: "QuerySnapshotResult",
-		ViewSnapshotResponse: map[string]interface{}{
+		SnapshotResponse: map[string]interface{}{
 			"_type":              "ViewSnapshotFetchTimeout",
 			"usedTimeoutSeconds": float64(30),
 		},
@@ -307,7 +310,7 @@ func TestTopologyInspectTooManyActiveQueries(t *testing.T) {
 	cli, cmd := setInspectCmd(t)
 	cli.MockClient.ApiMocks.SnapshotApi.QuerySnapshotResponse.Result = sts.QuerySnapshotResult{
 		Type: "QuerySnapshotResult",
-		ViewSnapshotResponse: map[string]interface{}{
+		SnapshotResponse: map[string]interface{}{
 			"_type": "ViewSnapshotTooManyActiveQueries",
 		},
 	}
@@ -324,7 +327,7 @@ func TestTopologyInspectTopologySizeOverflow(t *testing.T) {
 	cli, cmd := setInspectCmd(t)
 	cli.MockClient.ApiMocks.SnapshotApi.QuerySnapshotResponse.Result = sts.QuerySnapshotResult{
 		Type: "QuerySnapshotResult",
-		ViewSnapshotResponse: map[string]interface{}{
+		SnapshotResponse: map[string]interface{}{
 			"_type":   "ViewSnapshotTopologySizeOverflow",
 			"maxSize": float64(10000),
 		},
@@ -342,7 +345,7 @@ func TestTopologyInspectDataUnavailable(t *testing.T) {
 	cli, cmd := setInspectCmd(t)
 	cli.MockClient.ApiMocks.SnapshotApi.QuerySnapshotResponse.Result = sts.QuerySnapshotResult{
 		Type: "QuerySnapshotResult",
-		ViewSnapshotResponse: map[string]interface{}{
+		SnapshotResponse: map[string]interface{}{
 			"_type":                 "ViewSnapshotDataUnavailable",
 			"unavailableAtEpochMs":  float64(1000000),
 			"availableSinceEpochMs": float64(1609459200000),

generated/stackstate_api/.openapi-generator/FILES

@@ -402,6 +402,7 @@ docs/SlackChannelsChunk.md
 docs/SlackNotificationChannel.md
 docs/SlackNotificationChannelAllOf.md
 docs/SnapshotApi.md
+docs/SnapshotRequest.md
 docs/SourceLink.md
 docs/Span.md
 docs/SpanComponent.md
@@ -497,7 +498,6 @@ docs/UserProfileApi.md
 docs/UserProfileSaveError.md
 docs/UserSessionApi.md
 docs/ViewCheckState.md
-docs/ViewSnapshotRequest.md
 docs/WebhookChannelRefId.md
 docs/WebhookChannelWriteSchema.md
 docs/WebhookNotificationChannel.md
@@ -837,6 +837,7 @@ model_slack_channel_ref_id.go
 model_slack_channels_chunk.go
 model_slack_notification_channel.go
 model_slack_notification_channel_all_of.go
+model_snapshot_request.go
 model_source_link.go
 model_span.go
 model_span_component.go
@@ -921,7 +922,6 @@ model_user_not_logged_in_error.go
 model_user_profile.go
 model_user_profile_save_error.go
 model_view_check_state.go
-model_view_snapshot_request.go
 model_webhook_channel_ref_id.go
 model_webhook_channel_write_schema.go
 model_webhook_notification_channel.go

generated/stackstate_api/README.md

@@ -587,6 +587,7 @@ Class | Method | HTTP request | Description
  - [SlackChannelsChunk](docs/SlackChannelsChunk.md)
  - [SlackNotificationChannel](docs/SlackNotificationChannel.md)
  - [SlackNotificationChannelAllOf](docs/SlackNotificationChannelAllOf.md)
+ - [SnapshotRequest](docs/SnapshotRequest.md)
  - [SourceLink](docs/SourceLink.md)
  - [Span](docs/Span.md)
  - [SpanComponent](docs/SpanComponent.md)
@@ -671,7 +672,6 @@ Class | Method | HTTP request | Description
  - [UserProfile](docs/UserProfile.md)
  - [UserProfileSaveError](docs/UserProfileSaveError.md)
  - [ViewCheckState](docs/ViewCheckState.md)
- - [ViewSnapshotRequest](docs/ViewSnapshotRequest.md)
  - [WebhookChannelRefId](docs/WebhookChannelRefId.md)
  - [WebhookChannelWriteSchema](docs/WebhookChannelWriteSchema.md)
  - [WebhookNotificationChannel](docs/WebhookNotificationChannel.md)

generated/stackstate_api/api/openapi.yaml

@@ -6408,7 +6408,7 @@ paths:
           format: int64
           type: integer
       requestBody:
-        $ref: '#/components/requestBodies/viewSnapshotRequest'
+        $ref: '#/components/requestBodies/SnapshotRequest'
       responses:
         "200":
           content:
@@ -6608,11 +6608,11 @@ components:
             $ref: '#/components/schemas/upsertOtelRelationMappings_request'
       description: Otel Relation Mapping to create/update
       required: true
-    viewSnapshotRequest:
+    SnapshotRequest:
       content:
         application/json:
           schema:
-            $ref: '#/components/schemas/ViewSnapshotRequest'
+            $ref: '#/components/schemas/SnapshotRequest'
       description: Request body for querying a topology snapshot
       required: true
   responses:
@@ -15348,7 +15348,7 @@ components:
           type: string
       required:
       - viewIdentifier
-    ViewSnapshotRequest:
+    SnapshotRequest:
       example:
         metadata:
           minGroupSize: 0
@@ -15362,14 +15362,13 @@ components:
           connectedComponents: true
           groupingEnabled: true
           groupedByDomain: true
-        viewId: 1
         query: query
-        _type: ViewSnapshotRequest
+        _type: SnapshotRequest
         queryVersion: 0.0.1
       properties:
         _type:
           enum:
-          - ViewSnapshotRequest
+          - SnapshotRequest
           type: string
         query:
           description: STQL query string
@@ -15380,10 +15379,6 @@ components:
           type: string
         metadata:
           $ref: '#/components/schemas/QueryMetadata'
-        viewId:
-          format: int64
-          nullable: true
-          type: integer
       required:
       - _type
       - metadata
@@ -15446,35 +15441,29 @@ components:
     QuerySnapshotResult:
       description: |
         Query succeeded (or encountered a runtime error that's part of the result).
-        The viewSnapshotResponse uses existing DTO types for nested structures.
+        The SnapshotResponse uses existing DTO types for nested structures.
       example:
-        viewId: 0
-        viewSnapshotResponse: "{}"
         _type: QuerySnapshotResult
+        snapshotResponse: "{}"
       properties:
         _type:
           description: Discriminator field
           enum:
           - QuerySnapshotResult
           type: string
-        viewSnapshotResponse:
+        snapshotResponse:
           description: |
-            The query result or error response. This is opaque at the API level but contains one of:
+            The query result or error response. This is opaque at the API level but contains one of the following DTO types:
             - ViewSnapshot (success)
             - ViewSnapshotFetchTimeout (error)
             - ViewSnapshotTooManyActiveQueries (error)
             - ViewSnapshotTopologySizeOverflow (error)
             - ViewSnapshotDataUnavailable (error)
             Use the _type field to discriminate between types.
           type: object
-        viewId:
-          description: Optional view ID associated with this result
-          format: int64
-          nullable: true
-          type: integer
       required:
       - _type
-      - viewSnapshotResponse
+      - snapshotResponse
       type: object
     QueryParsingFailure:
       description: |