.. AUTO-GENERATED FILE. DO NOT EDIT.

/playstore-domains-patch-one
============================

Summary
-------

- **Source repository:** ``jef-systems/jef-playstore-backend``
- **Source SHA:** ``17cb66a1825b9b2d8d46bf7a947bb061bb54c607``
- **Source run id:** ``29052735793``
- **Lambda function:** ``jef-playstore-patch-004``
- **HTTP method:** ``PATCH``
- **API path:** ``/playstore/async-patch/playstore-domains-patch-one``
- **Endpoint URL:** ``https://api.jefoffice.com/playstore/async-patch/playstore-domains-patch-one``
- **Payload mode:** ``json-body``

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

.. list-table::
   :widths: 30 70

   * - ``Function``
     - jef-playstore-patch-004 Logical ID: jef-playstore:jef-playstore-domains:patch-one Order Number: 003
   * - ``Module``
     - jef-playstore
   * - ``Action``
     - patch-one
   * - ``Method``
     - PATCH
   * - ``Invocation Mode``
     - ASYNC
   * - ``Resource Path``
     - /playstore-domains-patch-one Endpoint Name: jef-playstore-domains-patch-one
   * - ``Table``
     - jef-playstore-domains
   * - ``Primary Key``
     - domain\_id

API Gateway Response
--------------------

.. list-table::
   :widths: 30 70

   * - ``status\_code``
     - 202
   * - ``message``
     - Request accepted for asynchronous processing.

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

.. list-table::
   :widths: 30 70

   * - ``domain\_id``
     - ffbc9769-32cb-4dd1-95f3-4a2151926bfa
   * - ``domain\_name``
     - Sample Name

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

