naftiko: 1.0.0-alpha2 info: label: Microcks API v1.14 description: API offered by Microcks, the Kubernetes native tool for API and microservices mocking and testing (microcks.io) tags: - Microcks - API created: '2026-05-06' modified: '2026-05-06' capability: consumes: - type: http namespace: microcks baseUri: http://microcks.example.com/api description: Microcks API v1.14 HTTP API. authentication: type: bearer token: '{{MICROCKS_TOKEN}}' resources: - name: services path: /services operations: - name: getservices method: GET description: Get Services and APIs inputParameters: - name: page in: query type: integer description: Page of Services to retrieve (starts at and defaults to 0) - name: size in: query type: integer description: Size of a page. Maximum number of Services to include in a response (defaults to 20) outputRawFormat: json outputParameters: - name: result type: object value: $. - name: tests path: /tests operations: - name: createtest method: POST description: Create a new Test outputRawFormat: json outputParameters: - name: result type: object value: $. - name: services-count path: /services/count operations: - name: getservicescounter method: GET description: Get the Services counter outputRawFormat: json outputParameters: - name: result type: object value: $. - name: jobs path: /jobs operations: - name: getimportjobs method: GET description: Get ImportJobs inputParameters: - name: page in: query type: integer description: Page of ImportJobs to retrieve (starts at and defaults to 0) - name: size in: query type: integer description: Size of a page. Maximum number of ImportJobs to include in a response (defaults to 20) - name: name in: query type: string description: Name like criterion for query outputRawFormat: json outputParameters: - name: result type: object value: $. - name: createimportjob method: POST description: Create ImportJob outputRawFormat: json outputParameters: - name: result type: object value: $. - name: jobs-id path: /jobs/{id} operations: - name: getimportjob method: GET description: Get ImportJob outputRawFormat: json outputParameters: - name: result type: object value: $. - name: updateimportjob method: POST description: Update ImportJob outputRawFormat: json outputParameters: - name: result type: object value: $. - name: deleteimportjob method: DELETE description: Delete ImportJob outputRawFormat: json outputParameters: - name: result type: object value: $. - name: services-id path: /services/{id} operations: - name: getservice method: GET description: Get Service inputParameters: - name: messages in: query type: boolean description: Whether to include details on services messages into result. Default is false outputRawFormat: json outputParameters: - name: result type: object value: $. - name: deleteservice method: DELETE description: Delete Service outputRawFormat: json outputParameters: - name: result type: object value: $. - name: jobs-count path: /jobs/count operations: - name: getimportjobcounter method: GET description: Get the ImportJobs counter outputRawFormat: json outputParameters: - name: result type: object value: $. - name: secrets path: /secrets operations: - name: getsecrets method: GET description: Get Secrets inputParameters: - name: page in: query type: integer description: Page of Secrets to retrieve (starts at and defaults to 0) - name: size in: query type: integer description: Size of a page. Maximum number of Secrets to include in a response (defaults to 20) outputRawFormat: json outputParameters: - name: result type: object value: $. - name: createsecret method: POST description: Create a new Secret outputRawFormat: json outputParameters: - name: result type: object value: $. - name: secrets-id path: /secrets/{id} operations: - name: getsecret method: GET description: Get Secret outputRawFormat: json outputParameters: - name: result type: object value: $. - name: updatesecret method: PUT description: Update Secret outputRawFormat: json outputParameters: - name: result type: object value: $. - name: deletesecret method: DELETE description: Delete Secret outputRawFormat: json outputParameters: - name: result type: object value: $. - name: secrets-count path: /secrets/count operations: - name: getsecretscounter method: GET description: Get the Secrets counter outputRawFormat: json outputParameters: - name: result type: object value: $. - name: tests-service-serviceid path: /tests/service/{serviceId} operations: - name: gettestresultsbyservice method: GET description: Get TestResults by Service outputRawFormat: json outputParameters: - name: result type: object value: $. - name: tests-service-serviceid-count path: /tests/service/{serviceId}/count operations: - name: gettestresultsbyservicecounter method: GET description: Get the TestResults for Service counter outputRawFormat: json outputParameters: - name: result type: object value: $. - name: tests-id path: /tests/{id} operations: - name: gettestresult method: GET description: Get TestResult outputRawFormat: json outputParameters: - name: result type: object value: $. - name: tests-id-messages-testcaseid path: /tests/{id}/messages/{testCaseId} operations: - name: getmessagesbytestcase method: GET description: Get messages for TestCase outputRawFormat: json outputParameters: - name: result type: object value: $. - name: tests-id-testcaseresult path: /tests/{id}/testCaseResult operations: - name: reporttestcaseresult method: POST description: Report and create a new TestCaseResult outputRawFormat: json outputParameters: - name: result type: object value: $. - name: keycloak-config path: /keycloak/config operations: - name: getkeycloakconfig method: GET description: Get authentification configuration outputRawFormat: json outputParameters: - name: result type: object value: $. - name: services-id-operation path: /services/{id}/operation operations: - name: overrideserviceoperation method: PUT description: Override Service Operation inputParameters: - name: operationName in: query type: string required: true description: Name of operation to update outputRawFormat: json outputParameters: - name: result type: object value: $. - name: services-id-metadata path: /services/{id}/metadata operations: - name: updateservicemetadata method: PUT description: Update Service Metadata outputRawFormat: json outputParameters: - name: result type: object value: $. - name: services-search path: /services/search operations: - name: searchservices method: GET description: Search for Services and APIs inputParameters: - name: queryMap in: query type: object required: true 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 outputRawFormat: json outputParameters: - name: result type: object value: $. - name: tests-id-events-testcaseid path: /tests/{id}/events/{testCaseId} operations: - name: geteventsbytestcase method: GET description: Get events for TestCase outputRawFormat: json outputParameters: - name: result type: object value: $. - name: resources-name path: /resources/{name} operations: - name: getresource method: GET description: Get Resource outputRawFormat: json outputParameters: - name: result type: object value: $. - name: resources-service-serviceid path: /resources/service/{serviceId} operations: - name: getresourcesbyservice method: GET description: Get Resources by Service outputRawFormat: json outputParameters: - name: result type: object value: $. - name: features-config path: /features/config operations: - name: getfeaturesconfig method: GET description: Get features configuration outputRawFormat: json outputParameters: - name: result type: object value: $. - name: import path: /import operations: - name: importsnapshot method: POST description: Import a snapshot outputRawFormat: json outputParameters: - name: result type: object value: $. - name: export path: /export operations: - name: exportsnapshot method: GET description: Export a snapshot inputParameters: - name: serviceIds in: query type: array required: true description: List of service identifiers to export outputRawFormat: json outputParameters: - name: result type: object value: $. - name: metrics-invocations-global path: /metrics/invocations/global operations: - name: getaggregatedinvocationsstats method: GET description: Get aggregated invocation statistics for a day inputParameters: - name: day in: query type: string description: The day to get statistics for (formatted with yyyyMMdd pattern). Default to today if not provided. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: metrics-conformance-aggregate path: /metrics/conformance/aggregate operations: - name: getconformancemetricsaggregation method: GET description: Get aggregation of conformance metrics outputRawFormat: json outputParameters: - name: result type: object value: $. - name: metrics-conformance-service-serviceid path: /metrics/conformance/service/{serviceId} operations: - name: getservicetestconformancemetric method: GET description: Get conformance metrics for a Service outputRawFormat: json outputParameters: - name: result type: object value: $. - name: metrics-invocations-top path: /metrics/invocations/top operations: - name: gettopivnocationsstatsbyday method: GET description: Get top invocation statistics for a day inputParameters: - name: day in: query type: string description: The day to get statistics for (formatted with yyyyMMdd pattern). Default to today if not provided. - name: limit in: query type: integer description: The number of top invoked mocks to return outputRawFormat: json outputParameters: - name: result type: object value: $. - name: metrics-invocations-servicename-serviceversion path: /metrics/invocations/{serviceName}/{serviceVersion} operations: - name: getinvocationstatsbyservice method: GET description: Get invocation statistics for Service inputParameters: - name: day in: query type: string description: The day to get statistics for (formatted with yyyyMMdd pattern). Default to today if not provided. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: metrics-invocations-global-latest path: /metrics/invocations/global/latest operations: - name: getlatestaggregatedinvocationsstats method: GET description: Get aggregated invocations statistics for latest days inputParameters: - name: limit in: query type: integer description: Number of days to get back in time. Default is 20. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: metrics-tests-latest path: /metrics/tests/latest operations: - name: getlatesttestresults method: GET description: Get latest tests results inputParameters: - name: limit in: query type: integer description: Number of days to consider for test results to return. Default is 7 (one week) outputRawFormat: json outputParameters: - name: result type: object value: $. - name: jobs-id-start path: /jobs/{id}/start operations: - name: startimportjob method: PUT description: Start an ImportJob outputRawFormat: json outputParameters: - name: result type: object value: $. - name: jobs-id-stop path: /jobs/{id}/stop operations: - name: stopimportjob method: PUT description: Stop an ImportJob outputRawFormat: json outputParameters: - name: result type: object value: $. - name: jobs-id-activate path: /jobs/{id}/activate operations: - name: activateimportjob method: PUT description: Activate an ImportJob outputRawFormat: json outputParameters: - name: result type: object value: $. - name: services-labels path: /services/labels operations: - name: getserviceslabels method: GET description: Get the already used labels for Services outputRawFormat: json outputParameters: - name: result type: object value: $. - name: artifact-download path: /artifact/download operations: - name: downloadartifact method: POST description: Download an artifact outputRawFormat: json outputParameters: - name: result type: object value: $. - name: secrets-search path: /secrets/search operations: - name: searchsecrets method: GET description: Search for Secrets inputParameters: - name: name in: query type: string required: true description: Search using this name-like criterion outputRawFormat: json outputParameters: - name: result type: object value: $. - name: artifact-upload path: /artifact/upload operations: - name: uploadartifact method: POST description: Upload an artifact inputParameters: - name: mainArtifact in: query type: boolean required: true description: Flag telling if this should be considered as primary or secondary artifact. Default to 'true' outputRawFormat: json outputParameters: - name: result type: object value: $. exposes: - type: rest port: 8080 namespace: microcks-rest description: REST adapter for Microcks API v1.14. resources: - path: /services name: getservices operations: - method: GET name: getservices description: Get Services and APIs call: microcks.getservices outputParameters: - type: object mapping: $. - path: /tests name: createtest operations: - method: POST name: createtest description: Create a new Test call: microcks.createtest outputParameters: - type: object mapping: $. - path: /services/count name: getservicescounter operations: - method: GET name: getservicescounter description: Get the Services counter call: microcks.getservicescounter outputParameters: - type: object mapping: $. - path: /jobs name: getimportjobs operations: - method: GET name: getimportjobs description: Get ImportJobs call: microcks.getimportjobs outputParameters: - type: object mapping: $. - path: /jobs name: createimportjob operations: - method: POST name: createimportjob description: Create ImportJob call: microcks.createimportjob outputParameters: - type: object mapping: $. - path: /jobs/{id} name: getimportjob operations: - method: GET name: getimportjob description: Get ImportJob call: microcks.getimportjob outputParameters: - type: object mapping: $. - path: /jobs/{id} name: updateimportjob operations: - method: POST name: updateimportjob description: Update ImportJob call: microcks.updateimportjob outputParameters: - type: object mapping: $. - path: /jobs/{id} name: deleteimportjob operations: - method: DELETE name: deleteimportjob description: Delete ImportJob call: microcks.deleteimportjob outputParameters: - type: object mapping: $. - path: /services/{id} name: getservice operations: - method: GET name: getservice description: Get Service call: microcks.getservice outputParameters: - type: object mapping: $. - path: /services/{id} name: deleteservice operations: - method: DELETE name: deleteservice description: Delete Service call: microcks.deleteservice outputParameters: - type: object mapping: $. - path: /jobs/count name: getimportjobcounter operations: - method: GET name: getimportjobcounter description: Get the ImportJobs counter call: microcks.getimportjobcounter outputParameters: - type: object mapping: $. - path: /secrets name: getsecrets operations: - method: GET name: getsecrets description: Get Secrets call: microcks.getsecrets outputParameters: - type: object mapping: $. - path: /secrets name: createsecret operations: - method: POST name: createsecret description: Create a new Secret call: microcks.createsecret outputParameters: - type: object mapping: $. - path: /secrets/{id} name: getsecret operations: - method: GET name: getsecret description: Get Secret call: microcks.getsecret outputParameters: - type: object mapping: $. - path: /secrets/{id} name: updatesecret operations: - method: PUT name: updatesecret description: Update Secret call: microcks.updatesecret outputParameters: - type: object mapping: $. - path: /secrets/{id} name: deletesecret operations: - method: DELETE name: deletesecret description: Delete Secret call: microcks.deletesecret outputParameters: - type: object mapping: $. - path: /secrets/count name: getsecretscounter operations: - method: GET name: getsecretscounter description: Get the Secrets counter call: microcks.getsecretscounter outputParameters: - type: object mapping: $. - path: /tests/service/{serviceId} name: gettestresultsbyservice operations: - method: GET name: gettestresultsbyservice description: Get TestResults by Service call: microcks.gettestresultsbyservice outputParameters: - type: object mapping: $. - path: /tests/service/{serviceId}/count name: gettestresultsbyservicecounter operations: - method: GET name: gettestresultsbyservicecounter description: Get the TestResults for Service counter call: microcks.gettestresultsbyservicecounter outputParameters: - type: object mapping: $. - path: /tests/{id} name: gettestresult operations: - method: GET name: gettestresult description: Get TestResult call: microcks.gettestresult outputParameters: - type: object mapping: $. - path: /tests/{id}/messages/{testCaseId} name: getmessagesbytestcase operations: - method: GET name: getmessagesbytestcase description: Get messages for TestCase call: microcks.getmessagesbytestcase outputParameters: - type: object mapping: $. - path: /tests/{id}/testCaseResult name: reporttestcaseresult operations: - method: POST name: reporttestcaseresult description: Report and create a new TestCaseResult call: microcks.reporttestcaseresult outputParameters: - type: object mapping: $. - path: /keycloak/config name: getkeycloakconfig operations: - method: GET name: getkeycloakconfig description: Get authentification configuration call: microcks.getkeycloakconfig outputParameters: - type: object mapping: $. - path: /services/{id}/operation name: overrideserviceoperation operations: - method: PUT name: overrideserviceoperation description: Override Service Operation call: microcks.overrideserviceoperation outputParameters: - type: object mapping: $. - path: /services/{id}/metadata name: updateservicemetadata operations: - method: PUT name: updateservicemetadata description: Update Service Metadata call: microcks.updateservicemetadata outputParameters: - type: object mapping: $. - path: /services/search name: searchservices operations: - method: GET name: searchservices description: Search for Services and APIs call: microcks.searchservices outputParameters: - type: object mapping: $. - path: /tests/{id}/events/{testCaseId} name: geteventsbytestcase operations: - method: GET name: geteventsbytestcase description: Get events for TestCase call: microcks.geteventsbytestcase outputParameters: - type: object mapping: $. - path: /resources/{name} name: getresource operations: - method: GET name: getresource description: Get Resource call: microcks.getresource outputParameters: - type: object mapping: $. - path: /resources/service/{serviceId} name: getresourcesbyservice operations: - method: GET name: getresourcesbyservice description: Get Resources by Service call: microcks.getresourcesbyservice outputParameters: - type: object mapping: $. - path: /features/config name: getfeaturesconfig operations: - method: GET name: getfeaturesconfig description: Get features configuration call: microcks.getfeaturesconfig outputParameters: - type: object mapping: $. - path: /import name: importsnapshot operations: - method: POST name: importsnapshot description: Import a snapshot call: microcks.importsnapshot outputParameters: - type: object mapping: $. - path: /export name: exportsnapshot operations: - method: GET name: exportsnapshot description: Export a snapshot call: microcks.exportsnapshot outputParameters: - type: object mapping: $. - path: /metrics/invocations/global name: getaggregatedinvocationsstats operations: - method: GET name: getaggregatedinvocationsstats description: Get aggregated invocation statistics for a day call: microcks.getaggregatedinvocationsstats outputParameters: - type: object mapping: $. - path: /metrics/conformance/aggregate name: getconformancemetricsaggregation operations: - method: GET name: getconformancemetricsaggregation description: Get aggregation of conformance metrics call: microcks.getconformancemetricsaggregation outputParameters: - type: object mapping: $. - path: /metrics/conformance/service/{serviceId} name: getservicetestconformancemetric operations: - method: GET name: getservicetestconformancemetric description: Get conformance metrics for a Service call: microcks.getservicetestconformancemetric outputParameters: - type: object mapping: $. - path: /metrics/invocations/top name: gettopivnocationsstatsbyday operations: - method: GET name: gettopivnocationsstatsbyday description: Get top invocation statistics for a day call: microcks.gettopivnocationsstatsbyday outputParameters: - type: object mapping: $. - path: /metrics/invocations/{serviceName}/{serviceVersion} name: getinvocationstatsbyservice operations: - method: GET name: getinvocationstatsbyservice description: Get invocation statistics for Service call: microcks.getinvocationstatsbyservice outputParameters: - type: object mapping: $. - path: /metrics/invocations/global/latest name: getlatestaggregatedinvocationsstats operations: - method: GET name: getlatestaggregatedinvocationsstats description: Get aggregated invocations statistics for latest days call: microcks.getlatestaggregatedinvocationsstats outputParameters: - type: object mapping: $. - path: /metrics/tests/latest name: getlatesttestresults operations: - method: GET name: getlatesttestresults description: Get latest tests results call: microcks.getlatesttestresults outputParameters: - type: object mapping: $. - path: /jobs/{id}/start name: startimportjob operations: - method: PUT name: startimportjob description: Start an ImportJob call: microcks.startimportjob outputParameters: - type: object mapping: $. - path: /jobs/{id}/stop name: stopimportjob operations: - method: PUT name: stopimportjob description: Stop an ImportJob call: microcks.stopimportjob outputParameters: - type: object mapping: $. - path: /jobs/{id}/activate name: activateimportjob operations: - method: PUT name: activateimportjob description: Activate an ImportJob call: microcks.activateimportjob outputParameters: - type: object mapping: $. - path: /services/labels name: getserviceslabels operations: - method: GET name: getserviceslabels description: Get the already used labels for Services call: microcks.getserviceslabels outputParameters: - type: object mapping: $. - path: /artifact/download name: downloadartifact operations: - method: POST name: downloadartifact description: Download an artifact call: microcks.downloadartifact outputParameters: - type: object mapping: $. - path: /secrets/search name: searchsecrets operations: - method: GET name: searchsecrets description: Search for Secrets call: microcks.searchsecrets outputParameters: - type: object mapping: $. - path: /artifact/upload name: uploadartifact operations: - method: POST name: uploadartifact description: Upload an artifact call: microcks.uploadartifact outputParameters: - type: object mapping: $. - type: mcp port: 9090 namespace: microcks-mcp transport: http description: MCP adapter for Microcks API v1.14 for AI agent use. tools: - name: getservices description: Get Services and APIs hints: readOnly: true destructive: false idempotent: true call: microcks.getservices with: page: tools.page size: tools.size inputParameters: - name: page type: integer description: Page of Services to retrieve (starts at and defaults to 0) - name: size type: integer description: Size of a page. Maximum number of Services to include in a response (defaults to 20) outputParameters: - type: object mapping: $. - name: createtest description: Create a new Test hints: readOnly: false destructive: false idempotent: false call: microcks.createtest outputParameters: - type: object mapping: $. - name: getservicescounter description: Get the Services counter hints: readOnly: true destructive: false idempotent: true call: microcks.getservicescounter outputParameters: - type: object mapping: $. - name: getimportjobs description: Get ImportJobs hints: readOnly: true destructive: false idempotent: true call: microcks.getimportjobs with: page: tools.page size: tools.size name: tools.name inputParameters: - name: page type: integer description: Page of ImportJobs to retrieve (starts at and defaults to 0) - name: size type: integer description: Size of a page. Maximum number of ImportJobs to include in a response (defaults to 20) - name: name type: string description: Name like criterion for query outputParameters: - type: object mapping: $. - name: createimportjob description: Create ImportJob hints: readOnly: false destructive: false idempotent: false call: microcks.createimportjob outputParameters: - type: object mapping: $. - name: getimportjob description: Get ImportJob hints: readOnly: true destructive: false idempotent: true call: microcks.getimportjob outputParameters: - type: object mapping: $. - name: updateimportjob description: Update ImportJob hints: readOnly: false destructive: false idempotent: false call: microcks.updateimportjob outputParameters: - type: object mapping: $. - name: deleteimportjob description: Delete ImportJob hints: readOnly: false destructive: true idempotent: true call: microcks.deleteimportjob outputParameters: - type: object mapping: $. - name: getservice description: Get Service hints: readOnly: true destructive: false idempotent: true call: microcks.getservice with: messages: tools.messages inputParameters: - name: messages type: boolean description: Whether to include details on services messages into result. Default is false outputParameters: - type: object mapping: $. - name: deleteservice description: Delete Service hints: readOnly: false destructive: true idempotent: true call: microcks.deleteservice outputParameters: - type: object mapping: $. - name: getimportjobcounter description: Get the ImportJobs counter hints: readOnly: true destructive: false idempotent: true call: microcks.getimportjobcounter outputParameters: - type: object mapping: $. - name: getsecrets description: Get Secrets hints: readOnly: true destructive: false idempotent: true call: microcks.getsecrets with: page: tools.page size: tools.size inputParameters: - name: page type: integer description: Page of Secrets to retrieve (starts at and defaults to 0) - name: size type: integer description: Size of a page. Maximum number of Secrets to include in a response (defaults to 20) outputParameters: - type: object mapping: $. - name: createsecret description: Create a new Secret hints: readOnly: false destructive: false idempotent: false call: microcks.createsecret outputParameters: - type: object mapping: $. - name: getsecret description: Get Secret hints: readOnly: true destructive: false idempotent: true call: microcks.getsecret outputParameters: - type: object mapping: $. - name: updatesecret description: Update Secret hints: readOnly: false destructive: false idempotent: true call: microcks.updatesecret outputParameters: - type: object mapping: $. - name: deletesecret description: Delete Secret hints: readOnly: false destructive: true idempotent: true call: microcks.deletesecret outputParameters: - type: object mapping: $. - name: getsecretscounter description: Get the Secrets counter hints: readOnly: true destructive: false idempotent: true call: microcks.getsecretscounter outputParameters: - type: object mapping: $. - name: gettestresultsbyservice description: Get TestResults by Service hints: readOnly: true destructive: false idempotent: true call: microcks.gettestresultsbyservice outputParameters: - type: object mapping: $. - name: gettestresultsbyservicecounter description: Get the TestResults for Service counter hints: readOnly: true destructive: false idempotent: true call: microcks.gettestresultsbyservicecounter outputParameters: - type: object mapping: $. - name: gettestresult description: Get TestResult hints: readOnly: true destructive: false idempotent: true call: microcks.gettestresult outputParameters: - type: object mapping: $. - name: getmessagesbytestcase description: Get messages for TestCase hints: readOnly: true destructive: false idempotent: true call: microcks.getmessagesbytestcase outputParameters: - type: object mapping: $. - name: reporttestcaseresult description: Report and create a new TestCaseResult hints: readOnly: false destructive: false idempotent: false call: microcks.reporttestcaseresult outputParameters: - type: object mapping: $. - name: getkeycloakconfig description: Get authentification configuration hints: readOnly: true destructive: false idempotent: true call: microcks.getkeycloakconfig outputParameters: - type: object mapping: $. - name: overrideserviceoperation description: Override Service Operation hints: readOnly: false destructive: false idempotent: true call: microcks.overrideserviceoperation with: operationName: tools.operationName inputParameters: - name: operationName type: string description: Name of operation to update required: true outputParameters: - type: object mapping: $. - name: updateservicemetadata description: Update Service Metadata hints: readOnly: false destructive: false idempotent: true call: microcks.updateservicemetadata outputParameters: - type: object mapping: $. - name: searchservices description: Search for Services and APIs hints: readOnly: true destructive: false idempotent: true call: microcks.searchservices with: queryMap: tools.queryMap inputParameters: - name: queryMap type: object 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 required: true outputParameters: - type: object mapping: $. - name: geteventsbytestcase description: Get events for TestCase hints: readOnly: true destructive: false idempotent: true call: microcks.geteventsbytestcase outputParameters: - type: object mapping: $. - name: getresource description: Get Resource hints: readOnly: true destructive: false idempotent: true call: microcks.getresource outputParameters: - type: object mapping: $. - name: getresourcesbyservice description: Get Resources by Service hints: readOnly: true destructive: false idempotent: true call: microcks.getresourcesbyservice outputParameters: - type: object mapping: $. - name: getfeaturesconfig description: Get features configuration hints: readOnly: true destructive: false idempotent: true call: microcks.getfeaturesconfig outputParameters: - type: object mapping: $. - name: importsnapshot description: Import a snapshot hints: readOnly: false destructive: false idempotent: false call: microcks.importsnapshot outputParameters: - type: object mapping: $. - name: exportsnapshot description: Export a snapshot hints: readOnly: true destructive: false idempotent: true call: microcks.exportsnapshot with: serviceIds: tools.serviceIds inputParameters: - name: serviceIds type: array description: List of service identifiers to export required: true outputParameters: - type: object mapping: $. - name: getaggregatedinvocationsstats description: Get aggregated invocation statistics for a day hints: readOnly: true destructive: false idempotent: true call: microcks.getaggregatedinvocationsstats with: day: tools.day inputParameters: - name: day type: string description: The day to get statistics for (formatted with yyyyMMdd pattern). Default to today if not provided. outputParameters: - type: object mapping: $. - name: getconformancemetricsaggregation description: Get aggregation of conformance metrics hints: readOnly: true destructive: false idempotent: true call: microcks.getconformancemetricsaggregation outputParameters: - type: object mapping: $. - name: getservicetestconformancemetric description: Get conformance metrics for a Service hints: readOnly: true destructive: false idempotent: true call: microcks.getservicetestconformancemetric outputParameters: - type: object mapping: $. - name: gettopivnocationsstatsbyday description: Get top invocation statistics for a day hints: readOnly: true destructive: false idempotent: true call: microcks.gettopivnocationsstatsbyday with: day: tools.day limit: tools.limit inputParameters: - name: day type: string description: The day to get statistics for (formatted with yyyyMMdd pattern). Default to today if not provided. - name: limit type: integer description: The number of top invoked mocks to return outputParameters: - type: object mapping: $. - name: getinvocationstatsbyservice description: Get invocation statistics for Service hints: readOnly: true destructive: false idempotent: true call: microcks.getinvocationstatsbyservice with: day: tools.day inputParameters: - name: day type: string description: The day to get statistics for (formatted with yyyyMMdd pattern). Default to today if not provided. outputParameters: - type: object mapping: $. - name: getlatestaggregatedinvocationsstats description: Get aggregated invocations statistics for latest days hints: readOnly: true destructive: false idempotent: true call: microcks.getlatestaggregatedinvocationsstats with: limit: tools.limit inputParameters: - name: limit type: integer description: Number of days to get back in time. Default is 20. outputParameters: - type: object mapping: $. - name: getlatesttestresults description: Get latest tests results hints: readOnly: true destructive: false idempotent: true call: microcks.getlatesttestresults with: limit: tools.limit inputParameters: - name: limit type: integer description: Number of days to consider for test results to return. Default is 7 (one week) outputParameters: - type: object mapping: $. - name: startimportjob description: Start an ImportJob hints: readOnly: false destructive: false idempotent: true call: microcks.startimportjob outputParameters: - type: object mapping: $. - name: stopimportjob description: Stop an ImportJob hints: readOnly: false destructive: false idempotent: true call: microcks.stopimportjob outputParameters: - type: object mapping: $. - name: activateimportjob description: Activate an ImportJob hints: readOnly: false destructive: false idempotent: true call: microcks.activateimportjob outputParameters: - type: object mapping: $. - name: getserviceslabels description: Get the already used labels for Services hints: readOnly: true destructive: false idempotent: true call: microcks.getserviceslabels outputParameters: - type: object mapping: $. - name: downloadartifact description: Download an artifact hints: readOnly: false destructive: false idempotent: false call: microcks.downloadartifact outputParameters: - type: object mapping: $. - name: searchsecrets description: Search for Secrets hints: readOnly: true destructive: false idempotent: true call: microcks.searchsecrets with: name: tools.name inputParameters: - name: name type: string description: Search using this name-like criterion required: true outputParameters: - type: object mapping: $. - name: uploadartifact description: Upload an artifact hints: readOnly: false destructive: false idempotent: false call: microcks.uploadartifact with: mainArtifact: tools.mainArtifact inputParameters: - name: mainArtifact type: boolean description: Flag telling if this should be considered as primary or secondary artifact. Default to 'true' required: true outputParameters: - type: object mapping: $. binds: - namespace: env keys: MICROCKS_TOKEN: MICROCKS_TOKEN