.. AUTO-GENERATED FILE. DO NOT EDIT.

get-ingredient-catalog-list
===========================

Source
------

- Repository: ``jef-systems/jef-caferimo-backend``
- Module: ``caferimo``
- Documentation Scope: ``get``
- Lambda: ``jef-caferimo-get-1``

Endpoint
--------

- API Name: ``jef-caferimo``
- Action Name: ``get``
- Method: ``GET``
- Scope Label: ``GET``
- Resource Path: ``/get-ingredient-catalog-list``
- Complete Endpoint: ``https://lfyr4e0eqe.execute-api.ap-southeast-1.amazonaws.com/prod/get-ingredient-catalog-list``
- Lambda ARN: ``arn:aws:lambda:ap-southeast-1:246715082475:function:jef-caferimo-get-1``
- curl payload mode: ``query_string``

API Gateway Description
-----------------------

.. code-block:: text

   Function: jef-caferimo-get-1
   API Name: jef-caferimo
   Action: get
   Method: GET
   Resource Path: /get-ingredient-catalog-list
   
   Payload:
   - limit: number-whole-number-optional
   - last_evaluated_key: string-optional
   
   Response:
   - exists: boolean
   - message: string
   - items: [{"pk":"string-jsin","gsi_1_pk":"string-barcode","jsin":"string","barcode":"string","product_name":"string","product_unit":"string"}]
   - count: number-whole-number
   - last_evaluated_key: string-optional

Request Payload
---------------

.. code-block:: json

   {
     "limit": "number-whole-number-optional",
     "last_evaluated_key": "string-optional"
   }

Response
--------

.. code-block:: json

   {
     "exists": "boolean",
     "message": "string",
     "items": "[{\"pk\":\"string-jsin\",\"gsi_1_pk\":\"string-barcode\",\"jsin\":\"string\",\"barcode\":\"string\",\"product_name\":\"string\",\"product_unit\":\"string\"}]",
     "count": "number-whole-number",
     "last_evaluated_key": "string-optional"
   }

CMD curl
--------

.. code-block:: text

   curl "https://lfyr4e0eqe.execute-api.ap-southeast-1.amazonaws.com/prod/get-ingredient-catalog-list?limit=number-whole-number-optional&last_evaluated_key=string-optional"

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

.. code-block:: text

   curl.exe "https://lfyr4e0eqe.execute-api.ap-southeast-1.amazonaws.com/prod/get-ingredient-catalog-list?limit=number-whole-number-optional&last_evaluated_key=string-optional"