abapgit-agent 1.2.0 → 1.4.0

package/API.md

@@ -10,6 +10,9 @@ The ABAP system exposes these endpoints via SICF handler: `sap/bc/z_abapgit_agen
 | POST | `/pull` | Pull and activate repository |
 | POST | `/inspect` | Inspect source file for issues |
 | POST | `/unit` | Execute unit tests (AUnit) |
+| POST | `/tree` | Display package hierarchy tree |
+| POST | `/view` | View ABAP object definitions |
+| POST | `/preview` | Preview table/CDS view data |
 
 ## GET /health
 
@@ -222,7 +225,375 @@ The endpoint parses file names to extract `obj_type` and `obj_name`, then runs A
 }
 ```
 
-## Response Structure
+## POST /tree
+
+Display package hierarchy tree from ABAP system.
+
+### Request Body
+
+```json
+{
+  "package": "$MY_PACKAGE",
+  "depth": 3,
+  "include_objects": true
+}
+```
+
+| Field | Type | Description |
+|-------|------|-------------|
+| `package` | String | Package name (required) |
+| `depth` | Integer | Maximum depth (default: 3, max: 10) |
+| `include_objects` | Boolean | Include object counts by type |
+
+### Response (success)
+
+```json
+{
+  "success": true,
+  "command": "TREE",
+  "package": "$MY_PACKAGE",
+  "message": "Tree retrieved successfully",
+  "parent_package": "$ZSAP_BASE",
+  "nodes": [
+    {
+      "package": "$MY_PACKAGE",
+      "parent": "",
+      "description": "$MY_PACKAGE",
+      "depth": 0,
+      "object_count": 10
+    },
+    {
+      "package": "$MY_SUBPACKAGE",
+      "parent": "$MY_PACKAGE",
+      "description": "$MY_SUBPACKAGE",
+      "depth": 1,
+      "object_count": 5
+    }
+  ],
+  "total_packages": 2,
+  "total_objects": 15,
+  "objects": [
+    { "object": "CLAS", "count": 8 },
+    { "object": "INTF", "count": 2 },
+    { "object": "TABL", "count": 5 }
+  ],
+  "error": ""
+}
+```
+
+### Response (error)
+
+```json
+{
+  "success": false,
+  "command": "TREE",
+  "package": "$NONEXISTENT",
+  "error": "Package $NONEXISTENT does not exist"
+}
+```
+
+## POST /view
+
+View ABAP object definitions directly from ABAP system.
+
+### Request Body
+
+```json
+{
+  "objects": ["ZCL_MY_CLASS", "ZIF_MY_INTERFACE", "SFLIGHT"],
+  "type": "CLAS"
+}
+```
+
+| Field | Type | Description |
+|-------|------|-------------|
+| `objects` | Array | List of object names (required) |
+| `type` | String | Object type (CLAS, INTF, TABL, STRU, DTEL). Auto-detected if not specified |
+
+### Supported Object Types
+
+| Type | Description |
+|------|-------------|
+| CLAS | Global ABAP class |
+| INTF | Global interface |
+| TABL | Database table |
+| STRU | Structure type |
+| DTEL | Data element |
+
+### Response (success - class/interface)
+
+```json
+{
+  "success": true,
+  "command": "VIEW",
+  "message": "Retrieved object(s)",
+  "objects": [
+    {
+      "name": "ZCL_MY_CLASS",
+      "type": "CLAS",
+      "type_text": "Class",
+      "description": "Class ZCL_MY_CLASS in $PACKAGE",
+      "source": "CLASS zcl_my_class DEFINITION PUBLIC.\n  PUBLIC SECTION.\n  ...",
+      "not_found": false,
+      "components": []
+    }
+  ],
+  "summary": {
+    "total": 1,
+    "by_type": ["CLAS"]
+  },
+  "error": ""
+}
+```
+
+### Response (success - table)
+
+```json
+{
+  "success": true,
+  "command": "VIEW",
+  "message": "Retrieved object(s)",
+  "objects": [
+    {
+      "name": "SFLIGHT",
+      "type": "TABL",
+      "type_text": "Table",
+      "description": "Table SFLIGHT in SAPBC_DATAMODEL",
+      "source": "",
+      "not_found": false,
+      "components": [
+        {
+          "field": "MANDT",
+          "key": true,
+          "type": "CLNT",
+          "length": 3,
+          "dataelement": "MANDT",
+          "description": "Client"
+        },
+        {
+          "field": "CARRID",
+          "key": true,
+          "type": "CHAR",
+          "length": 3,
+          "dataelement": "S_CARR_ID",
+          "description": "Airline Code"
+        }
+      ]
+    }
+  ],
+  "summary": {
+    "total": 1,
+    "by_type": ["TABL"]
+  },
+  "error": ""
+}
+```
+
+### Response (success - data element)
+
+```json
+{
+  "success": true,
+  "command": "VIEW",
+  "message": "Retrieved object(s)",
+  "objects": [
+    {
+      "name": "S_CARR_ID",
+      "type": "DTEL",
+      "type_text": "Data Element",
+      "description": "Airline Code",
+      "domain": "S_CARR_ID",
+      "domain_type": "CHAR",
+      "domain_length": 3,
+      "domain_decimals": 0,
+      "not_found": false,
+      "components": []
+    }
+  ],
+  "summary": {
+    "total": 1,
+    "by_type": ["DTEL"]
+  },
+  "error": ""
+}
+```
+
+### Response (not found)
+
+```json
+{
+  "success": true,
+  "command": "VIEW",
+  "message": "Retrieved object(s)",
+  "objects": [
+    {
+      "name": "ZIF_NONEXISTENT",
+      "type": "",
+      "type_text": "Unknown",
+      "not_found": true,
+      "components": []
+    }
+  ],
+  "summary": {
+    "total": 1,
+    "by_type": [""]
+  },
+  "error": ""
+}
+```
+
+## POST /preview
+
+Preview data from ABAP tables or CDS views directly from the ABAP system. This is useful for exploring table/view contents without writing queries.
+
+### Request Body
+
+```json
+{
+  "objects": ["SFLIGHT", "ZC_MY_CDS_VIEW"],
+  "type": "TABL",
+  "limit": 10,
+  "where": "CARRID = 'AA'",
+  "columns": ["CARRID", "CONNID", "PRICE"]
+}
+```
+
+| Field | Type | Description |
+|-------|------|-------------|
+| `objects` | Array | List of table/view names (required) |
+| `type` | String | Object type (TABL, DDLS). Auto-detected if not specified |
+| `limit` | Integer | Maximum rows to return (default: 10, max: 100) |
+| `where` | String | WHERE clause filter (e.g., `CARRID = 'AA'`) |
+| `columns` | Array | Column names to display (optional) |
+
+### Supported Object Types
+
+| Type | Description |
+|------|-------------|
+| TABL | Database table |
+| DDLS | CDS View/Entity |
+
+### Auto-Detection Rules
+
+If `type` is not specified, the system detects the type from TADIR:
+- CDS views (DDLS) are preferred if found in TADIR
+- Otherwise defaults to table (TABL)
+
+### Response (success - table)
+
+```json
+{
+  "success": true,
+  "command": "PREVIEW",
+  "message": "Retrieved data",
+  "objects": [
+    {
+      "name": "SFLIGHT",
+      "type": "TABL",
+      "type_text": "Table",
+      "row_count": 5,
+      "total_rows": 10,
+      "rows": [
+        {
+          "MANDT": "100",
+          "CARRID": "AA",
+          "CONNID": 17,
+          "FLDATE": "2024-10-24",
+          "PRICE": 422.94,
+          "CURRENCY": "USD",
+          "PLANETYPE": "747-400"
+        }
+      ],
+      "fields": [
+        { "field": "MANDT", "type": "CLNT", "length": 3 },
+        { "field": "CARRID", "type": "CHAR", "length": 3 },
+        { "field": "CONNID", "type": "NUMC", "length": 4 },
+        { "field": "FLDATE", "type": "DATS", "length": 8 },
+        { "field": "PRICE", "type": "CURR", "length": 16, "decimals": 2 },
+        { "field": "CURRENCY", "type": "CUKY", "length": 5 }
+      ],
+      "columns_displayed": 6,
+      "columns_hidden": ["SEATSMAX", "SEATSOCC", "PAYMENTSUM"],
+      "error": ""
+    }
+  ],
+  "summary": {
+    "total_objects": 1,
+    "total_rows": 5
+  },
+  "error": ""
+}
+```
+
+### Response (success - CDS view)
+
+```json
+{
+  "success": true,
+  "command": "PREVIEW",
+  "message": "Retrieved data",
+  "objects": [
+    {
+      "name": "ZC_MY_CDS_VIEW",
+      "type": "DDLS",
+      "type_text": "CDS View",
+      "row_count": 10,
+      "total_rows": 25,
+      "rows": [
+        {
+          "PACKAGE": "ZMY_PACKAGE",
+          "DESCRIPTION": "My Package",
+          "PARENT": "$ZROOT"
+        }
+      ],
+      "fields": [
+        { "field": "PACKAGE", "type": "CHAR", "length": 30 },
+        { "field": "DESCRIPTION", "type": "CHAR", "length": 60 },
+        { "field": "PARENT", "type": "CHAR", "length": 30 }
+      ],
+      "columns_displayed": 3,
+      "columns_hidden": [],
+      "error": ""
+    }
+  ],
+  "summary": {
+    "total_objects": 1,
+    "total_rows": 10
+  },
+  "error": ""
+}
+```
+
+### Response (error - not found)
+
+```json
+{
+  "success": true,
+  "command": "PREVIEW",
+  "message": "Retrieved data",
+  "objects": [
+    {
+      "name": "Z_NONEXISTENT",
+      "type": "TABL",
+      "type_text": "Table",
+      "row_count": 0,
+      "total_rows": 0,
+      "rows": [],
+      "fields": [],
+      "columns_displayed": 0,
+      "columns_hidden": [],
+      "error": "Table or view not found: Z_NONEXISTENT"
+    }
+  ],
+  "summary": {
+    "total_objects": 1,
+    "total_rows": 0
+  },
+  "error": ""
+}
+```
+
+### Response Structure
 
 ### Pull Response Fields
 
