Data API V2: Make adjustments to align SDK data between v1 and v2 #3353
Conversation
stephybun
changed the title
tools/importer-rest-api-specs/components/dataapigeneratorjson/templater_operations.go
Outdated
Show resolved
Hide resolved
tools/data-api/internal/endpoints/v1/schema_for_api_resource.go
Outdated
Show resolved
Hide resolved
| // disregard the response object if it's either a long running operation or not a list operation | ||
| if !input.LongRunning || input.FieldContainingPaginationDetails != nil { | ||
| responseObject, err := mapObjectDefinition(input.ResponseObject, knownConstants, knownModels) | ||
| if err != nil { | ||
| return nil, fmt.Errorf("mapping the response object definition: %+v", err) | ||
| } | ||
| output.ResponseObject = responseObject | ||
| } |
There was a problem hiding this comment.
In V1, we're outputting the Response Object into the API Definitions and then having the Data API handling transforming this - the intention was that we could decide later on if we wanted to pipe this through or not.
As you're doing here, V1 currently removes the Response Object from a Long Running Operation when it's mapped - however since supporting returning the Response Object from a Long Running Operation requires a larger set of changes, rather than stripping this out in the Data API, the importer should do this instead - as such I'll send a separate PR for this shortly.
However - the Response Object is necessary for a List Operation - in the V1 API Definitions the base type used for a ListOperation expects that each operation outputs this into the NestedItemType field which is returned from the ResponseObject method. This is for historical reasons, where the ListOperations were treated differently - but ultimately the NestedItemType field gets pulled out into the ResponseObject field - meaning that we need to include this.
As such can we remove this logic for the moment? Whilst that's going to be temporarily incorrect, can we update both the Importer and Data API V1 so that we don't output these values (update: #3364 is opened) - which'll fix this issue going forwards.
| // disregard the response object if it's either a long running operation or not a list operation | |
| if !input.LongRunning || input.FieldContainingPaginationDetails != nil { | |
| responseObject, err := mapObjectDefinition(input.ResponseObject, knownConstants, knownModels) | |
| if err != nil { | |
| return nil, fmt.Errorf("mapping the response object definition: %+v", err) | |
| } | |
| output.ResponseObject = responseObject | |
| } |
No description provided.