Include "detail" param in Swagger for GET operation

Signed-off-by: Andrew Richardson <[email protected]>
hyperledger · Nov 1, 2023 · 26104c1 · 26104c1
1 parent 43dff8f
commit 26104c1
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 1 deletion.
diff --git a/docs/swagger/swagger.yaml b/docs/swagger/swagger.yaml
@@ -26737,6 +26737,9 @@ paths:
                     description: The time the operation was created
                     format: date-time
                     type: string
+                  detail:
+                    description: Additional detailed information about an operation
+                      provided by the connector
                   error:
                     description: Any error reported back from the plugin for this
                       operation
@@ -35719,6 +35722,9 @@ paths:
                     description: The time the operation was created
                     format: date-time
                     type: string
+                  detail:
+                    description: Additional detailed information about an operation
+                      provided by the connector
                   error:
                     description: Any error reported back from the plugin for this
                       operation

diff --git a/internal/apiserver/route_get_op_by_id.go b/internal/apiserver/route_get_op_by_id.go
@@ -37,7 +37,7 @@ var getOpByID = &ffapi.Route{
 	},
 	Description:     coremsgs.APIEndpointsGetOpByID,
 	JSONInputValue:  nil,
-	JSONOutputValue: func() interface{} { return &core.Operation{} },
+	JSONOutputValue: func() interface{} { return &core.OperationWithDetail{} },
 	JSONOutputCodes: []int{http.StatusOK},
 	Extensions: &coreExtensions{
 		CoreJSONHandler: func(r *ffapi.APIRequest, cr *coreRequest) (output interface{}, err error) {