.. AUTO-GENERATED FILE. DO NOT EDIT.

knowledge-bases-book-pages-patch-one
====================================

Source
------

- Repository: ``jef-systems/jef-knowledge-bases-backend``
- Source Run ID: ``25225199457``
- Source SHA: ``aa5ff95e9fc61b1117b4e8fbff26c3c0f37efea2``
- Module: ``knowledge-bases``
- Documentation Scope: ``async``
- Lambda: ``jef-knowledge-bases-patch-2``

Endpoint
--------

- API Name: ``jef-knowledge-bases``
- Action Name: ``patch``
- Method: ``PATCH``
- Scope Label: ``Async``
- Resource Path: ``/knowledge-bases-book-pages-patch-one``
- Complete Endpoint: ``https://in42anzkh6.execute-api.ap-southeast-1.amazonaws.com/prod/knowledge-bases-book-pages-patch-one``
- Lambda ARN: ``arn:aws:lambda:ap-southeast-1:246715082475:function:jef-knowledge-bases-patch-2``
- curl payload mode: ``json_body``

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

.. code-block:: text

   Function: jef-knowledge-bases-patch-2
   Module: jef-knowledge-bases
   Action: patch
   Method: PATCH
   Invocation Mode: ASYNC
   Resource Path: /knowledge-bases-book-pages-patch-one
   
   API Gateway Response:
   - status_code: 202
   - message: Request accepted for asynchronous processing.
   
   Table:
   - table: jef-knowledge-bases-book-pages
   
   Payload Example:
   - pk: document-001-page-0001
   - gsi_1_pk: kb-001
   - gsi_1_sk: 2026-05-01T01:00:00+08:00
   - document_id: document-001
   - page_id: document-001-page-0001
   - book_version: v1
   - knowledge_base_id: kb-001
   - book_id: book-001
   - book_slug: sample-book
   - slug: sample-book
   - name: Sample Book
   - title: Sample Knowledge Base Book
   - description: Sample knowledge base record for local testing.
   - language: en
   - owner_entity_number: entity-001
   - page_number: 1
   - page_number_padded: 0001
   - page_label: Page 1
   - source_type: pdf
   - source_uri: s3://sample-bucket/knowledge-bases/sample-book.pdf
   - source_hash: sample-source-hash
   - s3_bucket: sample-bucket
   - s3_key: knowledge-bases/sample-book.pdf
   - content_type: application/pdf
   - text: This is sample extracted page text for testing.
   - text_hash: sample-text-hash
   - text_length: 47
   - word_count: 8
   - chunk_count: 0
   - extraction_engine: pdfplumber
   - ingestion_status: completed
   - status: active
   - active: True
   - empty: False
   - failed: False
   - manifest_verified: True
   - pipeline_run_id: pipeline-run-001
   - latest_build_number: 1
   - extracted_at: 2026-05-01T01:00:00+08:00
   - started_at: 2026-05-01T01:00:00+08:00
   - completed_at: 2026-05-01T01:00:00+08:00
   - failed_at: 2026-05-01T01:00:00+08:00
   - created_at: 2026-05-01T01:00:00+08:00
   - updated_at: 2026-05-01T01:00:00+08:00
   - published_at: 2026-05-01T01:00:00+08:00
   - submitted_at: 2026-05-01T01:00:00+08:00
   - created_by: system
   - updated_by: system
   - error_message: 
   - idempotency_key: b5a7088c-847d-40c8-917f-f879ffa24908
   
   Payload Schema:
   - pk: string-{page_id}
   - gsi_1_pk: string-{knowledge_base_id}
   - gsi_1_sk: string-{updated_at}
   - document_id: string
   - page_id: string
   - book_version: string
   - knowledge_base_id: string
   - book_id: string
   - book_slug: string
   - slug: string
   - name: string
   - title: string
   - description: string
   - language: string
   - owner_entity_number: string
   - page_number: number
   - page_number_padded: string
   - page_label: string
   - source_type: string
   - source_uri: string
   - source_hash: string
   - s3_bucket: string
   - s3_key: string
   - content_type: string
   - text: string
   - text_hash: string
   - text_length: number
   - word_count: number
   - chunk_count: number
   - extraction_engine: string
   - ingestion_status: string
   - status: string
   - active: boolean
   - empty: boolean
   - failed: boolean
   - manifest_verified: boolean
   - pipeline_run_id: string
   - latest_build_number: number
   - extracted_at: string
   - started_at: string
   - completed_at: string
   - failed_at: string
   - created_at: string
   - updated_at: string
   - published_at: string
   - submitted_at: string
   - created_by: string
   - updated_by: string
   - error_message: string
   - idempotency_key: string
   
   Response Schema:
   - is_accepted: boolean
   - message: string

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

