@mcp-abap-adt/core 6.9.2 → 6.11.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +27 -0
- package/dist/handlers/common/low/handleDeleteObject.d.ts +3 -3
- package/dist/handlers/common/low/handleDeleteObject.js +3 -3
- package/dist/handlers/common/low/handleDeleteObject.js.map +1 -1
- package/dist/handlers/common/low/handleLockObject.d.ts.map +1 -1
- package/dist/handlers/common/low/handleLockObject.js +11 -2
- package/dist/handlers/common/low/handleLockObject.js.map +1 -1
- package/dist/handlers/common/low/handleUnlockObject.d.ts.map +1 -1
- package/dist/handlers/common/low/handleUnlockObject.js +11 -2
- package/dist/handlers/common/low/handleUnlockObject.js.map +1 -1
- package/dist/handlers/compact/high/handleHandlerCreate.d.ts +2 -2
- package/dist/handlers/compact/high/handleHandlerCreate.js +2 -2
- package/dist/handlers/compact/high/handleHandlerCreate.js.map +1 -1
- package/dist/handlers/compact/high/handleHandlerDelete.d.ts +2 -2
- package/dist/handlers/compact/high/handleHandlerDelete.js +2 -2
- package/dist/handlers/compact/high/handleHandlerDelete.js.map +1 -1
- package/dist/handlers/compact/high/handleHandlerGet.d.ts +2 -2
- package/dist/handlers/compact/high/handleHandlerGet.js +2 -2
- package/dist/handlers/compact/high/handleHandlerGet.js.map +1 -1
- package/dist/handlers/compact/high/handleHandlerUpdate.d.ts +2 -2
- package/dist/handlers/compact/high/handleHandlerUpdate.js +2 -2
- package/dist/handlers/compact/high/handleHandlerUpdate.js.map +1 -1
- package/dist/handlers/enhancement/readonly/handleGetEnhancementImpl.d.ts.map +1 -1
- package/dist/handlers/enhancement/readonly/handleGetEnhancementImpl.js +0 -7
- package/dist/handlers/enhancement/readonly/handleGetEnhancementImpl.js.map +1 -1
- package/dist/handlers/enhancement/readonly/handleGetEnhancementSpot.d.ts.map +1 -1
- package/dist/handlers/enhancement/readonly/handleGetEnhancementSpot.js +0 -4
- package/dist/handlers/enhancement/readonly/handleGetEnhancementSpot.js.map +1 -1
- package/dist/handlers/enhancement/readonly/handleGetEnhancements.d.ts.map +1 -1
- package/dist/handlers/enhancement/readonly/handleGetEnhancements.js +0 -10
- package/dist/handlers/enhancement/readonly/handleGetEnhancements.js.map +1 -1
- package/dist/handlers/include/readonly/handleGetInclude.d.ts.map +1 -1
- package/dist/handlers/include/readonly/handleGetInclude.js +0 -4
- package/dist/handlers/include/readonly/handleGetInclude.js.map +1 -1
- package/dist/handlers/include/readonly/handleGetIncludesList.d.ts +1 -1
- package/dist/handlers/include/readonly/handleGetIncludesList.d.ts.map +1 -1
- package/dist/handlers/include/readonly/handleGetIncludesList.js +1 -8
- package/dist/handlers/include/readonly/handleGetIncludesList.js.map +1 -1
- package/dist/handlers/package/readonly/handleGetPackageContents.d.ts +0 -1
- package/dist/handlers/package/readonly/handleGetPackageContents.d.ts.map +1 -1
- package/dist/handlers/package/readonly/handleGetPackageContents.js +0 -4
- package/dist/handlers/package/readonly/handleGetPackageContents.js.map +1 -1
- package/dist/handlers/system/readonly/handleGetAbapAST.d.ts +0 -4
- package/dist/handlers/system/readonly/handleGetAbapAST.d.ts.map +1 -1
- package/dist/handlers/system/readonly/handleGetAbapAST.js +0 -9
- package/dist/handlers/system/readonly/handleGetAbapAST.js.map +1 -1
- package/dist/handlers/system/readonly/handleGetAbapSemanticAnalysis.d.ts +0 -4
- package/dist/handlers/system/readonly/handleGetAbapSemanticAnalysis.d.ts.map +1 -1
- package/dist/handlers/system/readonly/handleGetAbapSemanticAnalysis.js +0 -9
- package/dist/handlers/system/readonly/handleGetAbapSemanticAnalysis.js.map +1 -1
- package/dist/handlers/system/readonly/handleGetAbapSystemSymbols.d.ts +0 -4
- package/dist/handlers/system/readonly/handleGetAbapSystemSymbols.d.ts.map +1 -1
- package/dist/handlers/system/readonly/handleGetAbapSystemSymbols.js +0 -9
- package/dist/handlers/system/readonly/handleGetAbapSystemSymbols.js.map +1 -1
- package/dist/handlers/system/readonly/handleGetSqlQuery.d.ts.map +1 -1
- package/dist/handlers/system/readonly/handleGetSqlQuery.js +0 -5
- package/dist/handlers/system/readonly/handleGetSqlQuery.js.map +1 -1
- package/dist/handlers/system/readonly/handleGetWhereUsed.d.ts +4 -4
- package/dist/handlers/system/readonly/handleGetWhereUsed.d.ts.map +1 -1
- package/dist/handlers/system/readonly/handleGetWhereUsed.js +4 -4
- package/dist/handlers/system/readonly/handleGetWhereUsed.js.map +1 -1
- package/dist/handlers/system/readonly/handleSearchSource.d.ts +2 -1
- package/dist/handlers/system/readonly/handleSearchSource.d.ts.map +1 -1
- package/dist/handlers/system/readonly/handleSearchSource.js +8 -2
- package/dist/handlers/system/readonly/handleSearchSource.js.map +1 -1
- package/dist/lib/search-source/orchestrator.d.ts +6 -0
- package/dist/lib/search-source/orchestrator.d.ts.map +1 -1
- package/dist/lib/search-source/orchestrator.js +22 -3
- package/dist/lib/search-source/orchestrator.js.map +1 -1
- package/docs/user-guide/AVAILABLE_TOOLS.md +121 -124
- package/docs/user-guide/AVAILABLE_TOOLS_COMPACT.md +5 -5
- package/docs/user-guide/AVAILABLE_TOOLS_HIGH.md +43 -43
- package/docs/user-guide/AVAILABLE_TOOLS_LEGACY.md +189 -50
- package/docs/user-guide/AVAILABLE_TOOLS_LOW.md +34 -34
- package/docs/user-guide/AVAILABLE_TOOLS_READONLY.md +46 -49
- package/package.json +1 -1
|
@@ -193,7 +193,7 @@ Generated from code in `src/handlers/**` (not from docs).
|
|
|
193
193
|
|
|
194
194
|
**Parameters:**
|
|
195
195
|
- `description` (string, required) - Behavior Definition description.
|
|
196
|
-
- `implementation_type` (string, required) - Implementation type:
|
|
196
|
+
- `implementation_type` (string, required) - Implementation type: 'Managed', 'Unmanaged', 'Abstract', or 'Projection'.
|
|
197
197
|
- `name` (string, required) - Behavior Definition name (e.g., ZI_MY_BDEF).
|
|
198
198
|
- `package_name` (string, required) - Package name (e.g., ZOK_LOCAL, $TMP for local objects).
|
|
199
199
|
- `root_entity` (string, required) - Root entity name (e.g., ZI_MY_ENTITY).
|
|
@@ -266,7 +266,7 @@ Generated from code in `src/handlers/**` (not from docs).
|
|
|
266
266
|
|
|
267
267
|
**Parameters:**
|
|
268
268
|
- `description` (string, required) - BehaviorDefinition description. Required for validation.
|
|
269
|
-
- `implementation_type` (string, required) - Implementation type:
|
|
269
|
+
- `implementation_type` (string, required) - Implementation type: 'Managed', 'Unmanaged', 'Abstract', or 'Projection'.
|
|
270
270
|
- `name` (string, required) - BehaviorDefinition name to validate (e.g., ZI_MY_BDEF).
|
|
271
271
|
- `package_name` (string, required) - Package name (e.g., ZOK_LOCAL, $TMP for local objects). Required for validation.
|
|
272
272
|
- `root_entity` (string, required) - Root entity name (e.g., ZI_MY_ENTITY). Required for validation.
|
|
@@ -366,7 +366,7 @@ Generated from code in `src/handlers/**` (not from docs).
|
|
|
366
366
|
- `session_id` (string, optional) - Session ID from GetSession. If not provided, a new session will be created.
|
|
367
367
|
- `session_state` (object, optional) - Session state from GetSession (cookies, csrf_token, cookie_store). Required if session_id is provided.
|
|
368
368
|
- `source_code` (string, optional) - Optional: source code to validate. If provided, validates hypothetical code without creating object. Must include complete CLASS DEFINITION and IMPLEMENTATION sections.
|
|
369
|
-
- `version` (string, optional) - Version to check:
|
|
369
|
+
- `version` (string, optional) - Version to check: 'active' (last activated) or 'inactive' (current unsaved). Default: active
|
|
370
370
|
|
|
371
371
|
---
|
|
372
372
|
|
|
@@ -409,7 +409,7 @@ Generated from code in `src/handlers/**` (not from docs).
|
|
|
409
409
|
**Source:** `src/handlers/class/low/handleGetClassUnitTestResult.ts`
|
|
410
410
|
|
|
411
411
|
**Parameters:**
|
|
412
|
-
- `format` (string, optional) - Preferred response format. Defaults to
|
|
412
|
+
- `format` (string, optional) - Preferred response format. Defaults to 'abapunit'.
|
|
413
413
|
- `run_id` (string, required) - Run identifier returned by RunClassUnitTestsLow.
|
|
414
414
|
- `session_id` (string, optional) - Session ID from GetSession. If not provided, a new session will be created.
|
|
415
415
|
- `session_state` (object, optional) - Session state from GetSession (cookies, csrf_token, cookie_store). Required if session_id is provided.
|
|
@@ -553,7 +553,7 @@ Generated from code in `src/handlers/**` (not from docs).
|
|
|
553
553
|
**Source:** `src/handlers/common/low/handleActivateObject.ts`
|
|
554
554
|
|
|
555
555
|
**Parameters:**
|
|
556
|
-
- `objects` (array, required) - Array of objects to activate. Each object must have
|
|
556
|
+
- `objects` (array, required) - Array of objects to activate. Each object must have 'name' and 'type'. URI is optional.
|
|
557
557
|
- `preaudit` (boolean, optional) - Request pre-audit before activation. Default: true
|
|
558
558
|
|
|
559
559
|
---
|
|
@@ -569,20 +569,20 @@ Generated from code in `src/handlers/**` (not from docs).
|
|
|
569
569
|
- `object_type` (string, required) - Object type
|
|
570
570
|
- `session_id` (string, optional) - Session ID from GetSession. If not provided, a new session will be created.
|
|
571
571
|
- `session_state` (object, optional) - Session state from GetSession (cookies, csrf_token, cookie_store). Required if session_id is provided.
|
|
572
|
-
- `version` (string, optional) - Version to check:
|
|
572
|
+
- `version` (string, optional) - Version to check: 'active' or 'inactive' (default active)
|
|
573
573
|
|
|
574
574
|
---
|
|
575
575
|
|
|
576
576
|
<a id="deleteobjectlow-low-level-common"></a>
|
|
577
577
|
#### DeleteObjectLow (Low-Level / Common)
|
|
578
|
-
**Description:** [low-level] Delete an ABAP object via ADT deletion API. Transport request optional for $TMP objects.
|
|
578
|
+
**Description:** [low-level] Delete an ABAP object via ADT deletion API. Transport request optional for $TMP objects. Note: object_type "program" is onprem/legacy only — calling it on ABAP Cloud will fail.
|
|
579
579
|
|
|
580
580
|
**Source:** `src/handlers/common/low/handleDeleteObject.ts`
|
|
581
581
|
|
|
582
582
|
**Parameters:**
|
|
583
583
|
- `function_group_name` (string, optional) - Required only for function_module type
|
|
584
584
|
- `object_name` (string, required) - Object name (e.g., ZCL_MY_CLASS)
|
|
585
|
-
- `object_type` (string, required) - Object type
|
|
585
|
+
- `object_type` (string, required) - Object type. Supported: class, program (onprem/legacy only), interface, function_group, function_module, table, structure, view, domain, data_element, behavior_definition, metadata_extension. Also accepts ADT codes (clas/oc, prog/p, intf/oi, fugr/f, fugr/ff, tabl/dt, ttyp/st, ddls/df, doma/dm, dtel/de, bdef/bd, ddlx/ex).
|
|
586
586
|
- `transport_request` (string, optional) - Transport request number
|
|
587
587
|
|
|
588
588
|
---
|
|
@@ -626,9 +626,9 @@ Generated from code in `src/handlers/**` (not from docs).
|
|
|
626
626
|
**Parameters:**
|
|
627
627
|
- `behavior_definition` (string, optional) - Optional behavior definition name (required for behavior_implementation validation)
|
|
628
628
|
- `description` (string, optional) - Optional description for validation
|
|
629
|
-
- `implementation_type` (string, optional) - Implementation type:
|
|
629
|
+
- `implementation_type` (string, optional) - Implementation type: 'Managed', 'Unmanaged', or 'External' (required for behavior_definition validation)
|
|
630
630
|
- `object_name` (string, required) - Object name to validate (e.g., ZCL_MY_CLASS, Z_MY_PROGRAM, ZIF_MY_INTERFACE)
|
|
631
|
-
- `object_type` (string, required) - Object type:
|
|
631
|
+
- `object_type` (string, required) - Object type: 'class', 'program', 'interface', 'function_group', 'table', 'structure', 'view', 'domain', 'data_element', 'package', 'behavior_definition', 'behavior_implementation', 'metadata_extension'
|
|
632
632
|
- `package_name` (string, optional) - Optional package name for validation
|
|
633
633
|
- `root_entity` (string, optional) - Root entity name (required for behavior_definition validation)
|
|
634
634
|
- `session_id` (string, optional) - Session ID from GetSession. If not provided, a new session will be created.
|
|
@@ -673,7 +673,7 @@ Generated from code in `src/handlers/**` (not from docs).
|
|
|
673
673
|
|
|
674
674
|
**Parameters:**
|
|
675
675
|
- `data_element_name` (string, required) - DataElement name (e.g., Z_TEST_PROGRAM). Must follow SAP naming conventions.
|
|
676
|
-
- `data_type` (string, optional) - Data type (e.g., CHAR, NUMC) or domain name when type_kind is
|
|
676
|
+
- `data_type` (string, optional) - Data type (e.g., CHAR, NUMC) or domain name when type_kind is 'E' or 'domain'.
|
|
677
677
|
- `decimals` (number, optional) - Decimal places (for predefinedAbapType or refToPredefinedAbapType)
|
|
678
678
|
- `description` (string, required) - DataElement description.
|
|
679
679
|
- `length` (number, optional) - Data type length (for predefinedAbapType or refToPredefinedAbapType)
|
|
@@ -681,8 +681,8 @@ Generated from code in `src/handlers/**` (not from docs).
|
|
|
681
681
|
- `session_id` (string, optional) - Session ID from GetSession. If not provided, a new session will be created.
|
|
682
682
|
- `session_state` (object, optional) - Session state from GetSession (cookies, csrf_token, cookie_store). Required if session_id is provided.
|
|
683
683
|
- `transport_request` (string, optional) - Transport request number (e.g., E19K905635). Required for transportable packages.
|
|
684
|
-
- `type_kind` (string, optional) - Type kind:
|
|
685
|
-
- `type_name` (string, optional) - Type name: domain name (when type_kind is
|
|
684
|
+
- `type_kind` (string, optional) - Type kind: 'E' for domain-based, 'P' for predefined type, etc.
|
|
685
|
+
- `type_name` (string, optional) - Type name: domain name (when type_kind is 'domain'), data element name (when type_kind is 'refToDictionaryType'), or class name (when type_kind is 'refToClifType')
|
|
686
686
|
|
|
687
687
|
---
|
|
688
688
|
|
|
@@ -792,7 +792,7 @@ Generated from code in `src/handlers/**` (not from docs).
|
|
|
792
792
|
|
|
793
793
|
**Parameters:**
|
|
794
794
|
- `description` (string, required) - Metadata Extension description.
|
|
795
|
-
- `master_language` (string, optional) - Master language (optional, e.g.,
|
|
795
|
+
- `master_language` (string, optional) - Master language (optional, e.g., 'EN').
|
|
796
796
|
- `name` (string, required) - Metadata Extension name (e.g., ZI_MY_DDLX).
|
|
797
797
|
- `package_name` (string, required) - Package name (e.g., ZOK_LOCAL, $TMP for local objects).
|
|
798
798
|
- `session_id` (string, optional) - Session ID from GetSession. If not provided, a new session will be created.
|
|
@@ -1038,7 +1038,7 @@ Generated from code in `src/handlers/**` (not from docs).
|
|
|
1038
1038
|
- `function_module_name` (string, required) - Function module name (e.g., Z_TEST_FM)
|
|
1039
1039
|
- `session_id` (string, optional) - Session ID from GetSession. If not provided, a new session will be created.
|
|
1040
1040
|
- `session_state` (object, optional) - Session state from GetSession (cookies, csrf_token, cookie_store). Required if session_id is provided.
|
|
1041
|
-
- `version` (string, optional) - Version to check:
|
|
1041
|
+
- `version` (string, optional) - Version to check: 'active' (last activated) or 'inactive' (current unsaved). Default: active
|
|
1042
1042
|
|
|
1043
1043
|
---
|
|
1044
1044
|
|
|
@@ -1464,11 +1464,11 @@ Generated from code in `src/handlers/**` (not from docs).
|
|
|
1464
1464
|
**Source:** `src/handlers/program/low/handleCreateProgram.ts`
|
|
1465
1465
|
|
|
1466
1466
|
**Parameters:**
|
|
1467
|
-
- `application` (string, optional (default: *').)) - Application area (optional, default:
|
|
1467
|
+
- `application` (string, optional (default: *').)) - Application area (optional, default: '*').
|
|
1468
1468
|
- `description` (string, required) - Program description.
|
|
1469
1469
|
- `package_name` (string, required) - Package name (e.g., ZOK_LOCAL, $TMP for local objects).
|
|
1470
1470
|
- `program_name` (string, required) - Program name (e.g., Z_TEST_PROGRAM). Must follow SAP naming conventions.
|
|
1471
|
-
- `program_type` (string, optional) - Program type:
|
|
1471
|
+
- `program_type` (string, optional) - Program type: 'executable', 'include', 'module_pool', 'function_group', 'class_pool', 'interface_pool' (optional).
|
|
1472
1472
|
- `session_id` (string, optional) - Session ID from GetSession. If not provided, a new session will be created.
|
|
1473
1473
|
- `session_state` (object, optional) - Session state from GetSession (cookies, csrf_token, cookie_store). Required if session_id is provided.
|
|
1474
1474
|
- `transport_request` (string, optional) - Transport request number (e.g., E19K905635). Required for transportable packages.
|
|
@@ -1603,7 +1603,7 @@ Generated from code in `src/handlers/**` (not from docs).
|
|
|
1603
1603
|
- `session_id` (string, optional) - Session ID from GetSession. If not provided, a new session will be created.
|
|
1604
1604
|
- `session_state` (object, optional) - Session state from GetSession (cookies, csrf_token, cookie_store). Required if session_id is provided.
|
|
1605
1605
|
- `structure_name` (string, required) - Structure name (e.g., Z_MY_PROGRAM).
|
|
1606
|
-
- `version` (string, optional) - Version to check:
|
|
1606
|
+
- `version` (string, optional) - Version to check: 'active' (last activated) or 'inactive' (current unsaved). Default: inactive
|
|
1607
1607
|
|
|
1608
1608
|
---
|
|
1609
1609
|
|
|
@@ -1614,13 +1614,13 @@ Generated from code in `src/handlers/**` (not from docs).
|
|
|
1614
1614
|
**Source:** `src/handlers/structure/low/handleCreateStructure.ts`
|
|
1615
1615
|
|
|
1616
1616
|
**Parameters:**
|
|
1617
|
-
- `application` (string, optional (default: *').)) - Application area (optional, default:
|
|
1617
|
+
- `application` (string, optional (default: *').)) - Application area (optional, default: '*').
|
|
1618
1618
|
- `description` (string, required) - Structure description.
|
|
1619
1619
|
- `package_name` (string, required) - Package name (e.g., ZOK_LOCAL, $TMP for local objects).
|
|
1620
1620
|
- `session_id` (string, optional) - Session ID from GetSession. If not provided, a new session will be created.
|
|
1621
1621
|
- `session_state` (object, optional) - Session state from GetSession (cookies, csrf_token, cookie_store). Required if session_id is provided.
|
|
1622
1622
|
- `structure_name` (string, required) - Structure name (e.g., Z_TEST_PROGRAM). Must follow SAP naming conventions.
|
|
1623
|
-
- `structure_type` (string, optional) - Structure type:
|
|
1623
|
+
- `structure_type` (string, optional) - Structure type: 'executable', 'include', 'module_pool', 'function_group', 'class_pool', 'interface_pool' (optional).
|
|
1624
1624
|
- `transport_request` (string, optional) - Transport request number (e.g., E19K905635). Required for transportable packages.
|
|
1625
1625
|
|
|
1626
1626
|
---
|
|
@@ -1704,9 +1704,9 @@ Generated from code in `src/handlers/**` (not from docs).
|
|
|
1704
1704
|
**Source:** `src/handlers/system/low/handleGetNodeStructure.ts`
|
|
1705
1705
|
|
|
1706
1706
|
**Parameters:**
|
|
1707
|
-
- `node_id` (string, optional (default: 0000" for root). Use to fetch child nodes.)) - Optional node ID (default:
|
|
1707
|
+
- `node_id` (string, optional (default: 0000" for root). Use to fetch child nodes.)) - Optional node ID (default: "0000" for root). Use to fetch child nodes.
|
|
1708
1708
|
- `parent_name` (string, required) - Parent object name
|
|
1709
|
-
- `parent_type` (string, required) - Parent object type (e.g.,
|
|
1709
|
+
- `parent_type` (string, required) - Parent object type (e.g., "CLAS/OC", "PROG/P", "DEVC/K")
|
|
1710
1710
|
- `session_id` (string, optional) - Session ID from GetSession. If not provided, a new session will be created.
|
|
1711
1711
|
- `session_state` (object, optional) - Session state from GetSession (cookies, csrf_token, cookie_store). Required if session_id is provided.
|
|
1712
1712
|
- `with_short_descriptions` (boolean, optional (default: true)) - Include short descriptions in response
|
|
@@ -1720,8 +1720,8 @@ Generated from code in `src/handlers/**` (not from docs).
|
|
|
1720
1720
|
**Source:** `src/handlers/system/low/handleGetObjectStructure.ts`
|
|
1721
1721
|
|
|
1722
1722
|
**Parameters:**
|
|
1723
|
-
- `object_name` (string, required) - Object name (e.g.,
|
|
1724
|
-
- `object_type` (string, required) - Object type (e.g.,
|
|
1723
|
+
- `object_name` (string, required) - Object name (e.g., "ZMY_CLASS", "ZMY_PROGRAM")
|
|
1724
|
+
- `object_type` (string, required) - Object type (e.g., "CLAS/OC", "PROG/P", "DEVC/K", "DDLS/DF")
|
|
1725
1725
|
- `session_id` (string, optional) - Session ID from GetSession. If not provided, a new session will be created.
|
|
1726
1726
|
- `session_state` (object, optional) - Session state from GetSession (cookies, csrf_token, cookie_store). Required if session_id is provided.
|
|
1727
1727
|
|
|
@@ -1734,9 +1734,9 @@ Generated from code in `src/handlers/**` (not from docs).
|
|
|
1734
1734
|
**Source:** `src/handlers/system/low/handleGetVirtualFolders.ts`
|
|
1735
1735
|
|
|
1736
1736
|
**Parameters:**
|
|
1737
|
-
- `facet_order` (array, optional (default: ['package)) - Order of facets in response (e.g., [
|
|
1737
|
+
- `facet_order` (array, optional (default: ['package)) - Order of facets in response (e.g., ["package", "group", "type"]). Default: ["package", "group", "type"]
|
|
1738
1738
|
- `ignore_short_descriptions` (boolean, optional (default: false)) - Ignore short descriptions in response
|
|
1739
|
-
- `object_search_pattern` (string, optional (default: *)) - Object search pattern (e.g.,
|
|
1739
|
+
- `object_search_pattern` (string, optional (default: *)) - Object search pattern (e.g., "*", "Z*", "ZCL_*"). Default: "*"
|
|
1740
1740
|
- `preselection` (array, optional) - Optional preselection filters (facet-value pairs for filtering)
|
|
1741
1741
|
- `with_versions` (boolean, optional (default: false)) - Include version information in response
|
|
1742
1742
|
|
|
@@ -1766,11 +1766,11 @@ Generated from code in `src/handlers/**` (not from docs).
|
|
|
1766
1766
|
|
|
1767
1767
|
**Parameters:**
|
|
1768
1768
|
- `ddl_code` (string, optional) - Optional DDL source code to validate (for checking new/unsaved code). If provided, code will be base64 encoded and sent in check request body.
|
|
1769
|
-
- `reporter` (string, optional) - Check reporter:
|
|
1769
|
+
- `reporter` (string, optional) - Check reporter: 'tableStatusCheck' or 'abapCheckRun'. Default: abapCheckRun
|
|
1770
1770
|
- `session_id` (string, optional) - Session ID from GetSession. If not provided, a new session will be created.
|
|
1771
1771
|
- `session_state` (object, optional) - Session state from GetSession (cookies, csrf_token, cookie_store). Required if session_id is provided.
|
|
1772
1772
|
- `table_name` (string, required) - Table name (e.g., Z_MY_TABLE)
|
|
1773
|
-
- `version` (string, optional) - Version to check:
|
|
1773
|
+
- `version` (string, optional) - Version to check: 'active' (last activated), 'inactive' (current unsaved), or 'new' (for new code validation). Default: new
|
|
1774
1774
|
|
|
1775
1775
|
---
|
|
1776
1776
|
|
|
@@ -1870,7 +1870,7 @@ Generated from code in `src/handlers/**` (not from docs).
|
|
|
1870
1870
|
|
|
1871
1871
|
**Parameters:**
|
|
1872
1872
|
- `description` (string, required) - Transport request description.
|
|
1873
|
-
- `transport_type` (string, optional (default: workbench').)) - Transport type:
|
|
1873
|
+
- `transport_type` (string, optional (default: workbench').)) - Transport type: 'workbench' or 'customizing' (optional, default: 'workbench').
|
|
1874
1874
|
|
|
1875
1875
|
---
|
|
1876
1876
|
|
|
@@ -1900,7 +1900,7 @@ Generated from code in `src/handlers/**` (not from docs).
|
|
|
1900
1900
|
- `ddl_source` (string, optional) - Optional DDL source code to validate (for checking new/unsaved code). If provided, code will be base64 encoded and sent in check request body.
|
|
1901
1901
|
- `session_id` (string, optional) - Session ID from GetSession. If not provided, a new session will be created.
|
|
1902
1902
|
- `session_state` (object, optional) - Session state from GetSession (cookies, csrf_token, cookie_store). Required if session_id is provided.
|
|
1903
|
-
- `version` (string, optional) - Version to check:
|
|
1903
|
+
- `version` (string, optional) - Version to check: 'active' (last activated) or 'inactive' (current unsaved). Default: inactive
|
|
1904
1904
|
- `view_name` (string, required) - View name (e.g., Z_MY_PROGRAM).
|
|
1905
1905
|
|
|
1906
1906
|
---
|
|
@@ -1912,14 +1912,14 @@ Generated from code in `src/handlers/**` (not from docs).
|
|
|
1912
1912
|
**Source:** `src/handlers/view/low/handleCreateView.ts`
|
|
1913
1913
|
|
|
1914
1914
|
**Parameters:**
|
|
1915
|
-
- `application` (string, optional (default: *').)) - Application area (optional, default:
|
|
1915
|
+
- `application` (string, optional (default: *').)) - Application area (optional, default: '*').
|
|
1916
1916
|
- `description` (string, required) - View description.
|
|
1917
1917
|
- `package_name` (string, required) - Package name (e.g., ZOK_LOCAL, $TMP for local objects).
|
|
1918
1918
|
- `session_id` (string, optional) - Session ID from GetSession. If not provided, a new session will be created.
|
|
1919
1919
|
- `session_state` (object, optional) - Session state from GetSession (cookies, csrf_token, cookie_store). Required if session_id is provided.
|
|
1920
1920
|
- `transport_request` (string, optional) - Transport request number (e.g., E19K905635). Required for transportable packages.
|
|
1921
1921
|
- `view_name` (string, required) - View name (e.g., Z_TEST_PROGRAM). Must follow SAP naming conventions.
|
|
1922
|
-
- `view_type` (string, optional) - View type:
|
|
1922
|
+
- `view_type` (string, optional) - View type: 'executable', 'include', 'module_pool', 'function_group', 'class_pool', 'interface_pool' (optional).
|
|
1923
1923
|
|
|
1924
1924
|
---
|
|
1925
1925
|
|
|
@@ -1969,7 +1969,7 @@ Generated from code in `src/handlers/**` (not from docs).
|
|
|
1969
1969
|
**Source:** `src/handlers/view/low/handleUpdateView.ts`
|
|
1970
1970
|
|
|
1971
1971
|
**Parameters:**
|
|
1972
|
-
- `ddl_source` (string, required) - Complete DDL source code. CDS: include @AbapCatalog.sqlViewName and other annotations. Classic: plain
|
|
1972
|
+
- `ddl_source` (string, required) - Complete DDL source code. CDS: include @AbapCatalog.sqlViewName and other annotations. Classic: plain 'define view' statement.
|
|
1973
1973
|
- `lock_handle` (string, required) - Lock handle from LockObject. Required for update operation.
|
|
1974
1974
|
- `session_id` (string, optional) - Session ID from GetSession. If not provided, a new session will be created.
|
|
1975
1975
|
- `session_state` (object, optional) - Session state from GetSession (cookies, csrf_token, cookie_store). Required if session_id is provided.
|
|
@@ -1992,4 +1992,4 @@ Generated from code in `src/handlers/**` (not from docs).
|
|
|
1992
1992
|
|
|
1993
1993
|
---
|
|
1994
1994
|
|
|
1995
|
-
*Last updated: 2026-05-
|
|
1995
|
+
*Last updated: 2026-05-28*
|
|
@@ -96,13 +96,13 @@ Generated from code in `src/handlers/**` (not from docs).
|
|
|
96
96
|
|
|
97
97
|
<a id="readbehaviordefinition-read-only-behavior-definition"></a>
|
|
98
98
|
#### ReadBehaviorDefinition (Read-Only / Behavior Definition)
|
|
99
|
-
**Description:** Operation: Read, Create, Update. Subject: BehaviorDefinition. Will be useful for reading, creating, or updating behavior definition. [read-only] Read ABAP RAP behavior definition (BDEF) source code and metadata. Answers:
|
|
99
|
+
**Description:** Operation: Read, Create, Update. Subject: BehaviorDefinition. Will be useful for reading, creating, or updating behavior definition. [read-only] Read ABAP RAP behavior definition (BDEF) source code and metadata. Answers: "show behavior definition", "display BDEF source", "view RAP behavior X", "get behavior definition code". Returns source code, package, responsible, description.
|
|
100
100
|
|
|
101
101
|
**Source:** `src/handlers/behavior_definition/readonly/handleReadBehaviorDefinition.ts`
|
|
102
102
|
|
|
103
103
|
**Parameters:**
|
|
104
104
|
- `behavior_definition_name` (string, required) - Behavior definition name (e.g., Z_MY_BDEF).
|
|
105
|
-
- `version` (string, optional (default: active)) - Version to read:
|
|
105
|
+
- `version` (string, optional (default: active)) - Version to read: "active" (default) or "inactive".
|
|
106
106
|
|
|
107
107
|
---
|
|
108
108
|
|
|
@@ -111,13 +111,13 @@ Generated from code in `src/handlers/**` (not from docs).
|
|
|
111
111
|
|
|
112
112
|
<a id="readbehaviorimplementation-read-only-behavior-implementation"></a>
|
|
113
113
|
#### ReadBehaviorImplementation (Read-Only / Behavior Implementation)
|
|
114
|
-
**Description:** [read-only] Read ABAP RAP behavior implementation source code and metadata. Answers:
|
|
114
|
+
**Description:** [read-only] Read ABAP RAP behavior implementation source code and metadata. Answers: "show behavior implementation", "display behavior pool code", "view RAP implementation X". Returns source code, package, responsible, description.
|
|
115
115
|
|
|
116
116
|
**Source:** `src/handlers/behavior_implementation/readonly/handleReadBehaviorImplementation.ts`
|
|
117
117
|
|
|
118
118
|
**Parameters:**
|
|
119
119
|
- `behavior_implementation_name` (string, required) - Behavior implementation name (e.g., ZBP_MY_CLASS).
|
|
120
|
-
- `version` (string, optional (default: active)) - Version to read:
|
|
120
|
+
- `version` (string, optional (default: active)) - Version to read: "active" (default) or "inactive".
|
|
121
121
|
|
|
122
122
|
---
|
|
123
123
|
|
|
@@ -126,13 +126,13 @@ Generated from code in `src/handlers/**` (not from docs).
|
|
|
126
126
|
|
|
127
127
|
<a id="readclass-read-only-class"></a>
|
|
128
128
|
#### ReadClass (Read-Only / Class)
|
|
129
|
-
**Description:** Operation: Read, Create, Update. Subject: Class. Will be useful for reading, creating, or updating class. [read-only] Read ABAP class source code and metadata. Answers:
|
|
129
|
+
**Description:** Operation: Read, Create, Update. Subject: Class. Will be useful for reading, creating, or updating class. [read-only] Read ABAP class source code and metadata. Answers: "show class code", "display class source", "view class definition/implementation", "get class X". Returns source code, package, responsible, description.
|
|
130
130
|
|
|
131
131
|
**Source:** `src/handlers/class/readonly/handleReadClass.ts`
|
|
132
132
|
|
|
133
133
|
**Parameters:**
|
|
134
134
|
- `class_name` (string, required) - Class name (e.g., ZCL_MY_CLASS).
|
|
135
|
-
- `version` (string, optional (default: active)) - Version to read:
|
|
135
|
+
- `version` (string, optional (default: active)) - Version to read: "active" (default) or "inactive".
|
|
136
136
|
|
|
137
137
|
---
|
|
138
138
|
|
|
@@ -141,13 +141,13 @@ Generated from code in `src/handlers/**` (not from docs).
|
|
|
141
141
|
|
|
142
142
|
<a id="readdataelement-read-only-data-element"></a>
|
|
143
143
|
#### ReadDataElement (Read-Only / Data Element)
|
|
144
|
-
**Description:** Operation: Read, Create, Update. Subject: DataElement. Will be useful for reading, creating, or updating data element. [read-only] Read ABAP data element definition and metadata. Answers:
|
|
144
|
+
**Description:** Operation: Read, Create, Update. Subject: DataElement. Will be useful for reading, creating, or updating data element. [read-only] Read ABAP data element definition and metadata. Answers: "show data element X", "display data element properties", "view DTEL definition", "get data element type". Returns definition, domain, package, responsible, description.
|
|
145
145
|
|
|
146
146
|
**Source:** `src/handlers/data_element/readonly/handleReadDataElement.ts`
|
|
147
147
|
|
|
148
148
|
**Parameters:**
|
|
149
149
|
- `data_element_name` (string, required) - Data element name (e.g., Z_MY_DATA_ELEMENT).
|
|
150
|
-
- `version` (string, optional (default: active)) - Version to read:
|
|
150
|
+
- `version` (string, optional (default: active)) - Version to read: "active" (default) or "inactive".
|
|
151
151
|
|
|
152
152
|
---
|
|
153
153
|
|
|
@@ -156,13 +156,13 @@ Generated from code in `src/handlers/**` (not from docs).
|
|
|
156
156
|
|
|
157
157
|
<a id="readdomain-read-only-domain"></a>
|
|
158
158
|
#### ReadDomain (Read-Only / Domain)
|
|
159
|
-
**Description:** Operation: Read, Create, Update. Subject: Domain. Will be useful for reading, creating, or updating domain. [read-only] Read ABAP domain definition and metadata. Answers:
|
|
159
|
+
**Description:** Operation: Read, Create, Update. Subject: Domain. Will be useful for reading, creating, or updating domain. [read-only] Read ABAP domain definition and metadata. Answers: "show domain X", "display domain fixed values", "view domain definition", "get domain properties". Returns definition, fixed values, package, responsible, description.
|
|
160
160
|
|
|
161
161
|
**Source:** `src/handlers/domain/readonly/handleReadDomain.ts`
|
|
162
162
|
|
|
163
163
|
**Parameters:**
|
|
164
164
|
- `domain_name` (string, required) - Domain name (e.g., Z_MY_DOMAIN).
|
|
165
|
-
- `version` (string, optional (default: active)) - Version to read:
|
|
165
|
+
- `version` (string, optional (default: active)) - Version to read: "active" (default) or "inactive".
|
|
166
166
|
|
|
167
167
|
---
|
|
168
168
|
|
|
@@ -209,13 +209,13 @@ Generated from code in `src/handlers/**` (not from docs).
|
|
|
209
209
|
|
|
210
210
|
<a id="readfunctiongroup-read-only-function-group"></a>
|
|
211
211
|
#### ReadFunctionGroup (Read-Only / Function Group)
|
|
212
|
-
**Description:** [read-only] Read ABAP function group source code and metadata. Answers:
|
|
212
|
+
**Description:** [read-only] Read ABAP function group source code and metadata. Answers: "show function group code", "display FUGR source", "view function group X", "get function group includes". Returns source code, package, responsible, description.
|
|
213
213
|
|
|
214
214
|
**Source:** `src/handlers/function_group/readonly/handleReadFunctionGroup.ts`
|
|
215
215
|
|
|
216
216
|
**Parameters:**
|
|
217
217
|
- `function_group_name` (string, required) - Function group name (e.g., Z_MY_FG).
|
|
218
|
-
- `version` (string, optional (default: active)) - Version to read:
|
|
218
|
+
- `version` (string, optional (default: active)) - Version to read: "active" (default) or "inactive".
|
|
219
219
|
|
|
220
220
|
---
|
|
221
221
|
|
|
@@ -224,14 +224,14 @@ Generated from code in `src/handlers/**` (not from docs).
|
|
|
224
224
|
|
|
225
225
|
<a id="readfunctionmodule-read-only-function-module"></a>
|
|
226
226
|
#### ReadFunctionModule (Read-Only / Function Module)
|
|
227
|
-
**Description:** Operation: Read, Create, Update. Subject: FunctionModule. Will be useful for reading, creating, or updating function module. [read-only] Read ABAP function module source code and metadata. Answers:
|
|
227
|
+
**Description:** Operation: Read, Create, Update. Subject: FunctionModule. Will be useful for reading, creating, or updating function module. [read-only] Read ABAP function module source code and metadata. Answers: "show function module code", "display FM source", "view function X", "get function module implementation". Returns source code, package, responsible, description.
|
|
228
228
|
|
|
229
229
|
**Source:** `src/handlers/function_module/readonly/handleReadFunctionModule.ts`
|
|
230
230
|
|
|
231
231
|
**Parameters:**
|
|
232
232
|
- `function_group_name` (string, required) - Function group name containing the function module (e.g., Z_MY_FG).
|
|
233
233
|
- `function_module_name` (string, required) - Function module name (e.g., Z_MY_FM).
|
|
234
|
-
- `version` (string, optional (default: active)) - Version to read:
|
|
234
|
+
- `version` (string, optional (default: active)) - Version to read: "active" (default) or "inactive".
|
|
235
235
|
|
|
236
236
|
---
|
|
237
237
|
|
|
@@ -258,7 +258,7 @@ Generated from code in `src/handlers/**` (not from docs).
|
|
|
258
258
|
**Parameters:**
|
|
259
259
|
- `detailed` (boolean, optional (default: false)) - [read-only] If true, returns structured JSON with metadata and raw XML.
|
|
260
260
|
- `object_name` (string, required) - Name of the ABAP program or include
|
|
261
|
-
- `object_type` (string, required) - [read-only] ADT object type
|
|
261
|
+
- `object_type` (string, required) - [read-only] ADT object type of the parent. Only these four values are supported: 'PROG/P' (program), 'PROG/I' (include), 'FUGR' (function group), 'CLAS/OC' (class). Any other value is rejected by the schema.
|
|
262
262
|
- `timeout` (number, optional) - [read-only] Timeout in ms for each ADT request.
|
|
263
263
|
|
|
264
264
|
---
|
|
@@ -268,13 +268,13 @@ Generated from code in `src/handlers/**` (not from docs).
|
|
|
268
268
|
|
|
269
269
|
<a id="readinterface-read-only-interface"></a>
|
|
270
270
|
#### ReadInterface (Read-Only / Interface)
|
|
271
|
-
**Description:** Operation: Read, Create, Update. Subject: Interface. Will be useful for reading, creating, or updating interface. [read-only] Read ABAP interface source code and metadata. Answers:
|
|
271
|
+
**Description:** Operation: Read, Create, Update. Subject: Interface. Will be useful for reading, creating, or updating interface. [read-only] Read ABAP interface source code and metadata. Answers: "show interface code", "display interface definition", "view interface X", "get interface source". Returns source code, package, responsible, description.
|
|
272
272
|
|
|
273
273
|
**Source:** `src/handlers/interface/readonly/handleReadInterface.ts`
|
|
274
274
|
|
|
275
275
|
**Parameters:**
|
|
276
276
|
- `interface_name` (string, required) - Interface name (e.g., ZIF_MY_INTERFACE).
|
|
277
|
-
- `version` (string, optional (default: active)) - Version to read:
|
|
277
|
+
- `version` (string, optional (default: active)) - Version to read: "active" (default) or "inactive".
|
|
278
278
|
|
|
279
279
|
---
|
|
280
280
|
|
|
@@ -283,13 +283,13 @@ Generated from code in `src/handlers/**` (not from docs).
|
|
|
283
283
|
|
|
284
284
|
<a id="readmetadataextension-read-only-metadata-extension"></a>
|
|
285
285
|
#### ReadMetadataExtension (Read-Only / Metadata Extension)
|
|
286
|
-
**Description:** Operation: Read, Create, Update. Subject: MetadataExtension. Will be useful for reading, creating, or updating metadata extension. [read-only] Read ABAP metadata extension (DDLX) source code and metadata. Answers:
|
|
286
|
+
**Description:** Operation: Read, Create, Update. Subject: MetadataExtension. Will be useful for reading, creating, or updating metadata extension. [read-only] Read ABAP metadata extension (DDLX) source code and metadata. Answers: "show metadata extension", "display DDLX source", "view UI annotations", "get metadata extension X". Returns source code, package, responsible, description.
|
|
287
287
|
|
|
288
288
|
**Source:** `src/handlers/metadata_extension/readonly/handleReadMetadataExtension.ts`
|
|
289
289
|
|
|
290
290
|
**Parameters:**
|
|
291
291
|
- `metadata_extension_name` (string, required) - Metadata extension name (e.g., Z_MY_DDLX).
|
|
292
|
-
- `version` (string, optional (default: active)) - Version to read:
|
|
292
|
+
- `version` (string, optional (default: active)) - Version to read: "active" (default) or "inactive".
|
|
293
293
|
|
|
294
294
|
---
|
|
295
295
|
|
|
@@ -309,13 +309,13 @@ Generated from code in `src/handlers/**` (not from docs).
|
|
|
309
309
|
|
|
310
310
|
<a id="readpackage-read-only-package"></a>
|
|
311
311
|
#### ReadPackage (Read-Only / Package)
|
|
312
|
-
**Description:** [read-only] Read ABAP package definition and metadata. Answers:
|
|
312
|
+
**Description:** [read-only] Read ABAP package definition and metadata. Answers: "show package X", "display package properties", "view package contents", "get package info". Returns definition, super-package, responsible, description.
|
|
313
313
|
|
|
314
314
|
**Source:** `src/handlers/package/readonly/handleReadPackage.ts`
|
|
315
315
|
|
|
316
316
|
**Parameters:**
|
|
317
317
|
- `package_name` (string, required) - Package name (e.g., Z_MY_PACKAGE).
|
|
318
|
-
- `version` (string, optional (default: active)) - Version to read:
|
|
318
|
+
- `version` (string, optional (default: active)) - Version to read: "active" (default) or "inactive".
|
|
319
319
|
|
|
320
320
|
---
|
|
321
321
|
|
|
@@ -329,20 +329,20 @@ Generated from code in `src/handlers/**` (not from docs).
|
|
|
329
329
|
**Source:** `src/handlers/program/readonly/handleGetProgFullCode.ts`
|
|
330
330
|
|
|
331
331
|
**Parameters:**
|
|
332
|
-
- `name` (string, required) - [read-only] Technical name of the program or function group (e.g.,
|
|
333
|
-
- `type` (string, required) - [read-only]
|
|
332
|
+
- `name` (string, required) - [read-only] Technical name of the program or function group (e.g., '/CBY/MM_INVENTORY')
|
|
333
|
+
- `type` (string, required) - [read-only] 'PROG/P' for program or 'FUGR' for function group
|
|
334
334
|
|
|
335
335
|
---
|
|
336
336
|
|
|
337
337
|
<a id="readprogram-read-only-program"></a>
|
|
338
338
|
#### ReadProgram (Read-Only / Program)
|
|
339
|
-
**Description:** Operation: Read, Create, Update. Subject: Program. Will be useful for reading, creating, or updating program. [read-only] Read ABAP program (report) source code and metadata. Answers:
|
|
339
|
+
**Description:** Operation: Read, Create, Update. Subject: Program. Will be useful for reading, creating, or updating program. [read-only] Read ABAP program (report) source code and metadata. Answers: "show program code", "display report source", "view program X", "get program source". Returns source code, package, responsible, description.
|
|
340
340
|
|
|
341
341
|
**Source:** `src/handlers/program/readonly/handleReadProgram.ts`
|
|
342
342
|
|
|
343
343
|
**Parameters:**
|
|
344
344
|
- `program_name` (string, required) - Program name (e.g., Z_MY_PROGRAM).
|
|
345
|
-
- `version` (string, optional (default: active)) - Version to read:
|
|
345
|
+
- `version` (string, optional (default: active)) - Version to read: "active" (default) or "inactive".
|
|
346
346
|
|
|
347
347
|
---
|
|
348
348
|
|
|
@@ -356,7 +356,7 @@ Generated from code in `src/handlers/**` (not from docs).
|
|
|
356
356
|
**Source:** `src/handlers/search/readonly/handleGetObjectsByType.ts`
|
|
357
357
|
|
|
358
358
|
**Parameters:**
|
|
359
|
-
- `format` (string, optional) - [read-only] Output format:
|
|
359
|
+
- `format` (string, optional) - [read-only] Output format: 'raw' or 'parsed'
|
|
360
360
|
- `node_id` (string, required) - [read-only] Node ID
|
|
361
361
|
- `parent_name` (string, required) - [read-only] Parent object name
|
|
362
362
|
- `parent_tech_name` (string, required) - [read-only] Parent technical name
|
|
@@ -381,14 +381,14 @@ Generated from code in `src/handlers/**` (not from docs).
|
|
|
381
381
|
|
|
382
382
|
<a id="searchobject-read-only-search"></a>
|
|
383
383
|
#### SearchObject (Read-Only / Search)
|
|
384
|
-
**Description:** [read-only] Search ABAP repository by object name or wildcard pattern (e.g.
|
|
384
|
+
**Description:** [read-only] Search ABAP repository by object name or wildcard pattern (e.g. 'ZOK*'). Answers: "find object X", "does X exist", "list objects matching...", "search for program/class/table by name". Supports all repository object types — optionally filter by type (PROG, CLAS, INTF, DEVC, TABL, DDLS, DTEL, FUGR, SRVD, SRVB, BDEF, DDLX, etc.).
|
|
385
385
|
|
|
386
386
|
**Source:** `src/handlers/search/readonly/handleSearchObject.ts`
|
|
387
387
|
|
|
388
388
|
**Parameters:**
|
|
389
389
|
- `maxResults` (number, optional (default: 100)) - [read-only] Maximum number of results to return
|
|
390
|
-
- `object_name` (string, required) - [read-only] Object name or mask (e.g.
|
|
391
|
-
- `object_type` (string, optional) - [read-only] Optional ABAP object type (e.g.
|
|
390
|
+
- `object_name` (string, required) - [read-only] Object name or mask (e.g. 'MARA*')
|
|
391
|
+
- `object_type` (string, optional) - [read-only] Optional ABAP object type (e.g. 'TABL', 'CLAS/OC')
|
|
392
392
|
|
|
393
393
|
---
|
|
394
394
|
|
|
@@ -397,7 +397,7 @@ Generated from code in `src/handlers/**` (not from docs).
|
|
|
397
397
|
|
|
398
398
|
<a id="readservicebinding-read-only-service-binding"></a>
|
|
399
399
|
#### ReadServiceBinding (Read-Only / Service Binding)
|
|
400
|
-
**Description:** Operation: Read, Create, Update. Subject: ServiceBinding. Will be useful for reading, creating, or updating service binding. [read-only] Read ABAP service binding (SRVB) payload and metadata. Answers:
|
|
400
|
+
**Description:** Operation: Read, Create, Update. Subject: ServiceBinding. Will be useful for reading, creating, or updating service binding. [read-only] Read ABAP service binding (SRVB) payload and metadata. Answers: "show service binding", "display SRVB config", "view service binding X", "get OData service binding". Returns payload, package, responsible, description.
|
|
401
401
|
|
|
402
402
|
**Source:** `src/handlers/service_binding/readonly/handleReadServiceBinding.ts`
|
|
403
403
|
|
|
@@ -411,13 +411,13 @@ Generated from code in `src/handlers/**` (not from docs).
|
|
|
411
411
|
|
|
412
412
|
<a id="readservicedefinition-read-only-service-definition"></a>
|
|
413
413
|
#### ReadServiceDefinition (Read-Only / Service Definition)
|
|
414
|
-
**Description:** Operation: Read, Create, Update. Subject: ServiceDefinition. Will be useful for reading, creating, or updating service definition. [read-only] Read ABAP service definition (SRVD) source code and metadata. Answers:
|
|
414
|
+
**Description:** Operation: Read, Create, Update. Subject: ServiceDefinition. Will be useful for reading, creating, or updating service definition. [read-only] Read ABAP service definition (SRVD) source code and metadata. Answers: "show service definition", "display SRVD source", "view service definition X", "get service exposure". Returns source code, package, responsible, description.
|
|
415
415
|
|
|
416
416
|
**Source:** `src/handlers/service_definition/readonly/handleReadServiceDefinition.ts`
|
|
417
417
|
|
|
418
418
|
**Parameters:**
|
|
419
419
|
- `service_definition_name` (string, required) - Service definition name (e.g., Z_MY_SRVD).
|
|
420
|
-
- `version` (string, optional (default: active)) - Version to read:
|
|
420
|
+
- `version` (string, optional (default: active)) - Version to read: "active" (default) or "inactive".
|
|
421
421
|
|
|
422
422
|
---
|
|
423
423
|
|
|
@@ -426,13 +426,13 @@ Generated from code in `src/handlers/**` (not from docs).
|
|
|
426
426
|
|
|
427
427
|
<a id="readstructure-read-only-structure"></a>
|
|
428
428
|
#### ReadStructure (Read-Only / Structure)
|
|
429
|
-
**Description:** Operation: Read, Create, Update. Subject: Structure. Will be useful for reading, creating, or updating structure. [read-only] Read ABAP structure definition and metadata. Answers:
|
|
429
|
+
**Description:** Operation: Read, Create, Update. Subject: Structure. Will be useful for reading, creating, or updating structure. [read-only] Read ABAP structure definition and metadata. Answers: "show structure fields", "display structure X", "view structure definition", "get structure components". Returns field list, package, responsible, description.
|
|
430
430
|
|
|
431
431
|
**Source:** `src/handlers/structure/readonly/handleReadStructure.ts`
|
|
432
432
|
|
|
433
433
|
**Parameters:**
|
|
434
434
|
- `structure_name` (string, required) - Structure name (e.g., Z_MY_STRUCTURE).
|
|
435
|
-
- `version` (string, optional (default: active)) - Version to read:
|
|
435
|
+
- `version` (string, optional (default: active)) - Version to read: "active" (default) or "inactive".
|
|
436
436
|
|
|
437
437
|
---
|
|
438
438
|
|
|
@@ -458,7 +458,6 @@ Generated from code in `src/handlers/**` (not from docs).
|
|
|
458
458
|
|
|
459
459
|
**Parameters:**
|
|
460
460
|
- `code` (string, required) - ABAP source code to parse
|
|
461
|
-
- `filePath` (string, optional) - Optional file path to write the result to
|
|
462
461
|
|
|
463
462
|
---
|
|
464
463
|
|
|
@@ -470,7 +469,6 @@ Generated from code in `src/handlers/**` (not from docs).
|
|
|
470
469
|
|
|
471
470
|
**Parameters:**
|
|
472
471
|
- `code` (string, required) - ABAP source code to analyze
|
|
473
|
-
- `filePath` (string, optional) - Optional file path to write the result to
|
|
474
472
|
|
|
475
473
|
---
|
|
476
474
|
|
|
@@ -482,7 +480,6 @@ Generated from code in `src/handlers/**` (not from docs).
|
|
|
482
480
|
|
|
483
481
|
**Parameters:**
|
|
484
482
|
- `code` (string, required) - ABAP source code to analyze and resolve symbols for
|
|
485
|
-
- `filePath` (string, optional) - Optional file path to write the result to
|
|
486
483
|
|
|
487
484
|
---
|
|
488
485
|
|
|
@@ -595,14 +592,14 @@ Generated from code in `src/handlers/**` (not from docs).
|
|
|
595
592
|
|
|
596
593
|
<a id="getwhereused-read-only-system"></a>
|
|
597
594
|
#### GetWhereUsed (Read-Only / System)
|
|
598
|
-
**Description:** [read-only] Search where-used references — find all objects that reference or depend on a given ABAP object. Answers:
|
|
595
|
+
**Description:** [read-only] Search where-used references — find all objects that reference or depend on a given ABAP object. Answers: "where is X used", "who calls X", "what depends on X", "show usages of X". Returns referencing objects with types and packages. Supports a fixed set of object types (see object_type). Object types outside the supported list (e.g. RAP behavior definitions, service definitions/bindings, BAdI, search helps, message classes, classic DDIC views) are NOT supported and will fail.
|
|
599
596
|
|
|
600
597
|
**Source:** `src/handlers/system/readonly/handleGetWhereUsed.ts`
|
|
601
598
|
|
|
602
599
|
**Parameters:**
|
|
603
|
-
- `enable_all_types` (boolean, optional (default: false)) - If true,
|
|
604
|
-
- `object_name` (string, required) - Name of the ABAP object
|
|
605
|
-
- `object_type` (string, required) - Type of the ABAP object
|
|
600
|
+
- `enable_all_types` (boolean, optional (default: false)) - If true, expands the scope to all available object types (Eclipse 'select all' behavior) by flipping every isSelected flag in the scope XML. Default: false (SAP default scope). Note: on large systems this can make the search significantly slower.
|
|
601
|
+
- `object_name` (string, required) - Name of the ABAP object. For function modules the name MUST be in the form 'GROUP|FM_NAME' (function group name, pipe, function module name).
|
|
602
|
+
- `object_type` (string, required) - Type of the ABAP object. Case-insensitive. Accepts either a human alias or an ADT type code. Supported values: 'class' / 'clas/oc', 'interface' / 'intf/if', 'program' / 'prog/p', 'include', 'function' / 'functiongroup' / 'fugr' (function group), 'functionmodule' / 'function_module' / 'fugr/ff' (function module — see object_name format), 'package' / 'devc/k', 'table' / 'tabl/dt', 'structure' / 'stru/dt', 'domain' / 'doma/dd', 'dataelement' / 'dtel', 'view' / 'ddls/df' (CDS DDL source only — classic DDIC views are not supported). Any other value throws 'Unsupported object type'.
|
|
606
603
|
|
|
607
604
|
---
|
|
608
605
|
|
|
@@ -652,7 +649,7 @@ Generated from code in `src/handlers/**` (not from docs).
|
|
|
652
649
|
|
|
653
650
|
**Parameters:**
|
|
654
651
|
- `dump_id` (string, required) - Full runtime dump ID (e.g. from RuntimeListFeeds).
|
|
655
|
-
- `response_mode` (string, optional (default: both)) - Controls what is returned:
|
|
652
|
+
- `response_mode` (string, optional (default: both)) - Controls what is returned: "payload" — full parsed dump data, "summary" — compact key facts only (title, exception, program, line, user, date…), "both" — summary + full payload.
|
|
656
653
|
- `view` (string, optional (default: default)) - Dump view mode: default payload, summary section, or formatted long text.
|
|
657
654
|
|
|
658
655
|
---
|
|
@@ -695,7 +692,7 @@ Generated from code in `src/handlers/**` (not from docs).
|
|
|
695
692
|
**Source:** `src/handlers/system/readonly/handleRuntimeListFeeds.ts`
|
|
696
693
|
|
|
697
694
|
**Parameters:**
|
|
698
|
-
- `feed_type` (string, optional (default: descriptors)) - Feed to read.
|
|
695
|
+
- `feed_type` (string, optional (default: descriptors)) - Feed to read. "descriptors" lists available feeds, "variants" lists feed variants, others read that specific feed. Default: descriptors.
|
|
699
696
|
- `from` (string, optional) - Start of time range in YYYYMMDDHHMMSS format.
|
|
700
697
|
- `max_results` (number, optional) - Maximum number of entries to return.
|
|
701
698
|
- `to` (string, optional) - End of time range in YYYYMMDDHHMMSS format.
|
|
@@ -838,7 +835,7 @@ Generated from code in `src/handlers/**` (not from docs).
|
|
|
838
835
|
|
|
839
836
|
<a id="searchsource-read-only-system"></a>
|
|
840
837
|
#### SearchSource (Read-Only / System)
|
|
841
|
-
**Description:** [read-only] Search ABAP source text inside one or more packages (programs, function groups, classes). Onprem-only (cloud lacks an indexed source-search endpoint). `packages` accepts `*` masks (Z*, ZFI_*, /NS/Z*) alongside exact names; mask resolution is best-effort and scoped to the ADT repository-search result window — there is no guarantee that every matching package is scanned. If you need certainty, pass concrete package names. When using masks, narrow the mask itself and use `object_types`, `object_filter`, and `max_objects` as scan-target controls that apply after package resolution. Comments are searched by default; set exclude_comments=true to drop col-1 `*` and full-line `
|
|
838
|
+
**Description:** [read-only] Search ABAP source text inside one or more packages (programs, function groups, classes). Onprem-only (cloud lacks an indexed source-search endpoint). `packages` accepts `*` masks (Z*, ZFI_*, /NS/Z*) alongside exact names; mask resolution is best-effort and scoped to the ADT repository-search result window — there is no guarantee that every matching package is scanned. If you need certainty, pass concrete package names. When using masks, narrow the mask itself and use `object_types`, `object_filter`, and `max_objects` as scan-target controls that apply after package resolution. Comments are searched by default; set exclude_comments=true to drop col-1 `*` and full-line `"` comments. The `version` parameter affects PROG and CLAS main include reads only — FUGR subinclude reads always go against the active version (the include endpoint exposes no version selector). `truncated.by_object_cap` means at least one object had MORE hits than `max_hits_per_object`, so that object's hits were capped — it is NOT a limit on the number of objects scanned. The object-count limit is `max_objects` (which sets `truncated.by_max_objects`). To avoid `by_object_cap`, raise `max_hits_per_object`. `concurrency` is capped at 16 per call. Run only ONE SearchSource per destination at a time — multiple parallel SearchSource calls against the same SAP system saturate the scan backend and can make all of them time out. Prefer combining terms into a single call over parallel calls.
|
|
842
839
|
|
|
843
840
|
**Source:** `src/handlers/system/readonly/handleSearchSource.ts`
|
|
844
841
|
|
|
@@ -863,13 +860,13 @@ Generated from code in `src/handlers/**` (not from docs).
|
|
|
863
860
|
|
|
864
861
|
<a id="readtable-read-only-table"></a>
|
|
865
862
|
#### ReadTable (Read-Only / Table)
|
|
866
|
-
**Description:** Operation: Read, Create, Update. Subject: Table. Will be useful for reading, creating, or updating table. [read-only] Read ABAP table definition and metadata. Answers:
|
|
863
|
+
**Description:** Operation: Read, Create, Update. Subject: Table. Will be useful for reading, creating, or updating table. [read-only] Read ABAP table definition and metadata. Answers: "show table fields", "display table structure", "view table X", "get table definition". Returns field list, package, responsible, description.
|
|
867
864
|
|
|
868
865
|
**Source:** `src/handlers/table/readonly/handleReadTable.ts`
|
|
869
866
|
|
|
870
867
|
**Parameters:**
|
|
871
868
|
- `table_name` (string, required) - Table name (e.g., Z_MY_TABLE).
|
|
872
|
-
- `version` (string, optional (default: active)) - Version to read:
|
|
869
|
+
- `version` (string, optional (default: active)) - Version to read: "active" (default) or "inactive".
|
|
873
870
|
|
|
874
871
|
---
|
|
875
872
|
|
|
@@ -906,14 +903,14 @@ Generated from code in `src/handlers/**` (not from docs).
|
|
|
906
903
|
|
|
907
904
|
<a id="readview-read-only-view"></a>
|
|
908
905
|
#### ReadView (Read-Only / View)
|
|
909
|
-
**Description:** Operation: Read, Create, Update. Subject: View. Will be useful for reading, creating, or updating view. [read-only] Read ABAP CDS view source code and metadata. Answers:
|
|
906
|
+
**Description:** Operation: Read, Create, Update. Subject: View. Will be useful for reading, creating, or updating view. [read-only] Read ABAP CDS view source code and metadata. Answers: "show CDS view source", "display view definition", "view CDS X", "get CDS code". Returns source code, package, responsible, description.
|
|
910
907
|
|
|
911
908
|
**Source:** `src/handlers/view/readonly/handleReadView.ts`
|
|
912
909
|
|
|
913
910
|
**Parameters:**
|
|
914
|
-
- `version` (string, optional (default: active)) - Version to read:
|
|
911
|
+
- `version` (string, optional (default: active)) - Version to read: "active" (default) or "inactive".
|
|
915
912
|
- `view_name` (string, required) - View name (e.g., Z_MY_VIEW).
|
|
916
913
|
|
|
917
914
|
---
|
|
918
915
|
|
|
919
|
-
*Last updated: 2026-05-
|
|
916
|
+
*Last updated: 2026-05-28*
|