action microcks_get_test_results_by_service {
  label: "Get TestResults by Service"
  provider: microcks
  method: GET
  path: "/tests/service/{serviceId}"
  encoding: json
  output: {
    type: "array"
    items: {
      description: "Represents the result of a Service or API test run by Microcks. Tests are related to a service and made of multiple test cases corresponding to each operations / actions composing service. Tests are run against a specific endpoint named testedEndpoint. It holds global markers telling if test still ran, is a success, how many times is has taken and so on ..."
      required: ["id", "version", "testNumber", "testDate", "testedEndpoint", "serviceId", "success", "inProgress", "runnerType"]
      properties: {
        elapsedTime: {
          type: "number"
          description: "Elapsed time in milliseconds since test beginning"
        }
        id: {
          type: "string"
          description: "Unique identifier of TestResult"
        }
        inProgress: {
          type: "boolean"
          description: "Flag telling is test is still in progress"
        }
        operationHeaders: {
          type: "object"
          description: "Specification of additional headers for a Service/API operations. Keys are operation name or \"globals\" (if header applies to all), values are Header objects DTO."
        }
        runnerType: {
          type: "string"
          description: "Type of test strategy (different strategies are implemented by different runners)"
          enum: ["HTTP", "SOAP_HTTP", "SOAP_UI", "POSTMAN", "OPEN_API_SCHEMA", "ASYNC_API_SCHEMA", "GRPC_PROTOBUF", "GRAPHQL_SCHEMA"]
        }
        secretRef: {
          description: "Lightweight reference for an existing Secret"
          required: ["secretId", "name"]
          properties: {
            name: {
              type: "string"
              description: "Distinct name of the referenced Secret"
            }
            secretId: {
              type: "string"
              description: "Unique identifier or referenced Secret"
            }
          }
        }
        serviceId: {
          type: "string"
          description: "Unique identifier of service tested"
        }
        success: {
          type: "boolean"
          description: "Flag telling if test is a success"
        }
        testCaseResults: {
          type: "array"
          description: "TestCase results associated to this test"
          items: {
            description: "Companion objects for TestResult. Each TestCaseResult correspond to a particuliar service operation / action reference by the operationName field. TestCaseResults owns a collection of TestStepResults (one for every request associated to service operation / action)."
            required: ["success", "elapsedTime", "operationName"]
            properties: {
              elapsedTime: {
                type: "number"
                description: "Elapsed time in milliseconds since the test case beginning"
              }
              operationName: {
                type: "string"
                description: "Name of operation this test case is bound to"
              }
              success: {
                type: "boolean"
                description: "Flag telling if test case is a success"
              }
              testStepResults: {
                type: "array"
                description: "Test steps associated to this test case"
                items: {
                  description: "TestStepResult is an entity embedded within TestCaseResult. They are created for each request associated with an operation / action of a microservice."
                  required: ["success", "elapsedTome"]
                  properties: {
                    elapsedTime: {
                      type: "number"
                      description: "Elapsed time in milliseconds since the test step beginning"
                    }
                    eventMessageName: {
                      type: "string"
                      description: "Name of event this test step is bound to"
                    }
                    message: {
                      type: "string"
                      description: "Error message that may be associated to this test step"
                    }
                    requestName: {
                      type: "string"
                      description: "Name of request this test step is bound to"
                    }
                    success: {
                      type: "boolean"
                      description: "Flag telling if test case is a success"
                    }
                  }
                }
              }
            }
          }
        }
        testDate: {
          type: "integer"
          format: "int64"
          description: "Timestamp of creation date of this service"
        }
        testNumber: {
          type: "number"
          description: "Incremental number for tracking number of tests of a service"
        }
        testedEndpoint: {
          type: "string"
          description: "Endpoint used during test"
        }
        timeout: {
          type: "integer"
          description: "The maximum time (in milliseconds) to wait for this test ends"
        }
        version: {
          type: "number"
          description: "Revision number of this test"
        }
      }
    }
  }
}