.. AUTO-GENERATED FILE. DO NOT EDIT.

Get application update feed file
================================

Summary
-------

- **Source repository:** ``jef-systems/jef-desktop-store-backend``
- **Source SHA:** ``d1284a9edc0941be3dbeb4c724fff6eb9bda6288``
- **Source run id:** ``28543308430``
- **Module:** ``Desktop-store``
- **Lambda function:** ``jef-desktop-store-get-application-update-feed-file``
- **HTTP method:** ``GET``
- **Invocation mode:** ``sync``
- **Package mode:** ``no-package``
- **API category:** ``Desktop-store Complex No Package Sync GET APIs``
- **API path:** ``/jef-desktop-store-updates/{application\_name}/{file\_name}``
- **Endpoint URL:** ``https://u91anelyve.execute-api.ap-southeast-1.amazonaws.com/prod/jef-desktop-store-updates/{application\_name}/{file\_name}?application\_name=jef-accounting&file\_name=latest.yml``
- **Documentation scope:** ``lambda-complex-no-packages``

Sync Read Rule
--------------

This GET API is documented as a direct synchronous read path.

Description
-----------

Complex no-packages Lambda that serves electron-updater compatible latest.yml and redirects installer or blockmap requests to private S3 presigned URLs.

Payload Example
---------------

.. code-block:: json

   {
     "application_name": "jef-accounting",
     "file_name": "latest.yml"
   }

Payload Schema
--------------

.. code-block:: json

   {
     "root": {
       "type": "M",
       "required": true,
       "attributes": {
         "application_name": {
           "type": "S",
           "required": true,
           "regex": "^jef-[a-z0-9]+(-[a-z0-9]+)*$"
         },
         "file_name": {
           "type": "S",
           "required": true,
           "regex": "^(latest[.]yml|update-manifest[.]json|[A-Za-z0-9 ._-]{1,180}[.]exe|[A-Za-z0-9 ._-]{1,180}[.]exe[.]blockmap)$"
         }
       }
     }
   }

Response Schema
---------------

.. code-block:: json

   {
     "root": {
       "type": "M",
       "required": true,
       "attributes": {
         "is_accepted": {
           "type": "BOOL",
           "required": false
         },
         "is_valid": {
           "type": "BOOL",
           "required": false
         },
         "can_continue": {
           "type": "BOOL",
           "required": false
         },
         "application_found": {
           "type": "BOOL",
           "required": false
         },
         "file_found": {
           "type": "BOOL",
           "required": false
         },
         "message_type": {
           "type": "S",
           "required": false
         },
         "message": {
           "type": "S",
           "required": false
         },
         "next_action": {
           "type": "S",
           "required": false
         },
         "operation": {
           "type": "S",
           "required": false
         },
         "status_code": {
           "type": "N",
           "required": true
         },
         "application_name": {
           "type": "S",
           "required": false
         },
         "version": {
           "type": "S",
           "required": false
         },
         "file_name": {
           "type": "S",
           "required": false
         },
         "file_kind": {
           "type": "S",
           "required": false
         },
         "s3_bucket": {
           "type": "S",
           "required": false
         },
         "s3_key": {
           "type": "S",
           "required": false
         },
         "s3_uri": {
           "type": "S",
           "required": false
         },
         "size_bytes": {
           "type": "N",
           "required": false
         },
         "last_modified": {
           "type": "S",
           "required": false
         },
         "etag": {
           "type": "S",
           "required": false
         },
         "source": {
           "type": "S",
           "required": false
         },
         "expires_in": {
           "type": "N",
           "required": false
         },
         "redirect_url": {
           "type": "S",
           "required": false
         },
         "failure_code": {
           "type": "S",
           "required": false
         },
         "failure_reason": {
           "type": "S",
           "required": false
         }
       }
     }
   }

CMD curl
--------

.. code-block:: bat

   curl -X GET "https://u91anelyve.execute-api.ap-southeast-1.amazonaws.com/prod/jef-desktop-store-updates/{application_name}/{file_name}?application_name=jef-accounting&file_name=latest.yml"

PowerShell curl
---------------

.. code-block:: powershell

   curl.exe -X GET "https://u91anelyve.execute-api.ap-southeast-1.amazonaws.com/prod/jef-desktop-store-updates/{application_name}/{file_name}?application_name=jef-accounting&file_name=latest.yml"