Update service docs

CHANGELOG.md

@@ -1,6 +1,7 @@
 ## 0.4.0
 
 * Allow dynamic "Encryption Key" value.
+* Update service docs.
 
 ## 0.3.0
 

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;
 

lib/generated/autogram.swagger.dart

@@ -271,7 +271,7 @@ abstract class Autogram extends ChopperService {
   Future<chopper.Response> _deviceIntegrationsPost(
       {@Body() required PostDeviceIntegrationsRequestBody? body});
 
-  ///Integration retrieves a list of paired devices
+  ///Device retrieves a list of paired integrations
   Future<chopper.Response<GetDeviceIntegrationsResponseBody>>
       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<chopper.Response<GetDeviceIntegrationsResponseBody>>
       _deviceIntegrationsGet();
 
-  ///Integration deletes device from its subscribers
+  ///Device deletes integration from its paired integrations
   ///@param integration_id Identifier of the integration
   Future<chopper.Response> 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<chopper.Response> _deviceIntegrationsIntegrationIdDelete(
       {@Path('integration_id') required String? integrationId});
 
-  ///Integration retrieves a list of connected devices
+  ///Integration retrieves a list of paired devices
   Future<chopper.Response<GetIntegrationDevicesResponseBody>>
       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<chopper.Response<GetIntegrationDevicesResponseBody>>
       _integrationDevicesGet();
 
-  ///Integration deletes device from its subscribers
+  ///Integration deletes device from its paired devices
   ///@param device_id Identifier of the device
   Future<chopper.Response> 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<chopper.Response> _integrationDevicesDeviceIdDelete(

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: <https://generator3.swagger.io/index.html?url=https://autogram.slovensko.digital/openapi.yaml#/Minimal%20Integration/post_devices>
   Future<PostDeviceResponse> registerDevice(PostDeviceRequestBody body);
 
-  /// Device returns list of paired integrations.
+  /// Retrieves a list of paired integrations.
   ///
   /// See: <https://generator3.swagger.io/index.html?url=https://autogram.slovensko.digital/openapi.yaml#/Integration/get_device_integrations>
   Future<GetDeviceIntegrationsResponseBody> listIntegrations();
 
-  /// Device returns list of paired integrations.
+  /// Deletes integration from its paired integrations.
   ///
   /// See: <https://generator3.swagger.io/index.html?url=https://autogram.slovensko.digital/openapi.yaml#/Integration/delete_device_integrations__integration_id_>
   Future<void> deleteIntegration(String integrationId);

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.