From 810fec807de7c70f62ddbf14192185cd260ae531 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Matej=20Hlatk=C3=BD?= Date: Sat, 27 Apr 2024 09:10:00 +0200 Subject: [PATCH] Update service docs --- CHANGELOG.md | 1 + lib/generated/autogram.enums.swagger.dart | 4 +++- lib/generated/autogram.swagger.dart | 16 ++++++++-------- lib/src/iautogram_service.dart | 6 +++--- lib/swagger/autogram.yaml | 9 +++++---- 5 files changed, 20 insertions(+), 16 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 002f157..27bd20e 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,6 +1,7 @@ ## 0.4.0 * Allow dynamic "Encryption Key" value. +* Update service docs. ## 0.3.0 diff --git a/lib/generated/autogram.enums.swagger.dart b/lib/generated/autogram.enums.swagger.dart index 2828d3f..1516c33 100644 --- a/lib/generated/autogram.enums.swagger.dart +++ b/lib/generated/autogram.enums.swagger.dart @@ -419,7 +419,9 @@ enum ErrorResponseBodyCode { @JsonValue('DATATOSIGN_MISMATCH') datatosignMismatch('DATATOSIGN_MISMATCH'), @JsonValue('CERTIFICATE_NOT_VALID') - certificateNotValid('CERTIFICATE_NOT_VALID'); + certificateNotValid('CERTIFICATE_NOT_VALID'), + @JsonValue('FAILED_PARSING_MIMETYPE') + failedParsingMimetype('FAILED_PARSING_MIMETYPE'); final String? value; diff --git a/lib/generated/autogram.swagger.dart b/lib/generated/autogram.swagger.dart index cea4f36..44597da 100644 --- a/lib/generated/autogram.swagger.dart +++ b/lib/generated/autogram.swagger.dart @@ -271,7 +271,7 @@ abstract class Autogram extends ChopperService { Future _deviceIntegrationsPost( {@Body() required PostDeviceIntegrationsRequestBody? body}); - ///Integration retrieves a list of paired devices + ///Device retrieves a list of paired integrations Future> deviceIntegrationsGet() { generatedMapping.putIfAbsent(GetDeviceIntegrationsResponseBody$Item, @@ -280,25 +280,25 @@ abstract class Autogram extends ChopperService { return _deviceIntegrationsGet(); } - ///Integration retrieves a list of paired devices + ///Device retrieves a list of paired integrations @Get(path: '/device-integrations') Future> _deviceIntegrationsGet(); - ///Integration deletes device from its subscribers + ///Device deletes integration from its paired integrations ///@param integration_id Identifier of the integration Future deviceIntegrationsIntegrationIdDelete( {required String? integrationId}) { return _deviceIntegrationsIntegrationIdDelete(integrationId: integrationId); } - ///Integration deletes device from its subscribers + ///Device deletes integration from its paired integrations ///@param integration_id Identifier of the integration @Delete(path: '/device-integrations/{integration_id}') Future _deviceIntegrationsIntegrationIdDelete( {@Path('integration_id') required String? integrationId}); - ///Integration retrieves a list of connected devices + ///Integration retrieves a list of paired devices Future> integrationDevicesGet() { generatedMapping.putIfAbsent(GetIntegrationDevicesResponseBody$Item, @@ -307,19 +307,19 @@ abstract class Autogram extends ChopperService { return _integrationDevicesGet(); } - ///Integration retrieves a list of connected devices + ///Integration retrieves a list of paired devices @Get(path: '/integration-devices') Future> _integrationDevicesGet(); - ///Integration deletes device from its subscribers + ///Integration deletes device from its paired devices ///@param device_id Identifier of the device Future integrationDevicesDeviceIdDelete( {required String? deviceId}) { return _integrationDevicesDeviceIdDelete(deviceId: deviceId); } - ///Integration deletes device from its subscribers + ///Integration deletes device from its paired devices ///@param device_id Identifier of the device @Delete(path: '/integration-devices/{device_id}') Future _integrationDevicesDeviceIdDelete( diff --git a/lib/src/iautogram_service.dart b/lib/src/iautogram_service.dart index 36cb998..79d8e49 100644 --- a/lib/src/iautogram_service.dart +++ b/lib/src/iautogram_service.dart @@ -55,17 +55,17 @@ abstract class IAutogramService { DateTime? ifModifiedSince, ]); - /// Device registers itself at the server. + /// Registers itself at the server. /// /// See: Future registerDevice(PostDeviceRequestBody body); - /// Device returns list of paired integrations. + /// Retrieves a list of paired integrations. /// /// See: Future listIntegrations(); - /// Device returns list of paired integrations. + /// Deletes integration from its paired integrations. /// /// See: Future deleteIntegration(String integrationId); diff --git a/lib/swagger/autogram.yaml b/lib/swagger/autogram.yaml index 201c073..9c6f65f 100644 --- a/lib/swagger/autogram.yaml +++ b/lib/swagger/autogram.yaml @@ -611,7 +611,7 @@ paths: - Integration security: - Device JWT: [] - summary: Integration retrieves a list of paired devices + summary: Device retrieves a list of paired integrations responses: 200: description: OK @@ -626,7 +626,7 @@ paths: - Integration security: - Device JWT: [] - summary: Integration deletes device from its subscribers + summary: Device deletes integration from its paired integrations parameters: - name: integration_id in: path @@ -648,7 +648,7 @@ paths: - Integration security: - Integration JWT: [] - summary: Integration retrieves a list of connected devices + summary: Integration retrieves a list of paired devices responses: 200: description: OK @@ -663,7 +663,7 @@ paths: - Integration security: - Integration JWT: [] - summary: Integration deletes device from its subscribers + summary: Integration deletes device from its paired devices parameters: - name: device_id in: path @@ -1533,6 +1533,7 @@ components: - EMPTY_BODY - DATATOSIGN_MISMATCH - CERTIFICATE_NOT_VALID + - FAILED_PARSING_MIMETYPE description: | Code that can be used to identify the error.