.. code-block:: json

   {
     "pk": "document-001-page-0001",
     "gsi_1_pk": "kb-001",
     "gsi_1_sk": "2026-05-01T01:00:00+08:00",
     "document_id": "document-001",
     "page_id": "document-001-page-0001",
     "book_version": "v1",
     "knowledge_base_id": "kb-001",
     "book_id": "book-001",
     "book_slug": "sample-book",
     "slug": "sample-book",
     "name": "Sample Book",
     "title": "Sample Knowledge Base Book",
     "description": "Sample knowledge base record for local testing.",
     "language": "en",
     "owner_entity_number": "entity-001",
     "page_number": "1",
     "page_number_padded": "0001",
     "page_label": "Page 1",
     "source_type": "pdf",
     "source_uri": "s3://sample-bucket/knowledge-bases/sample-book.pdf",
     "source_hash": "sample-source-hash",
     "s3_bucket": "sample-bucket",
     "s3_key": "knowledge-bases/sample-book.pdf",
     "content_type": "application/pdf",
     "text": "This is sample extracted page text for testing.",
     "text_hash": "sample-text-hash",
     "text_length": "47",
     "word_count": "8",
     "chunk_count": "0",
     "extraction_engine": "pdfplumber",
     "ingestion_status": "completed",
     "status": "active",
     "active": "True",
     "empty": "False",
     "failed": "False",
     "manifest_verified": "True",
     "pipeline_run_id": "pipeline-run-001",
     "latest_build_number": "1",
     "extracted_at": "2026-05-01T01:00:00+08:00",
     "started_at": "2026-05-01T01:00:00+08:00",
     "completed_at": "2026-05-01T01:00:00+08:00",
     "failed_at": "2026-05-01T01:00:00+08:00",
     "created_at": "2026-05-01T01:00:00+08:00",
     "updated_at": "2026-05-01T01:00:00+08:00",
     "published_at": "2026-05-01T01:00:00+08:00",
     "submitted_at": "2026-05-01T01:00:00+08:00",
     "created_by": "system",
     "updated_by": "system",
     "error_message": "",
     "idempotency_key": "b5a7088c-847d-40c8-917f-f879ffa24908"
   }

Response
--------

.. code-block:: json

   {
     "is_accepted": "boolean",
     "message": "string"
   }

CMD curl
--------