@@ -261,6 +632,74 @@ The endpoint parses file names to extract `obj_type` and `obj_name`, then runs A
 | `message` | String | Status message |
 | `errors` | Array | Failed test details (empty if all tests pass) |
 
+### Tree Response Fields
+
+| Field | Type | Description |
+|-------|------|-------------|
+| `success` | Boolean | Whether the request succeeded |
+| `command` | String | Command name ("TREE") |
+| `package` | String | Root package name |
+| `message` | String | Status message |
+| `parent_package` | String | Parent package (empty if root) |
+| `nodes` | Array | Flat list of all packages |
+| `total_packages` | Integer | Total packages in tree |
+| `total_objects` | Integer | Total objects in tree |
+| `objects` | Array | Object counts by type |
+| `error` | String | Error message (empty if success) |
+
+### View Response Fields
+
+| Field | Type | Description |
+|-------|------|-------------|
+| `success` | Boolean | Whether the request succeeded |
+| `command` | String | Command name ("VIEW") |
+| `message` | String | Status message |
+| `objects` | Array | List of object information |
+| `summary` | Object | Summary with total and by_type |
+| `error` | String | Error message (empty if success) |
+
+### Preview Response Fields
+
+| Field | Type | Description |
+|-------|------|-------------|
+| `success` | Boolean | Whether the request succeeded |
+| `command` | String | Command name ("PREVIEW") |
+| `message` | String | Status message |
+| `objects` | Array | List of table/view results |
+| `summary` | Object | Summary with total_objects and total_rows |
+| `error` | String | Error message (empty if success) |
+
+### Preview Object Fields
+
+| Field | Type | Description |
+|-------|------|-------------|
+| `name` | String | Table/view name |
+| `type` | String | Object type (TABL, DDLS) |
+| `type_text` | String | Human-readable type (Table, CDS View) |
+| `row_count` | Integer | Number of rows returned |
+| `total_rows` | Integer | Total rows available (before limit) |
+| `rows` | Array | Array of row objects with field:value pairs |
+| `fields` | Array | Field metadata (field, type, length, decimals) |
+| `columns_displayed` | Integer | Number of columns in output |
+| `columns_hidden` | Array | Column names not displayed (if limited) |
+| `error` | String | Error message (empty if success) |
+
+### Object Fields (for View)
+
+| Field | Type | Description |
+|-------|------|-------------|
+| `name` | String | Object name |
+| `type` | String | Object type (CLAS, INTF, TABL, STRU, DTEL) |
+| `type_text` | String | Human-readable type |
+| `description` | String | Object description |
+| `source` | String | Source code (CLAS/INTF) |
+| `domain` | String | Domain name (DTEL) |
+| `domain_type` | String | Domain data type (DTEL) |
+| `domain_length` | Integer | Domain length (DTEL) |
+| `domain_decimals` | Integer | Domain decimals (DTEL) |
+| `not_found` | Boolean | true if object does not exist |
+| `components` | Array | Fields/components (TABL/STRU) |
+
 ### Error Item Fields
 
 | Field | Type | Description |