.. code-block:: json

   {
     "type": "object",
     "additionalProperties": "False",
     "payload_mode": "parent-plus-children-wrapper",
     "allow_children_wrapper": "True",
     "children_wrapper_field": "children",
     "allow_batch": "False",
     "table": "jef-playstore-domains",
     "primary_key": "domain_id",
     "required[0]": "domain_id",
     "properties.domain_id.field": "domain_id",
     "properties.domain_id.type": "S",
     "properties.domain_id.required": "False",
     "properties.domain_id.source_required": "True",
     "properties.domain_id.server_generated": "True",
     "properties.domain_id.autogenerated": "False",
     "properties.domain_id.frontend_autocomputed": "False",
     "properties.domain_id.format": "uuidv4",
     "properties.domain_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.domain_name.field": "domain_name",
     "properties.domain_name.type": "S",
     "properties.domain_name.required": "True",
     "properties.domain_name.source_required": "True",
     "properties.domain_name.server_generated": "False",
     "properties.domain_name.autogenerated": "False",
     "properties.domain_name.frontend_autocomputed": "False",
     "properties.domain_name.regex": "^[a-z0-9][a-z0-9.-]{1,120}$",
     "properties.name.field": "name",
     "properties.name.type": "S",
     "properties.name.required": "True",
     "properties.name.source_required": "True",
     "properties.name.server_generated": "False",
     "properties.name.autogenerated": "False",
     "properties.name.frontend_autocomputed": "False",
     "properties.name.regex": "^[A-Za-z0-9 ._@:/#,+&()_-]{1,160}$",
     "children[0].parent_table": "jef-playstore-domains",
     "children[0].child_table": "jef-playstore-applications",
     "children[0].parent_key": "domain_id",
     "children[0].child_foreign_key": "domain_id",
     "children[0].child_index_name": "gsi_1",
     "children[0].child_index_key": "gsi_1_pk",
     "children[0].aliases[0]": "jef-playstore-applications",
     "children[0].aliases[1]": "applications",
     "children[0].aliases[2]": "playstore-applications",
     "children[0].aliases[3]": "jef_playstore_applications",
     "children[0].aliases[4]": "playstore_applications",
     "children[1].parent_table": "jef-playstore-domains",
     "children[1].child_table": "jef-playstore-entities",
     "children[1].parent_key": "domain_id",
     "children[1].child_foreign_key": "domain_id",
     "children[1].child_index_name": "gsi_1",
     "children[1].child_index_key": "gsi_1_pk",
     "children[1].aliases[0]": "jef-playstore-entities",
     "children[1].aliases[1]": "entities",
     "children[1].aliases[2]": "playstore-entities",
     "children[1].aliases[3]": "jef_playstore_entities",
     "children[1].aliases[4]": "playstore_entities",
     "patch.semantic_patch_version": "patch-ignore-immutable-v2",
     "patch.allowed_fields[0]": "domain_id",
     "patch.allowed_fields[1]": "domain_name",
     "patch.allowed_fields[2]": "name",
     "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.domain_id.field": "domain_id",
     "patch.editable_attributes.domain_id.type": "S",
     "patch.editable_attributes.domain_id.required": "False",
     "patch.editable_attributes.domain_id.source_required": "True",
     "patch.editable_attributes.domain_id.server_generated": "True",
     "patch.editable_attributes.domain_id.autogenerated": "False",
     "patch.editable_attributes.domain_id.frontend_autocomputed": "False",
     "patch.editable_attributes.domain_id.format": "uuidv4",
     "patch.editable_attributes.domain_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.domain_name.field": "domain_name",
     "patch.editable_attributes.domain_name.type": "S",
     "patch.editable_attributes.domain_name.required": "True",
     "patch.editable_attributes.domain_name.source_required": "True",
     "patch.editable_attributes.domain_name.server_generated": "False",
     "patch.editable_attributes.domain_name.autogenerated": "False",
     "patch.editable_attributes.domain_name.frontend_autocomputed": "False",
     "patch.editable_attributes.domain_name.regex": "^[a-z0-9][a-z0-9.-]{1,120}$",
     "patch.editable_attributes.name.field": "name",
     "patch.editable_attributes.name.type": "S",
     "patch.editable_attributes.name.required": "True",
     "patch.editable_attributes.name.source_required": "True",
     "patch.editable_attributes.name.server_generated": "False",
     "patch.editable_attributes.name.autogenerated": "False",
     "patch.editable_attributes.name.frontend_autocomputed": "False",
     "patch.editable_attributes.name.regex": "^[A-Za-z0-9 ._@:/#,+&()_-]{1,160}$",
     "root.type": "object",
     "root.attributes.domain_id.field": "domain_id",
     "root.attributes.domain_id.type": "S",
     "root.attributes.domain_id.required": "False",
     "root.attributes.domain_id.source_required": "True",
     "root.attributes.domain_id.server_generated": "True",
     "root.attributes.domain_id.autogenerated": "False",
     "root.attributes.domain_id.frontend_autocomputed": "False",
     "root.attributes.domain_id.format": "uuidv4",
     "root.attributes.domain_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.domain_name.field": "domain_name",
     "root.attributes.domain_name.type": "S",
     "root.attributes.domain_name.required": "True",
     "root.attributes.domain_name.source_required": "True",
     "root.attributes.domain_name.server_generated": "False",
     "root.attributes.domain_name.autogenerated": "False",
     "root.attributes.domain_name.frontend_autocomputed": "False",
     "root.attributes.domain_name.regex": "^[a-z0-9][a-z0-9.-]{1,120}$",
     "root.attributes.name.field": "name",
     "root.attributes.name.type": "S",
     "root.attributes.name.required": "True",
     "root.attributes.name.source_required": "True",
     "root.attributes.name.server_generated": "False",
     "root.attributes.name.autogenerated": "False",
     "root.attributes.name.frontend_autocomputed": "False",
     "root.attributes.name.regex": "^[A-Za-z0-9 ._@:/#,+&()_-]{1,160}$"
   }

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

   {
     "domain_id": "ffbc9769-32cb-4dd1-95f3-4a2151926bfa",
     "domain_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://api.jefoffice.com/playstore/playstore-domains-patch-one" -H "Content-Type: application/json" --data-raw "{\"domain_id\": \"ffbc9769-32cb-4dd1-95f3-4a2151926bfa\", \"domain_name\": \"Sample Name\"}"

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

.. code-block:: powershell

   curl.exe -X PATCH "https://api.jefoffice.com/playstore/playstore-domains-patch-one" -H "Content-Type: application/json" --data-raw '{"domain_id": "ffbc9769-32cb-4dd1-95f3-4a2151926bfa", "domain_name": "Sample Name"}'