.. AUTO-GENERATED FILE. DO NOT EDIT.

H-Workflows Package Version Test
================================

Summary
-------

- **Source repository:** ``jef-systems/jef-accounting-backend``
- **Source SHA:** ``b1ca347aa93805ae657a1bea0f40214d4114d801``
- **Source run id:** ``29866402688``
- **Module:** ``Accounting``
- **Lambda function:** ``jef-h-workflows-test-get-package-version``
- **HTTP method:** ``GET``
- **Invocation mode:** ``sync``
- **Package mode:** ``with-packages``
- **API category:** ``Accounting Complex Sync With Packages GET APIs``
- **API path:** ``/accounting/complex-sync-with-packages/jef-h-workflows-test-get-package-version``
- **Endpoint URL:** ``https://api.jefoffice.com/accounting/complex-sync-with-packages/jef-h-workflows-test-get-package-version``
- **Documentation scope:** ``lambda-complex-sync-with-packages``

Synchronous Lambda Complex Rule
-------------------------------

This API is documented as a synchronous Lambda complex with-packages API.
API Gateway waits for the Lambda result and returns the final Lambda response.

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

Parses and normalizes a package version using an externally packaged Python dependency.

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

.. code-block:: json

   {
     "version": "1.2.3"
   }

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

.. code-block:: json

   {
     "root": {
       "type": "M",
       "required": true,
       "additional_properties": false,
       "attributes": {
         "version": {
           "type": "S",
           "required": true,
           "min_length": 1,
           "max_length": 120,
           "description": "Python package version to parse and normalize.",
           "example": "1.2.3"
         }
       }
     }
   }

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

.. code-block:: json

   {
     "root": {
       "type": "M",
       "required": true,
       "additional_properties": false,
       "attributes": {
         "ok": {
           "type": "BOOL",
           "required": true,
           "description": "Whether the request succeeded."
         },
         "input_version": {
           "type": "S",
           "required": false,
           "description": "Version supplied by the caller."
         },
         "normalized_version": {
           "type": "S",
           "required": false,
           "description": "Version normalized by the packaging library."
         },
         "dependency": {
           "type": "S",
           "required": false,
           "description": "External package exercised by the test.",
           "enum": [
             "packaging"
           ]
         },
         "error": {
           "type": "S",
           "required": false,
           "description": "Stable machine-readable error code."
         },
         "message": {
           "type": "S",
           "required": false,
           "description": "Safe human-readable result message."
         }
       }
     }
   }

CMD curl
--------

.. code-block:: bat

   curl.exe -X GET "https://api.jefoffice.com/accounting/complex-sync-with-packages/jef-h-workflows-test-get-package-version"

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

.. code-block:: powershell

   curl.exe -X GET "https://api.jefoffice.com/accounting/complex-sync-with-packages/jef-h-workflows-test-get-package-version"