diff --git a/api/microcks-openapi-v1.10.yaml b/api/microcks-openapi-v1.10.yaml index 4d521fa..b38f40a 100644 --- a/api/microcks-openapi-v1.10.yaml +++ b/api/microcks-openapi-v1.10.yaml @@ -2,7 +2,7 @@ openapi: 3.0.2 info: title: Microcks API v1.10 - version: 1.10.0 + version: 1.10.1 description: "API offered by Microcks, the Kubernetes native tool for API and microservices\ \ mocking and testing (microcks.io)" contact: @@ -16,26 +16,26 @@ info: backgroundColor: '#ffffff' url: https://microcks.io/images/microcks-logo-blue.png servers: - - url: http://microcks.example.com/api - description: "" +- url: http://microcks.example.com/api + description: "" paths: /services: summary: This path operations deal with Services get: tags: - - mock + - mock parameters: - - name: page - description: Page of Services to retrieve (starts at and defaults to 0) - schema: - type: integer - in: query - - name: size - description: Size of a page. Maximum number of Services to include in a response - (defaults to 20) - schema: - type: integer - in: query + - name: page + description: Page of Services to retrieve (starts at and defaults to 0) + schema: + type: integer + in: query + - name: size + description: Size of a page. Maximum number of Services to include in a response + (defaults to 20) + schema: + type: integer + in: query responses: "200": content: @@ -46,8 +46,8 @@ paths: $ref: '#/components/schemas/Service' description: List of found Services security: - - jwt-bearer: - - user + - jwt-bearer: + - user operationId: GetServices summary: Get Services and APIs /tests: @@ -59,7 +59,7 @@ paths: $ref: '#/components/schemas/TestRequest' required: true tags: - - test + - test responses: "201": content: @@ -68,14 +68,14 @@ paths: $ref: '#/components/schemas/TestResult' description: Created TestResult (empty shell cause tests are executed asynchronously) security: - - jwt-bearer: - - user + - jwt-bearer: + - user operationId: CreateTest summary: Create a new Test /services/count: get: tags: - - mock + - mock responses: "200": content: @@ -84,32 +84,32 @@ paths: $ref: '#/components/schemas/Counter' description: Number of Services in datastore security: - - jwt-bearer: - - user + - jwt-bearer: + - user operationId: GetServicesCounter summary: Get the Services counter /jobs: summary: This path operations deal with ImportJobs get: tags: - - job + - job parameters: - - name: page - description: Page of ImportJobs to retrieve (starts at and defaults to 0) - schema: - type: integer - in: query - - name: size - description: Size of a page. Maximum number of ImportJobs to include in a - response (defaults to 20) - schema: - type: integer - in: query - - name: name - description: Name like criterion for query - schema: - type: string - in: query + - name: page + description: Page of ImportJobs to retrieve (starts at and defaults to 0) + schema: + type: integer + in: query + - name: size + description: Size of a page. Maximum number of ImportJobs to include in a + response (defaults to 20) + schema: + type: integer + in: query + - name: name + description: Name like criterion for query + schema: + type: string + in: query responses: "200": content: @@ -120,8 +120,8 @@ paths: $ref: '#/components/schemas/ImportJob' description: List of found ImportJobs security: - - jwt-bearer: - - user + - jwt-bearer: + - user operationId: GetImportJobs summary: Get ImportJobs description: Retrieve a list of ImportJobs @@ -133,7 +133,7 @@ paths: $ref: '#/components/schemas/ImportJob' required: true tags: - - job + - job responses: "201": content: @@ -142,8 +142,8 @@ paths: $ref: '#/components/schemas/ImportJob' description: Created ImportJob security: - - jwt-bearer: - - user + - jwt-bearer: + - user operationId: CreateImportJob summary: Create ImportJob description: Create a new ImportJob @@ -152,7 +152,7 @@ paths: given id get: tags: - - job + - job responses: "200": content: @@ -161,8 +161,8 @@ paths: $ref: '#/components/schemas/ImportJob' description: Found ImportJob security: - - jwt-bearer: - - user + - jwt-bearer: + - user operationId: GetImportJob summary: Get ImportJob description: Retrieve an ImportJob using its identifier @@ -174,7 +174,7 @@ paths: $ref: '#/components/schemas/ImportJob' required: true tags: - - job + - job responses: "200": content: @@ -187,64 +187,64 @@ paths: description: Update an ImportJob delete: tags: - - job + - job responses: "200": content: application/json: {} description: ImportJob deleted security: - - jwt-bearer: - - admin + - jwt-bearer: + - admin operationId: DeleteImportJob summary: Delete ImportJob description: Delete an ImportJob parameters: - - name: id - description: Unique identifier of ImportJob to manage - schema: - type: string - in: path - required: true + - name: id + description: Unique identifier of ImportJob to manage + schema: + type: string + in: path + required: true /services/{id}: get: tags: - - mock + - mock parameters: - - name: messages - description: Whether to include details on services messages into result. - Default is false - schema: - type: boolean - in: query + - name: messages + description: Whether to include details on services messages into result. + Default is false + schema: + type: boolean + in: query responses: "200": $ref: '#/components/responses/ServiceResponse' security: - - jwt-bearer: - - user + - jwt-bearer: + - user operationId: GetService summary: Get Service delete: tags: - - mock + - mock responses: "200": description: Service has been deleted security: - - jwt-bearer: - - admin - - manager + - jwt-bearer: + - admin + - manager operationId: DeleteService summary: Delete Service description: Delete a Service parameters: - - name: id - description: Unique identifier of Service to managed - schema: - type: string - in: path - required: true + - name: id + description: Unique identifier of Service to managed + schema: + type: string + in: path + required: true /artifact/upload: summary: Deals with artifacts to be imported by Microcks. post: @@ -274,15 +274,15 @@ paths: --------------------------8af8cbb56dd4bde0-- required: true tags: - - job + - job parameters: - - name: mainArtifact - description: Flag telling if this should be considered as primary or secondary - artifact. Default to 'true' - schema: - type: boolean - in: query - required: true + - name: mainArtifact + description: Flag telling if this should be considered as primary or secondary + artifact. Default to 'true' + schema: + type: boolean + in: query + required: true responses: "201": content: @@ -299,8 +299,8 @@ paths: type: string description: Artifact content is invalid and not understood security: - - jwt-bearer: - - user + - jwt-bearer: + - manager operationId: uploadArtifact summary: Upload an artifact description: Uploads an artifact to be imported by Microcks. @@ -308,7 +308,7 @@ paths: summary: Count ImportJobs get: tags: - - job + - job responses: "200": content: @@ -317,29 +317,29 @@ paths: $ref: '#/components/schemas/Counter' description: Number of ImportJobs in datastore security: - - jwt-bearer: - - user + - jwt-bearer: + - user operationId: GetImportJobCounter summary: Get the ImportJobs counter /secrets: summary: This path operations deal with Secrets get: tags: - - config + - config parameters: - - name: page - description: Page of Secrets to retrieve (starts at and defaults to 0) - schema: - type: integer - in: query - required: false - - name: size - description: Size of a page. Maximum number of Secrets to include in a response - (defaults to 20) - schema: - type: integer - in: query - required: false + - name: page + description: Page of Secrets to retrieve (starts at and defaults to 0) + schema: + type: integer + in: query + required: false + - name: size + description: Size of a page. Maximum number of Secrets to include in a response + (defaults to 20) + schema: + type: integer + in: query + required: false responses: "200": content: @@ -350,8 +350,8 @@ paths: $ref: '#/components/schemas/Secret' description: List of found Secrets security: - - jwt-bearer: - - user + - jwt-bearer: + - user operationId: GetSecrets summary: Get Secrets post: @@ -361,7 +361,7 @@ paths: schema: $ref: '#/components/schemas/Secret' tags: - - config + - config responses: "201": content: @@ -370,14 +370,14 @@ paths: $ref: '#/components/schemas/Secret' description: Created Secret security: - - jwt-bearer: - - admin + - jwt-bearer: + - admin operationId: CreateSecret summary: Create a new Secret /secrets/{id}: get: tags: - - config + - config responses: "200": content: @@ -386,8 +386,8 @@ paths: $ref: '#/components/schemas/Secret' description: Found Secret security: - - jwt-bearer: - - admin + - jwt-bearer: + - admin operationId: GetSecret summary: Get Secret description: Retrieve a Secret @@ -400,7 +400,7 @@ paths: $ref: '#/components/schemas/Secret' required: true tags: - - config + - config responses: "200": content: @@ -409,34 +409,34 @@ paths: $ref: '#/components/schemas/Secret' description: Updated Secret security: - - jwt-bearer: - - admin + - jwt-bearer: + - admin operationId: UpdateSecret summary: Update Secret description: Update a Secret delete: tags: - - config + - config responses: "200": description: Secret has been deleted security: - - jwt-bearer: - - admin + - jwt-bearer: + - admin operationId: DeleteSecret summary: Delete Secret description: Delete a Secret parameters: - - name: id - description: Unique identifier of Secret to manage - schema: - type: string - in: path - required: true + - name: id + description: Unique identifier of Secret to manage + schema: + type: string + in: path + required: true /secrets/count: get: tags: - - config + - config responses: "200": content: @@ -445,14 +445,14 @@ paths: $ref: '#/components/schemas/Counter' description: Number of Secrets in datastore security: - - jwt-bearer: - - user + - jwt-bearer: + - user operationId: GetSecretsCounter summary: Get the Secrets counter /tests/service/{serviceId}: get: tags: - - test + - test responses: "200": content: @@ -463,21 +463,21 @@ paths: $ref: '#/components/schemas/TestResult' description: List of TestResults for the Service having the requested id security: - - jwt-bearer: - - user + - jwt-bearer: + - user operationId: GetTestResultsByService summary: Get TestResults by Service parameters: - - name: serviceId - description: Unique identifier of Service to manage TestResults for - schema: - type: string - in: path - required: true + - name: serviceId + description: Unique identifier of Service to manage TestResults for + schema: + type: string + in: path + required: true /tests/service/{serviceId}/count: get: tags: - - test + - test responses: "200": content: @@ -486,21 +486,21 @@ paths: $ref: '#/components/schemas/Counter' description: Number of TestResults for this Service in datastore security: - - jwt-bearer: - - user + - jwt-bearer: + - user operationId: GetTestResultsByServiceCounter summary: Get the TestResults for Service counter parameters: - - name: serviceId - description: Unique identifier of Service to manage TestResults for - schema: - type: string - in: path - required: true + - name: serviceId + description: Unique identifier of Service to manage TestResults for + schema: + type: string + in: path + required: true /tests/{id}: get: tags: - - test + - test responses: "200": content: @@ -509,22 +509,22 @@ paths: $ref: '#/components/schemas/TestResult' description: Requested TestResult security: - - jwt-bearer: - - user + - jwt-bearer: + - user operationId: GetTestResult summary: Get TestResult description: "" parameters: - - name: id - description: Unique identifier of TestResult to manage - schema: - type: string - in: path - required: true + - name: id + description: Unique identifier of TestResult to manage + schema: + type: string + in: path + required: true /tests/{id}/messages/{testCaseId}: get: tags: - - test + - test responses: "200": content: @@ -535,23 +535,23 @@ paths: $ref: '#/components/schemas/RequestResponsePair' description: List of request and response messages for this TestCase security: - - jwt-bearer: - - user + - jwt-bearer: + - user operationId: GetMessagesByTestCase summary: Get messages for TestCase parameters: - - name: id - description: Unique identifier of TestResult to manage - schema: - type: string - in: path - required: true - - name: testCaseId - description: Unique identifier of TetsCaseResult to manage - schema: - type: string - in: path - required: true + - name: id + description: Unique identifier of TestResult to manage + schema: + type: string + in: path + required: true + - name: testCaseId + description: Unique identifier of TetsCaseResult to manage + schema: + type: string + in: path + required: true /tests/{id}/testCaseResult: post: requestBody: @@ -562,7 +562,7 @@ paths: $ref: '#/components/schemas/TestCaseReturnDTO' required: true tags: - - test + - test responses: "200": content: @@ -574,17 +574,17 @@ paths: summary: Report and create a new TestCaseResult description: Report a TestCaseResult (typically used by a Test runner) parameters: - - name: id - description: Unique identifier of TestResult to manage - schema: - type: string - in: path - required: true + - name: id + description: Unique identifier of TestResult to manage + schema: + type: string + in: path + required: true /keycloak/config: summary: Keycloak Authentification configuration get: tags: - - config + - config responses: "200": content: @@ -603,32 +603,32 @@ paths: $ref: '#/components/schemas/OperationOverrideDTO' required: true tags: - - mock + - mock parameters: - - name: operationName - description: Name of operation to update - schema: - type: string - in: query - required: true + - name: operationName + description: Name of operation to update + schema: + type: string + in: query + required: true responses: "200": description: Operation has been updated "500": description: Operation cannot be updated security: - - jwt-bearer: - - admin - - manager + - jwt-bearer: + - admin + - manager operationId: OverrideServiceOperation summary: Override Service Operation parameters: - - name: id - description: Unique identifier of Service to managed - schema: - type: string - in: path - required: true + - name: id + description: Unique identifier of Service to managed + schema: + type: string + in: path + required: true /services/{id}/metadata: put: requestBody: @@ -638,40 +638,40 @@ paths: $ref: '#/components/schemas/Metadata' required: true tags: - - mock + - mock responses: "200": description: Service metadata has been updated "500": description: Update of metadata failed security: - - jwt-bearer: - - admin - - manager + - jwt-bearer: + - admin + - manager operationId: UpdateServiceMetadata summary: Update Service Metadata parameters: - - name: id - description: Unique identifier of Service to managed - schema: - type: string - in: path - required: true + - name: id + description: Unique identifier of Service to managed + schema: + type: string + in: path + required: true /services/search: get: tags: - - mock + - mock parameters: - - name: queryMap - description: Map of criterion. Key can be simply 'name' with value as the - searched string. You can also search by label using keys like 'labels.x' - where 'x' is the label and value the label value - schema: - type: object - additionalProperties: - type: string - in: query - required: true + - name: queryMap + description: Map of criterion. Key can be simply 'name' with value as the + searched string. You can also search by label using keys like 'labels.x' + where 'x' is the label and value the label value + schema: + type: object + additionalProperties: + type: string + in: query + required: true responses: "200": content: @@ -682,14 +682,14 @@ paths: $ref: '#/components/schemas/Service' description: List of found Services (filtered according search criteria) security: - - jwt-bearer: - - user + - jwt-bearer: + - user operationId: SearchServices summary: Search for Services and APIs /tests/{id}/events/{testCaseId}: get: tags: - - test + - test responses: "200": content: @@ -702,18 +702,18 @@ paths: operationId: GetEventsByTestCase summary: Get events for TestCase parameters: - - name: id - description: Unique identifier of TestResult to manage - schema: - type: string - in: path - required: true - - name: testCaseId - description: Unique identifier of TetsCaseResult to manage - schema: - type: string - in: path - required: true + - name: id + description: Unique identifier of TestResult to manage + schema: + type: string + in: path + required: true + - name: testCaseId + description: Unique identifier of TetsCaseResult to manage + schema: + type: string + in: path + required: true /resources/{name}: get: responses: @@ -724,17 +724,17 @@ paths: $ref: '#/components/schemas/Resource' description: Retrieve the resource having this name security: - - jwt-bearer: - - user + - jwt-bearer: + - user operationId: GetResource summary: Get Resource parameters: - - name: name - description: Unique name/business identifier of the Service or API resource - schema: - type: string - in: path - required: true + - name: name + description: Unique name/business identifier of the Service or API resource + schema: + type: string + in: path + required: true /resources/service/{serviceId}: get: responses: @@ -747,23 +747,23 @@ paths: $ref: '#/components/schemas/Resource' description: List the resources attached to a Service or API security: - - jwt-bearer: - - user + - jwt-bearer: + - user operationId: GetResourcesByService summary: Get Resources by Service parameters: - - name: serviceId - description: Unique identifier of the Service or API the resources are attached - to - schema: - type: string - in: path - required: true + - name: serviceId + description: Unique identifier of the Service or API the resources are attached + to + schema: + type: string + in: path + required: true /features/config: summary: Optional features configuration get: tags: - - config + - config responses: "200": content: @@ -781,13 +781,13 @@ paths: $ref: '#/components/schemas/SnapshotUpload' required: true tags: - - mock + - mock responses: "201": description: Snasphot has been correctly imported security: - - jwt-bearer: - - admin + - jwt-bearer: + - admin operationId: importSnapshot summary: Import a snapshot description: Import a repository snapshot previsouly exported into Microcks @@ -795,16 +795,16 @@ paths: summary: Deals with repository snapshot to import from Microcks get: tags: - - mock + - mock parameters: - - name: serviceIds - description: List of service identifiers to export - schema: - type: array - items: - type: string - in: query - required: true + - name: serviceIds + description: List of service identifiers to export + schema: + type: array + items: + type: string + in: query + required: true responses: "200": headers: @@ -821,8 +821,8 @@ paths: type: string description: Snapshot file representing the export of requested services security: - - jwt-bearer: - - admin + - jwt-bearer: + - admin operationId: exportSnapshot summary: Export a snapshot description: Export a repostiory snapshot with requested services @@ -830,14 +830,14 @@ paths: summary: Invocation Statistics across Services and APIs get: tags: - - metrics + - metrics parameters: - - name: day - description: The day to get statistics for (formatted with yyyyMMdd pattern). - Default to today if not provided. - schema: - type: string - in: query + - name: day + description: The day to get statistics for (formatted with yyyyMMdd pattern). + Default to today if not provided. + schema: + type: string + in: query responses: "200": content: @@ -851,7 +851,7 @@ paths: summary: Aggregation of Test conformance metrics get: tags: - - metrics + - metrics responses: "200": content: @@ -867,7 +867,7 @@ paths: summary: Test Conformance metrics on API and Services get: tags: - - metrics + - metrics responses: "200": content: @@ -878,29 +878,29 @@ paths: operationId: GetServiceTestConformanceMetric summary: Get conformance metrics for a Service parameters: - - name: serviceId - description: Unique Services identifier this metrics are related to - schema: - type: string - in: path - required: true + - name: serviceId + description: Unique Services identifier this metrics are related to + schema: + type: string + in: path + required: true /metrics/invocations/top: summary: Top Invocation Statistics across Services and APIs get: tags: - - metrics + - metrics parameters: - - name: day - description: The day to get statistics for (formatted with yyyyMMdd pattern). - Default to today if not provided. - schema: - type: string - in: query - - name: limit - description: The number of top invoked mocks to return - schema: - type: integer - in: query + - name: day + description: The day to get statistics for (formatted with yyyyMMdd pattern). + Default to today if not provided. + schema: + type: string + in: query + - name: limit + description: The number of top invoked mocks to return + schema: + type: integer + in: query responses: "200": content: @@ -916,14 +916,14 @@ paths: summary: Invocation Statistics for API and Services get: tags: - - metrics + - metrics parameters: - - name: day - description: The day to get statistics for (formatted with yyyyMMdd pattern). - Default to today if not provided. - schema: - type: string - in: query + - name: day + description: The day to get statistics for (formatted with yyyyMMdd pattern). + Default to today if not provided. + schema: + type: string + in: query responses: "200": content: @@ -934,29 +934,29 @@ paths: operationId: GetInvocationStatsByService summary: Get invocation statistics for Service parameters: - - name: serviceName - description: Name of service to get statistics for - schema: - type: string - in: path - required: true - - name: serviceVersion - description: Version of service to get statistics for - schema: - type: string - in: path - required: true + - name: serviceName + description: Name of service to get statistics for + schema: + type: string + in: path + required: true + - name: serviceVersion + description: Version of service to get statistics for + schema: + type: string + in: path + required: true /metrics/invocations/global/latest: summary: Latest Invocation Statistics across Services and APIs get: tags: - - metrics + - metrics parameters: - - name: limit - description: Number of days to get back in time. Default is 20. - schema: - type: integer - in: query + - name: limit + description: Number of days to get back in time. Default is 20. + schema: + type: integer + in: query responses: "200": content: @@ -971,14 +971,14 @@ paths: summary: Lastest Test results across Services and APIs get: tags: - - metrics + - metrics parameters: - - name: limit - description: Number of days to consider for test results to return. Default - is 7 (one week) - schema: - type: integer - in: query + - name: limit + description: Number of days to consider for test results to return. Default + is 7 (one week) + schema: + type: integer + in: query responses: "200": content: @@ -993,7 +993,7 @@ paths: /jobs/{id}/start: put: tags: - - job + - job responses: "200": content: @@ -1002,23 +1002,23 @@ paths: $ref: '#/components/schemas/ImportJob' description: Started ImportJob security: - - jwt-bearer: - - manager - - admin + - jwt-bearer: + - manager + - admin operationId: StartImportJob summary: Start an ImportJob description: Starting an ImportJob forces it to immediatly import mock definitions parameters: - - name: id - description: Unique identifier of ImportJob to manage - schema: - type: string - in: path - required: true + - name: id + description: Unique identifier of ImportJob to manage + schema: + type: string + in: path + required: true /jobs/{id}/stop: put: tags: - - job + - job responses: "200": content: @@ -1027,24 +1027,24 @@ paths: $ref: '#/components/schemas/ImportJob' description: Stopped ImportJob security: - - jwt-bearer: - - manager - - admin + - jwt-bearer: + - manager + - admin operationId: StopImportJob summary: Stop an ImportJob description: "Stopping an ImportJob desactivate it, so that it won't execute\ \ at next schedule" parameters: - - name: id - description: Unique identifier of ImportJob to manage - schema: - type: string - in: path - required: true + - name: id + description: Unique identifier of ImportJob to manage + schema: + type: string + in: path + required: true /jobs/{id}/activate: put: tags: - - job + - job responses: "200": content: @@ -1053,23 +1053,23 @@ paths: $ref: '#/components/schemas/ImportJob' description: ImportJob is activated security: - - jwt-bearer: - - manager - - admin + - jwt-bearer: + - manager + - admin operationId: ActivateImportJob summary: Activate an ImportJob description: "Make an ImportJob active, so that it is executed" parameters: - - name: id - description: Unique identifier of ImportJob to manage - schema: - type: string - in: path - required: true + - name: id + description: Unique identifier of ImportJob to manage + schema: + type: string + in: path + required: true /services/labels: get: tags: - - mock + - mock responses: "200": content: @@ -1079,8 +1079,8 @@ paths: description: "Already used labels: keys are label Keys, values are array\ \ of label Values" security: - - jwt-bearer: - - user + - jwt-bearer: + - user operationId: GetServicesLabels summary: Get the already used labels for Services /artifact/download: @@ -1093,7 +1093,7 @@ paths: $ref: '#/components/schemas/ArtifactDownload' required: true tags: - - job + - job responses: "201": content: @@ -1110,22 +1110,22 @@ paths: type: string description: Artifact content is invalid and not understood security: - - jwt-bearer: - - manager + - jwt-bearer: + - manager operationId: downloadArtifact summary: Download an artifact description: Ask Microcks to download an artifact and import it /secrets/search: get: tags: - - config + - config parameters: - - name: name - description: Search using this name-like criterion - schema: - type: string - in: query - required: true + - name: name + description: Search using this name-like criterion + schema: + type: string + in: query + required: true responses: "200": content: @@ -1136,8 +1136,8 @@ paths: $ref: '#/components/schemas/Secret' description: List of found Secrets (filtered according search criteria) security: - - jwt-bearer: - - admin + - jwt-bearer: + - admin operationId: SearchSecrets summary: Search for Secrets components: @@ -1148,9 +1148,9 @@ components: field. TestCaseResults owns a collection of TestStepResults (one for every request associated to service operation / action). required: - - success - - elapsedTime - - operationName + - success + - elapsedTime + - operationName properties: success: description: Flag telling if test case is a success @@ -1169,9 +1169,9 @@ components: ServiceRef: description: Lightweight reference of an existing Service required: - - serviceId - - name - - version + - serviceId + - name + - version properties: serviceId: description: Unique reference of a Service @@ -1185,8 +1185,8 @@ components: SecretRef: description: Lightweight reference for an existing Secret required: - - secretId - - name + - secretId + - name properties: secretId: description: Unique identifier or referenced Secret @@ -1203,8 +1203,8 @@ components: description: A Secret allows grouping informations on how to access a restricted resource such as a repsoitory URL. Secrets are typically used by ImpoortJobs. required: - - name - - description + - name + - description properties: id: description: Unique identifier of Secret @@ -1236,7 +1236,7 @@ components: } TestCaseReturnDTO: required: - - operationName + - operationName properties: operationName: description: Name of related operation for this TestCase @@ -1245,8 +1245,8 @@ components: description: TestReturn is used for wrapping the return code of a test step execution required: - - code - - elapsedTime + - code + - elapsedTime properties: code: description: "Return code for test (0 means Success, 1 means Failure)" @@ -1270,8 +1270,8 @@ components: Request: description: A mock invocation or test request required: - - name - - operationId + - name + - operationId properties: id: description: Unique identifier of Request @@ -1297,8 +1297,8 @@ components: Response: description: A mock invocation or test response required: - - operationId - - name + - operationId + - name properties: operationId: description: Identifier of Operation this Response is associated to @@ -1324,8 +1324,8 @@ components: Header: description: Transport headers for both Requests and Responses required: - - name - - values + - name + - values type: object properties: name: @@ -1340,8 +1340,8 @@ components: 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 + - success + - elapsedTome properties: success: description: Flag telling if test case is a success @@ -1362,12 +1362,12 @@ components: description: Representation of Keycloak / SSO configuration used by Microcks server required: - - realm - - auth-server-url - - public-client - - ssl-required - - resource - - enabled + - realm + - auth-server-url + - public-client + - ssl-required + - resource + - enabled type: object properties: realm: @@ -1383,8 +1383,8 @@ components: ssl-required: description: SSL certificates requirements enum: - - none - - external + - none + - external resource: description: Name of Keycloak resource/application used on client side type: string @@ -1395,18 +1395,18 @@ components: description: Request associated with corresponding Response type: object allOf: - - required: - - request - - response - type: object - properties: - request: - $ref: '#/components/schemas/Request' - description: The request part of the pair - response: - $ref: '#/components/schemas/Response' - description: The Response part of the pair - - $ref: '#/components/schemas/AbstractExchange' + - required: + - request + - response + type: object + properties: + request: + $ref: '#/components/schemas/Request' + description: The request part of the pair + response: + $ref: '#/components/schemas/Response' + description: The Response part of the pair + - $ref: '#/components/schemas/AbstractExchange' OperationOverrideDTO: description: Data Transfer object for grouping the mutable properties of an Operation @@ -1431,7 +1431,7 @@ components: description: Companion object for Operation that may be used to express constraints on request parameters required: - - name + - name type: object properties: name: @@ -1449,16 +1449,16 @@ components: in: description: Parameter location enum: - - path - - query - - header + - path + - query + - header type: string Metadata: description: Commodity object for holding metadata on any entity. This object is inspired by Kubernetes metadata. required: - - createdOn - - lastUpdate + - createdOn + - lastUpdate type: object properties: createdOn: @@ -1490,19 +1490,19 @@ components: description: Representation of an unidirectional exchange as an event message type: object allOf: - - required: - - eventMessage - type: object - properties: - eventMessage: - $ref: '#/components/schemas/EventMessage' - description: Asynchronous message for this unidirectional event - - $ref: '#/components/schemas/AbstractExchange' + - required: + - eventMessage + type: object + properties: + eventMessage: + $ref: '#/components/schemas/EventMessage' + description: Asynchronous message for this unidirectional event + - $ref: '#/components/schemas/AbstractExchange' EventMessage: description: "" required: - - id - - mediaType + - id + - mediaType type: object properties: id: @@ -1541,8 +1541,8 @@ components: $ref: '#/components/schemas/Exchange' Exchange: oneOf: - - $ref: '#/components/schemas/RequestResponsePair' - - $ref: '#/components/schemas/UnidirectionalEvent' + - $ref: '#/components/schemas/RequestResponsePair' + - $ref: '#/components/schemas/UnidirectionalEvent' discriminator: propertyName: type mapping: @@ -1553,20 +1553,20 @@ components: AbstractExchange: description: Abstract bean representing a Service or API Exchange. required: - - type + - type type: object properties: type: description: Discriminant type for identifying kind of exchange enum: - - reqRespPair - - unidirEvent + - reqRespPair + - unidirEvent type: string ServiceView: description: Aggregate bean for grouping a Service an its messages pairs required: - - service - - messagesMap + - service + - messagesMap type: object properties: service: @@ -1582,10 +1582,10 @@ components: description: Test request is a minimalist wrapper for requesting the launch of a new test required: - - serviceId - - testEndpoint - - runnerType - - timeout + - serviceId + - testEndpoint + - runnerType + - timeout properties: serviceId: description: Unique identifier of service to test @@ -1618,11 +1618,11 @@ components: description: "Resource represents a Service or API artifacts such as specification,\ \ contract" required: - - id - - name - - content - - type - - serviceId + - id + - name + - content + - type + - serviceId type: object properties: id: @@ -1651,20 +1651,20 @@ components: 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 + - HTTP + - SOAP_HTTP + - SOAP_UI + - POSTMAN + - OPEN_API_SCHEMA + - ASYNC_API_SCHEMA + - GRPC_PROTOBUF + - GRAPHQL_SCHEMA type: string Operation: description: An Operation of a Service or API required: - - name - - method + - name + - method type: object properties: name: @@ -1708,7 +1708,7 @@ components: Artifact to be imported by Microcks. This structure represents a mime-multipart file upload (as specified here: https://swagger.io/docs/specification/describing-request-body/file-upload/) required: - - file + - file type: object properties: file: @@ -1809,7 +1809,7 @@ components: SnapshotUpload: description: Upload of a repository snapshot file required: - - file + - file type: object properties: file: @@ -1819,8 +1819,8 @@ components: HeaderDTO: description: Data Transfert Object for headers of both Requests and Responses required: - - name - - values + - name + - values type: object properties: name: @@ -1842,10 +1842,10 @@ components: description: Represents a Service or API definition as registred into Microcks repository required: - - name - - version - - type - - sourceArtifact + - name + - version + - type + - sourceArtifact properties: id: description: Unique identifier for this Service or API @@ -1860,13 +1860,13 @@ components: type: description: Service or API Type enum: - - REST - - SOAP_HTTP - - GENERIC_REST - - GENERIC_EVENT - - EVENT - - GRPC - - GRAPHQL + - REST + - SOAP_HTTP + - GENERIC_REST + - GENERIC_EVENT + - EVENT + - GRPC + - GRAPHQL type: string operations: description: Set of Operations for Service or API @@ -1886,18 +1886,18 @@ components: Trend: description: Evolution trend qualifier enum: - - DOWN - - LOW_DOWN - - STABLE - - LOW_UP - - UP + - DOWN + - LOW_DOWN + - STABLE + - LOW_UP + - UP type: string WeightedMetricValue: description: Value of a metric with an associated weight required: - - name - - weight - - value + - name + - weight + - value type: object properties: name: @@ -1912,11 +1912,11 @@ components: DailyInvocationStatistic: description: The daily statistic of a service mock invocations required: - - id - - day - - serviceName - - serviceVersion - - dailyCount + - id + - day + - serviceName + - serviceVersion + - dailyCount type: object properties: id: @@ -1949,10 +1949,10 @@ components: description: "Represents the test conformance metrics (current score, history\ \ and evolution trend) of a Service" required: - - id - - serviceId - - currentScore - - maxPossibleScore + - id + - serviceId + - currentScore + - maxPossibleScore type: object properties: id: @@ -1989,10 +1989,10 @@ components: description: 'Represents the summary result of a Service or API test run by Microcks. ' required: - - id - - testDate - - serviceId - - success + - id + - testDate + - serviceId + - success properties: id: description: Unique identifier of TestResult @@ -2014,15 +2014,15 @@ components: \ 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 + - id + - version + - testNumber + - testDate + - testedEndpoint + - serviceId + - success + - inProgress + - runnerType properties: id: description: Unique identifier of TestResult @@ -2075,19 +2075,19 @@ components: Binding: description: Protocol binding details for asynchronous operations required: - - type - - destinationName + - type + - destinationName type: object properties: type: description: Protocol binding identifier enum: - - KAFKA - - MQTT - - WS - - AMQP - - NATS - - GOOGLEPUBSUB + - KAFKA + - MQTT + - WS + - AMQP + - NATS + - GOOGLEPUBSUB type: string keyType: description: Type of key for Kafka messages @@ -2110,18 +2110,18 @@ components: ResourceType: description: Types of managed resources for Services or APIs enum: - - WSDL - - XSD - - JSON_SCHEMA - - OPEN_API_SPEC - - OPEN_API_SCHEMA - - ASYNC_API_SPEC - - ASYNC_API_SCHEMA - - AVRO_SCHEMA - - PROTOBUF_SCHEMA - - PROTOBUF_DESCRIPTION - - GRAPHQL_SCHEMA - - POSTMAN_COLLECTION + - WSDL + - XSD + - JSON_SCHEMA + - OPEN_API_SPEC + - OPEN_API_SCHEMA + - ASYNC_API_SPEC + - ASYNC_API_SCHEMA + - AVRO_SCHEMA + - PROTOBUF_SCHEMA + - PROTOBUF_DESCRIPTION + - GRAPHQL_SCHEMA + - POSTMAN_COLLECTION type: string CounterMap: description: A generic map of counter @@ -2132,9 +2132,9 @@ components: description: Represents a volatile OAuth2 client context usually associated with a Test request required: - - clientId - - clientSecret - - tokenUri + - clientId + - clientSecret + - tokenUri type: object properties: clientId: @@ -2161,16 +2161,16 @@ components: OAuth2GrantType: description: Enumeration for the different supported grants/flows of OAuth2 enum: - - PASSWORD - - CLIENT_CREDENTIALS - - REFRESH_TOKEN + - PASSWORD + - CLIENT_CREDENTIALS + - REFRESH_TOKEN type: string OAuth2AuthorizedClient: description: OAuth2 authorized client that performed a test required: - - grantType - - principalName - - tokenUri + - grantType + - principalName + - tokenUri type: object properties: grantType: @@ -2189,7 +2189,7 @@ components: ArtifactDownload: description: Artifact Download specification to be imported by Microcks. required: - - url + - url type: object properties: url: @@ -2207,8 +2207,8 @@ components: description: An ImportJob allow defining a repository artifact to poll for discovering Services and APIs mocks and tests required: - - name - - repositoryUrl + - name + - repositoryUrl properties: id: description: Unique identifier of ImportJob @@ -2265,8 +2265,8 @@ components: application/json: schema: oneOf: - - $ref: '#/components/schemas/Service' - - $ref: '#/components/schemas/ServiceView' + - $ref: '#/components/schemas/Service' + - $ref: '#/components/schemas/ServiceView' description: "" securitySchemes: jwt-bearer: @@ -2282,15 +2282,15 @@ components: description: JWT Bearer acquired using OAuth 2 Authentication flow or Direct Access Grant security: - - jwt-bearer: [] +- jwt-bearer: [] tags: - - name: mock - description: Operations related to API and Services mocks - - name: test - description: Operations related to API and Services tests - - name: job - description: Operations related to Jobs for discovering mocks and tests - - name: config - description: Operations related to configuration - - name: metrics - description: Operations related to metrics +- name: mock + description: Operations related to API and Services mocks +- name: test + description: Operations related to API and Services tests +- name: job + description: Operations related to Jobs for discovering mocks and tests +- name: config + description: Operations related to configuration +- name: metrics + description: Operations related to metrics