H-Workflows Slug Generation Test

Summary

  • Source repository: jef-systems/jef-accounting-backend

  • Source SHA: b1ca347aa93805ae657a1bea0f40214d4114d801

  • Source run id: 29866402688

  • Module: Accounting

  • Lambda function: jef-h-workflows-test-create-slug

  • HTTP method: POST

  • Invocation mode: sync

  • Package mode: with-packages

  • API category: Accounting Complex Sync With Packages POST APIs

  • API path: /accounting/complex-sync-with-packages/jef-h-workflows-test-create-slug

  • Endpoint URL: https://api.jefoffice.com/accounting/complex-sync-with-packages/jef-h-workflows-test-create-slug

  • 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

Generates a URL-safe slug from a JSON request body using externally packaged Python dependencies.

Payload Example

{
  "text": "Hello H Workflows"
}

Payload Schema

{
  "root": {
    "type": "M",
    "required": true,
    "additional_properties": false,
    "attributes": {
      "text": {
        "type": "S",
        "required": true,
        "min_length": 1,
        "max_length": 500,
        "description": "Text to convert into a URL-safe slug.",
        "example": "Hello H Workflows"
      }
    }
  }
}

Response Schema

{
  "root": {
    "type": "M",
    "required": true,
    "additional_properties": false,
    "attributes": {
      "ok": {
        "type": "BOOL",
        "required": true,
        "description": "Whether the request succeeded."
      },
      "original_text": {
        "type": "S",
        "required": false,
        "description": "Trimmed text supplied by the caller."
      },
      "slug": {
        "type": "S",
        "required": false,
        "description": "URL-safe slug generated from the input text."
      },
      "dependency": {
        "type": "S",
        "required": false,
        "description": "External package exercised by the test.",
        "enum": [
          "python-slugify"
        ]
      },
      "error": {
        "type": "S",
        "required": false,
        "description": "Stable machine-readable error code."
      },
      "message": {
        "type": "S",
        "required": false,
        "description": "Safe human-readable result message."
      }
    }
  }
}

Request Payload

{
  "text": "Hello H Workflows"
}

CMD curl

curl.exe -X POST "https://api.jefoffice.com/accounting/complex-sync-with-packages/jef-h-workflows-test-create-slug" -H "Content-Type: application/json" --data-raw '{}'

PowerShell curl

curl.exe -X POST "https://api.jefoffice.com/accounting/complex-sync-with-packages/jef-h-workflows-test-create-slug" -H "Content-Type: application/json" --data-raw '{}'