.. AUTO-GENERATED FILE. DO NOT EDIT. /desktop-store-applications-patch-one ===================================== Summary ------- - **Source repository:** ``jef-systems/jef-desktop-store-backend`` - **Source SHA:** ``bda92d5a75228490cc0e642f6d9127e2733d829e`` - **Source run id:** ``28367053347`` - **Lambda function:** ``jef-desktop-store-patch-001`` - **HTTP method:** ``PATCH`` - **API path:** ``/desktop-store-applications-patch-one`` - **Endpoint URL:** ``https://u91anelyve.execute-api.ap-southeast-1.amazonaws.com/prod/desktop-store-applications-patch-one`` - **Payload mode:** ``json-body`` Description ----------- .. list-table:: :widths: 30 70 * - ``Function`` - jef-desktop-store-patch-001 Logical ID: jef-desktop-store:jef-desktop-store-applications:patch-one Order Number: 002 * - ``Module`` - jef-desktop-store * - ``Action`` - patch-one * - ``Method`` - PATCH * - ``Invocation Mode`` - SYNCHRONOUS * - ``Resource Path`` - /desktop-store-applications-patch-one Endpoint Name: jef-desktop-store-applications-patch-one * - ``Table`` - jef-desktop-store-applications * - ``Primary Key`` - application\_id API Gateway Response -------------------- .. list-table:: :widths: 30 70 * - ``status\_code`` - Lambda proxy statusCode * - ``message`` - Lambda response reflects commit success or failure. Payload Example --------------- .. list-table:: :widths: 30 70 * - ``application\_id`` - 09448f08-7749-4088-beb8-f2994ef59cda * - ``application\_name`` - Sample Name Payload Schema -------------- .. code-block:: json { "type": "object", "additionalProperties": "False", "payload_mode": "flat", "allow_children_wrapper": "False", "children_wrapper_field": "", "allow_batch": "False", "table": "jef-desktop-store-applications", "primary_key": "application_id", "required[0]": "application_id", "properties.application_id.field": "application_id", "properties.application_id.type": "S", "properties.application_id.required": "False", "properties.application_id.source_required": "True", "properties.application_id.server_generated": "True", "properties.application_id.autogenerated": "False", "properties.application_id.frontend_autocomputed": "False", "properties.application_id.format": "uuidv4", "properties.application_id.regex": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", "properties.application_name.field": "application_name", "properties.application_name.type": "S", "properties.application_name.required": "True", "properties.application_name.source_required": "True", "properties.application_name.server_generated": "False", "properties.application_name.autogenerated": "False", "properties.application_name.frontend_autocomputed": "False", "properties.application_name.regex": "^[A-Za-z0-9 ._-]{1,120}$", "properties.display_name.field": "display_name", "properties.display_name.type": "S", "properties.display_name.required": "True", "properties.display_name.source_required": "True", "properties.display_name.server_generated": "False", "properties.display_name.autogenerated": "False", "properties.display_name.frontend_autocomputed": "False", "properties.display_name.regex": "^[A-Za-z0-9 ._-]{1,120}$", "properties.version.field": "version", "properties.version.type": "S", "properties.version.required": "True", "properties.version.source_required": "True", "properties.version.server_generated": "False", "properties.version.autogenerated": "False", "properties.version.frontend_autocomputed": "False", "properties.version.regex": "^[0-9]+[.][0-9]+[.][0-9]+$", "properties.platform.field": "platform", "properties.platform.type": "S", "properties.platform.required": "True", "properties.platform.source_required": "True", "properties.platform.server_generated": "False", "properties.platform.autogenerated": "False", "properties.platform.frontend_autocomputed": "False", "properties.platform.regex": "^(windows)$", "properties.installer_type.field": "installer_type", "properties.installer_type.type": "S", "properties.installer_type.required": "True", "properties.installer_type.source_required": "True", "properties.installer_type.server_generated": "False", "properties.installer_type.autogenerated": "False", "properties.installer_type.frontend_autocomputed": "False", "properties.installer_type.regex": "^(exe|msi|zip)$", "properties.s3_key.field": "s3_key", "properties.s3_key.type": "S", "properties.s3_key.required": "True", "properties.s3_key.source_required": "True", "properties.s3_key.server_generated": "False", "properties.s3_key.autogenerated": "False", "properties.s3_key.frontend_autocomputed": "False", "properties.s3_key.regex": "^.{1,1024}$", "properties.is_active.field": "is_active", "properties.is_active.type": "BOOL", "properties.is_active.required": "False", "properties.is_active.source_required": "True", "properties.is_active.server_generated": "False", "properties.is_active.autogenerated": "False", "properties.is_active.frontend_autocomputed": "False", "properties.is_active.regex": "^(true|false)$", "children": "[]", "patch.semantic_patch_version": "patch-ignore-immutable-v2", "patch.allowed_fields[0]": "application_id", "patch.allowed_fields[1]": "application_name", "patch.allowed_fields[2]": "display_name", "patch.allowed_fields[3]": "version", "patch.allowed_fields[4]": "platform", "patch.allowed_fields[5]": "installer_type", "patch.allowed_fields[6]": "s3_key", "patch.allowed_fields[7]": "is_active", "patch.ignored_fields[0]": "created", "patch.ignored_fields[1]": "created_at", "patch.ignored_fields[2]": "deleted_at", "patch.ignored_fields[3]": "idempotency_key", "patch.ignored_fields[4]": "is_deleted", "patch.ignored_fields[5]": "schema_version", "patch.ignored_fields[6]": "updated", "patch.ignored_fields[7]": "updated_at", "patch.editable_attributes.application_id.field": "application_id", "patch.editable_attributes.application_id.type": "S", "patch.editable_attributes.application_id.required": "False", "patch.editable_attributes.application_id.source_required": "True", "patch.editable_attributes.application_id.server_generated": "True", "patch.editable_attributes.application_id.autogenerated": "False", "patch.editable_attributes.application_id.frontend_autocomputed": "False", "patch.editable_attributes.application_id.format": "uuidv4", "patch.editable_attributes.application_id.regex": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", "patch.editable_attributes.application_name.field": "application_name", "patch.editable_attributes.application_name.type": "S", "patch.editable_attributes.application_name.required": "True", "patch.editable_attributes.application_name.source_required": "True", "patch.editable_attributes.application_name.server_generated": "False", "patch.editable_attributes.application_name.autogenerated": "False", "patch.editable_attributes.application_name.frontend_autocomputed": "False", "patch.editable_attributes.application_name.regex": "^[A-Za-z0-9 ._-]{1,120}$", "patch.editable_attributes.display_name.field": "display_name", "patch.editable_attributes.display_name.type": "S", "patch.editable_attributes.display_name.required": "True", "patch.editable_attributes.display_name.source_required": "True", "patch.editable_attributes.display_name.server_generated": "False", "patch.editable_attributes.display_name.autogenerated": "False", "patch.editable_attributes.display_name.frontend_autocomputed": "False", "patch.editable_attributes.display_name.regex": "^[A-Za-z0-9 ._-]{1,120}$", "patch.editable_attributes.version.field": "version", "patch.editable_attributes.version.type": "S", "patch.editable_attributes.version.required": "True", "patch.editable_attributes.version.source_required": "True", "patch.editable_attributes.version.server_generated": "False", "patch.editable_attributes.version.autogenerated": "False", "patch.editable_attributes.version.frontend_autocomputed": "False", "patch.editable_attributes.version.regex": "^[0-9]+[.][0-9]+[.][0-9]+$", "patch.editable_attributes.platform.field": "platform", "patch.editable_attributes.platform.type": "S", "patch.editable_attributes.platform.required": "True", "patch.editable_attributes.platform.source_required": "True", "patch.editable_attributes.platform.server_generated": "False", "patch.editable_attributes.platform.autogenerated": "False", "patch.editable_attributes.platform.frontend_autocomputed": "False", "patch.editable_attributes.platform.regex": "^(windows)$", "patch.editable_attributes.installer_type.field": "installer_type", "patch.editable_attributes.installer_type.type": "S", "patch.editable_attributes.installer_type.required": "True", "patch.editable_attributes.installer_type.source_required": "True", "patch.editable_attributes.installer_type.server_generated": "False", "patch.editable_attributes.installer_type.autogenerated": "False", "patch.editable_attributes.installer_type.frontend_autocomputed": "False", "patch.editable_attributes.installer_type.regex": "^(exe|msi|zip)$", "patch.editable_attributes.s3_key.field": "s3_key", "patch.editable_attributes.s3_key.type": "S", "patch.editable_attributes.s3_key.required": "True", "patch.editable_attributes.s3_key.source_required": "True", "patch.editable_attributes.s3_key.server_generated": "False", "patch.editable_attributes.s3_key.autogenerated": "False", "patch.editable_attributes.s3_key.frontend_autocomputed": "False", "patch.editable_attributes.s3_key.regex": "^.{1,1024}$", "patch.editable_attributes.is_active.field": "is_active", "patch.editable_attributes.is_active.type": "BOOL", "patch.editable_attributes.is_active.required": "False", "patch.editable_attributes.is_active.source_required": "True", "patch.editable_attributes.is_active.server_generated": "False", "patch.editable_attributes.is_active.autogenerated": "False", "patch.editable_attributes.is_active.frontend_autocomputed": "False", "patch.editable_attributes.is_active.regex": "^(true|false)$", "root.type": "object", "root.attributes.application_id.field": "application_id", "root.attributes.application_id.type": "S", "root.attributes.application_id.required": "False", "root.attributes.application_id.source_required": "True", "root.attributes.application_id.server_generated": "True", "root.attributes.application_id.autogenerated": "False", "root.attributes.application_id.frontend_autocomputed": "False", "root.attributes.application_id.format": "uuidv4", "root.attributes.application_id.regex": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", "root.attributes.application_name.field": "application_name", "root.attributes.application_name.type": "S", "root.attributes.application_name.required": "True", "root.attributes.application_name.source_required": "True", "root.attributes.application_name.server_generated": "False", "root.attributes.application_name.autogenerated": "False", "root.attributes.application_name.frontend_autocomputed": "False", "root.attributes.application_name.regex": "^[A-Za-z0-9 ._-]{1,120}$", "root.attributes.display_name.field": "display_name", "root.attributes.display_name.type": "S", "root.attributes.display_name.required": "True", "root.attributes.display_name.source_required": "True", "root.attributes.display_name.server_generated": "False", "root.attributes.display_name.autogenerated": "False", "root.attributes.display_name.frontend_autocomputed": "False", "root.attributes.display_name.regex": "^[A-Za-z0-9 ._-]{1,120}$", "root.attributes.version.field": "version", "root.attributes.version.type": "S", "root.attributes.version.required": "True", "root.attributes.version.source_required": "True", "root.attributes.version.server_generated": "False", "root.attributes.version.autogenerated": "False", "root.attributes.version.frontend_autocomputed": "False", "root.attributes.version.regex": "^[0-9]+[.][0-9]+[.][0-9]+$", "root.attributes.platform.field": "platform", "root.attributes.platform.type": "S", "root.attributes.platform.required": "True", "root.attributes.platform.source_required": "True", "root.attributes.platform.server_generated": "False", "root.attributes.platform.autogenerated": "False", "root.attributes.platform.frontend_autocomputed": "False", "root.attributes.platform.regex": "^(windows)$", "root.attributes.installer_type.field": "installer_type", "root.attributes.installer_type.type": "S", "root.attributes.installer_type.required": "True", "root.attributes.installer_type.source_required": "True", "root.attributes.installer_type.server_generated": "False", "root.attributes.installer_type.autogenerated": "False", "root.attributes.installer_type.frontend_autocomputed": "False", "root.attributes.installer_type.regex": "^(exe|msi|zip)$", "root.attributes.s3_key.field": "s3_key", "root.attributes.s3_key.type": "S", "root.attributes.s3_key.required": "True", "root.attributes.s3_key.source_required": "True", "root.attributes.s3_key.server_generated": "False", "root.attributes.s3_key.autogenerated": "False", "root.attributes.s3_key.frontend_autocomputed": "False", "root.attributes.s3_key.regex": "^.{1,1024}$", "root.attributes.is_active.field": "is_active", "root.attributes.is_active.type": "BOOL", "root.attributes.is_active.required": "False", "root.attributes.is_active.source_required": "True", "root.attributes.is_active.server_generated": "False", "root.attributes.is_active.autogenerated": "False", "root.attributes.is_active.frontend_autocomputed": "False", "root.attributes.is_active.regex": "^(true|false)$" } Response Schema --------------- .. code-block:: json { "type": "object", "properties.ok.type": "boolean", "properties.accepted.type": "boolean", "properties.is_committed.type": "boolean", "properties.request_id.type": "string", "properties.message.type": "string", "properties.table.type": "string", "properties.operation.type": "string", "properties.primary_key.type": "string", "properties.primary_key_value.type": "string", "properties.item_update_count.type": "number", "properties.child_update_count.type": "number" } Request Payload --------------- .. code-block:: json { "application_id": "09448f08-7749-4088-beb8-f2994ef59cda", "application_name": "Sample Name" } Response -------- .. code-block:: json { "type": "object", "properties.ok.type": "boolean", "properties.accepted.type": "boolean", "properties.is_committed.type": "boolean", "properties.request_id.type": "string", "properties.message.type": "string", "properties.table.type": "string", "properties.operation.type": "string", "properties.primary_key.type": "string", "properties.primary_key_value.type": "string", "properties.item_update_count.type": "number", "properties.child_update_count.type": "number" } CMD curl -------- .. code-block:: bat curl -X PATCH "https://u91anelyve.execute-api.ap-southeast-1.amazonaws.com/prod/desktop-store-applications-patch-one" -H "Content-Type: application/json" --data-raw "{\"application_id\": \"09448f08-7749-4088-beb8-f2994ef59cda\", \"application_name\": \"Sample Name\"}" PowerShell curl --------------- .. code-block:: powershell curl.exe -X PATCH "https://u91anelyve.execute-api.ap-southeast-1.amazonaws.com/prod/desktop-store-applications-patch-one" -H "Content-Type: application/json" --data-raw '{"application_id": "09448f08-7749-4088-beb8-f2994ef59cda", "application_name": "Sample Name"}'