.. code-block:: text

   curl -X PATCH "https://in42anzkh6.execute-api.ap-southeast-1.amazonaws.com/prod/knowledge-bases-book-pages-patch-one" -H "Content-Type: application/json" --data-raw "{\"pk\": \"document-001-page-0001\", \"gsi_1_pk\": \"kb-001\", \"gsi_1_sk\": \"2026-05-01T01:00:00+08:00\", \"document_id\": \"document-001\", \"page_id\": \"document-001-page-0001\", \"book_version\": \"v1\", \"knowledge_base_id\": \"kb-001\", \"book_id\": \"book-001\", \"book_slug\": \"sample-book\", \"slug\": \"sample-book\", \"name\": \"Sample Book\", \"title\": \"Sample Knowledge Base Book\", \"description\": \"Sample knowledge base record for local testing.\", \"language\": \"en\", \"owner_entity_number\": \"entity-001\", \"page_number\": 1, \"page_number_padded\": \"0001\", \"page_label\": \"Page 1\", \"source_type\": \"pdf\", \"source_uri\": \"s3://sample-bucket/knowledge-bases/sample-book.pdf\", \"source_hash\": \"sample-source-hash\", \"s3_bucket\": \"sample-bucket\", \"s3_key\": \"knowledge-bases/sample-book.pdf\", \"content_type\": \"application/pdf\", \"text\": \"This is sample extracted page text for testing.\", \"text_hash\": \"sample-text-hash\", \"text_length\": 47, \"word_count\": 8, \"chunk_count\": 0, \"extraction_engine\": \"pdfplumber\", \"ingestion_status\": \"completed\", \"status\": \"active\", \"active\": true, \"empty\": false, \"failed\": false, \"manifest_verified\": true, \"pipeline_run_id\": \"pipeline-run-001\", \"latest_build_number\": 1, \"extracted_at\": \"2026-05-01T01:00:00+08:00\", \"started_at\": \"2026-05-01T01:00:00+08:00\", \"completed_at\": \"2026-05-01T01:00:00+08:00\", \"failed_at\": \"2026-05-01T01:00:00+08:00\", \"created_at\": \"2026-05-01T01:00:00+08:00\", \"updated_at\": \"2026-05-01T01:00:00+08:00\", \"published_at\": \"2026-05-01T01:00:00+08:00\", \"submitted_at\": \"2026-05-01T01:00:00+08:00\", \"created_by\": \"system\", \"updated_by\": \"system\", \"error_message\": \"\", \"idempotency_key\": \"b5a7088c-847d-40c8-917f-f879ffa24908\"}"

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

.. code-block:: text

   curl.exe -X PATCH "https://in42anzkh6.execute-api.ap-southeast-1.amazonaws.com/prod/knowledge-bases-book-pages-patch-one" -H "Content-Type: application/json" --data-raw '{"pk": "document-001-page-0001", "gsi_1_pk": "kb-001", "gsi_1_sk": "2026-05-01T01:00:00+08:00", "document_id": "document-001", "page_id": "document-001-page-0001", "book_version": "v1", "knowledge_base_id": "kb-001", "book_id": "book-001", "book_slug": "sample-book", "slug": "sample-book", "name": "Sample Book", "title": "Sample Knowledge Base Book", "description": "Sample knowledge base record for local testing.", "language": "en", "owner_entity_number": "entity-001", "page_number": 1, "page_number_padded": "0001", "page_label": "Page 1", "source_type": "pdf", "source_uri": "s3://sample-bucket/knowledge-bases/sample-book.pdf", "source_hash": "sample-source-hash", "s3_bucket": "sample-bucket", "s3_key": "knowledge-bases/sample-book.pdf", "content_type": "application/pdf", "text": "This is sample extracted page text for testing.", "text_hash": "sample-text-hash", "text_length": 47, "word_count": 8, "chunk_count": 0, "extraction_engine": "pdfplumber", "ingestion_status": "completed", "status": "active", "active": true, "empty": false, "failed": false, "manifest_verified": true, "pipeline_run_id": "pipeline-run-001", "latest_build_number": 1, "extracted_at": "2026-05-01T01:00:00+08:00", "started_at": "2026-05-01T01:00:00+08:00", "completed_at": "2026-05-01T01:00:00+08:00", "failed_at": "2026-05-01T01:00:00+08:00", "created_at": "2026-05-01T01:00:00+08:00", "updated_at": "2026-05-01T01:00:00+08:00", "published_at": "2026-05-01T01:00:00+08:00", "submitted_at": "2026-05-01T01:00:00+08:00", "created_by": "system", "updated_by": "system", "error_message": "", "idempotency_key": "b5a7088c-847d-40c8-917f-f879ffa24908"}'