ApiLogicServer 14.3.25__py3-none-any.whl → 14.5.0__py3-none-any.whl

api_logic_server_cli/prototypes/basic_demo/customizations/integration/mcp/resources/nw_swagger_3_relaxed.yaml

@@ -0,0 +1,109 @@
+openapi: 3.0.3
+info:
+  title: Customer API
+  version: 1.0.0
+  description: API for retrieving customer information, including filtering by country and pagination.
+
+servers:
+  - url: https://your-ngrok-url.ngrok-free.app/api
+
+paths:
+  /Customer:
+    get:
+      summary: List Customers
+      description: Retrieve a list of customers, optionally filtering by country, limiting results, and sorting.
+      parameters:
+        - in: query
+          name: filter[Country]
+          schema:
+            type: string
+          description: Filter customers by country name (e.g., Germany).
+        - in: query
+          name: page[limit]
+          schema:
+            type: integer
+          description: Maximum number of customers to return.
+        - in: query
+          name: page[offset]
+          schema:
+            type: integer
+          description: Number of customers to skip before starting to collect results.
+        - in: query
+          name: sort
+          schema:
+            type: string
+          description: Field to sort by (e.g., id).
+      responses:
+        '200':
+          description: A list of customers
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  data:
+                    type: array
+                    items:
+                      type: object
+                      properties:
+                        id:
+                          type: string
+                          description: Customer ID
+                        type:
+                          type: string
+                          example: Customer
+                        attributes:
+                          type: object
+                          properties:
+                            CompanyName:
+                              type: string
+                            ContactName:
+                              type: string
+                            ContactTitle:
+                              type: string
+                            Address:
+                              type: string
+                            City:
+                              type: string
+                            Region:
+                              type: string
+                            PostalCode:
+                              type: string
+                            Country:
+                              type: string
+                            Phone:
+                              type: string
+                            Fax:
+                              type: string
+                            Balance:
+                              type: number
+                            CreditLimit:
+                              type: number
+                            OrderCount:
+                              type: integer
+                            UnpaidOrderCount:
+                              type: integer
+                            Client_id:
+                              type: integer
+                            S_CheckSum:
+                              type: string
+                  meta:
+                    type: object
+                    properties:
+                      count:
+                        type: integer
+                      limit:
+                        type: integer
+                      total:
+                        type: integer
+                  links:
+                    type: object
+                    properties:
+                      self:
+                        type: string
+                      next:
+                        type: string
+                      last:
+                        type: string
+
+components: {}

api_logic_server_cli/prototypes/basic_demo/customizations/integration/mcp/resources/proxy_server.py

@@ -0,0 +1,51 @@
+from flask import Flask, request, make_response
+import requests
+import json
+
+app = Flask(__name__)
+
+@app.route('/api/Customer')
+def proxy_customer():
+    # The real API endpoint
+    real_url = 'https://your-real-server.ngrok-free.app/api/Customer'
+
+    try:
+        # Fetch from the actual API
+        response = requests.get(real_url, params=request.args, headers={'Accept': 'application/json'})
+        response.raise_for_status()
+        real_data = response.json()
+
+        transformed_data = {
+            "data": [],
+            "jsonapi": {"version": "1.0"},
+            "links": {"self": request.url}
+        }
+
+        # Convert each customer to JSON:API format
+        for item in real_data.get("data", []):
+            attributes = item.get("attributes", {})
+            attributes.pop("Id", None)  # Remove duplicate ID if present
+
+            transformed_data["data"].append({
+                "type": "Customer",
+                "id": item.get("id") or attributes.get("Id"),
+                "attributes": attributes
+            })
+
+        # JSON:API-compliant response
+        response_json = json.dumps(transformed_data)
+        response_obj = make_response(response_json)
+        response_obj.headers["Content-Type"] = "application/vnd.api+json"
+        return response_obj
+
+    except Exception as e:
+        error_response = {"errors": [{"title": "Proxy Error", "detail": str(e)}]}
+        response_json = json.dumps(error_response)
+        response_obj = make_response(response_json, 500)
+        response_obj.headers["Content-Type"] = "application/vnd.api+json"
+        return response_obj
+
+if __name__ == '__main__':
+    app.run(host='0.0.0.0', port=6000, debug=True)
+
+# test: curl "http://localhost:6000/api/Customer?filter%5BCountry%5D=Germany&page%5Blimit%5D=2"

api_logic_server_cli/prototypes/basic_demo/customizations/integration/mcp/resources/proxy_serverZ.py

@@ -0,0 +1,72 @@
+# Step 1: Install Flask and Requests libraries
+# Run this once: pip install flask requests
+
+import json
+from flask import Flask, jsonify, request
+from flask import make_response
+import requests
+
+app = Flask(__name__)
+
+@app.before_request
+def before_any_request():
+    print(f"[DEBUG] Incoming request: {request.method} {request.url}")
+
+# Step 2: Proxy endpoint to fix /api/Customer
+@app.route('/api/Customer')
+def proxy_customer():
+    import pprint
+    real_url = 'https://your-ngrok-url.ngrok-free.app/api/Customer'
+    real_url = 'http://localhost:5656/api/Customer'
+
+    try:
+        print(f"[Proxy] Forwarding to: {real_url}")
+        print(f"[Proxy] With params: {request.args}")
+
+        response = requests.get(real_url, params=request.args, headers={'Accept': 'application/json'})
+        response.raise_for_status()
+        real_data = response.json()
+
+        print("[Proxy] Got response:")
+        pprint.pprint(real_data)
+
+        transformed_data = {
+            "data": []
+        }
+
+        transformed_data = {
+            "data": [
+                {
+                    "type": "Customer",
+                    "id": attributes.get("Id"),
+                    "attributes": attributes
+                } for item in real_data.get("data", [])
+                if (attributes := item.get("attributes"))
+            ]
+        }
+
+        for item in real_data.get("data", []):
+            attributes = item.get("attributes", {})
+            attributes.pop("Id", None)  # Remove duplicate ID TODO
+            transformed_data["data"].append({
+                "type": "Customer",
+                "id": item.get("id") or attributes.get("Id"),
+                "attributes": attributes
+            })
+
+
+        response_json = json.dumps(transformed_data)
+        response_obj = make_response(response_json)
+        response_obj.headers["Content-Type"] = "application/vnd.api+json"
+        return response_obj
+    except Exception as e:
+        print("[Proxy] ERROR:", e)
+        return jsonify({"error": str(e)}), 500
+
+# Run the proxy locally
+if __name__ == '__main__':
+    app.run(host='0.0.0.0', port=6000, debug=True)
+
+#  test:
+# http://localhost:6000/api/Customer
+# curl "http://localhost:6000/api/Customer?filter%5BCountry%5D=Germany&page%5Blimit%5D=2"

api_logic_server_cli/prototypes/basic_demo/customizations/integration/mcp/resources/validate_jsonapi.py

@@ -0,0 +1,64 @@
+import requests
+
+def validate_jsonapi_response(url):
+    try:
+        response = requests.get(
+            url,
+            headers={"Accept": "application/vnd.api+json"},
+            timeout=10
+        )
+        
+        validation_report = {
+            "status_code": response.status_code,
+            "content_type_correct": False,
+            "top_level_keys_valid": False,
+            "resource_objects_valid": False,
+            "errors": []
+        }
+
+        # Check Content-Type header
+        content_type = response.headers.get('Content-Type', '')
+        if "application/vnd.api+json" in content_type:
+            validation_report["content_type_correct"] = True
+        else:
+            validation_report["errors"].append("Incorrect Content-Type: expected 'application/vnd.api+json'.")
+
+        # Check top-level keys
+        json_body = response.json()
+        if any(k in json_body for k in ["data", "errors", "meta"]):
+            validation_report["top_level_keys_valid"] = True
+        else:
+            validation_report["errors"].append("Missing required top-level key: data, errors, or meta.")
+
+        # If data is present, validate resource objects
+        if "data" in json_body:
+            data = json_body["data"]
+            if isinstance(data, list):
+                resources = data
+            else:
+                resources = [data]
+
+            all_resources_valid = True
+            for res in resources:
+                if not all(key in res for key in ["id", "type", "attributes"]):
+                    all_resources_valid = False
+                    validation_report["errors"].append(
+                        f"Invalid resource object: missing id, type, or attributes -> {res}"
+                    )
+                    break
+            validation_report["resource_objects_valid"] = all_resources_valid
+
+    except Exception as e:
+        validation_report = {
+            "error": str(e)
+        }
+
+    return validation_report
+
+# Example: Replace with your actual URL
+test_url = "https://dcba-2601-644-4900-d6f0-806d-b9f7-9f64-7677.ngrok-free.app/api/Customer"
+
+# Run validator
+result = validate_jsonapi_response(test_url)
+print(result)
+# {'status_code': 200, 'content_type_correct': True, 'top_level_keys_valid': True, 'resource_objects_valid': True, 'errors': []}

api_logic_server_cli/prototypes/basic_demo/customizations/integration/mcp/run_executor.py

@@ -0,0 +1,23 @@
+import requests
+
+tool_context = {
+    "method": "GET",
+    "url": "http://localhost:5656/api/Customer",
+    "query_params": {
+        "filter[Country]": "Germany",
+        "page[limit]": 2
+    },
+    "headers": {
+        "Accept": "application/vnd.api+json"
+    }
+}
+
+response = requests.get(
+    tool_context["url"],
+    headers=tool_context["headers"],
+    params=tool_context["query_params"]
+)
+
+print(f"Status Code: {response.status_code}")
+print("Response JSON:")
+print(response.json())

api_logic_server_cli/prototypes/basic_demo/customizations/integration/mcp/swagger_converter.py

@@ -0,0 +1,65 @@
+import yaml
+import subprocess
+import tempfile
+import os
+'''
+convert swagger 2.0 to openapi 3.0
+pip install pyyaml
+npm install -g swagger2openapi
+'''
+def filter_swagger(input_file, output_file, include_paths_methods):
+    """
+    include_paths_methods: dict of {"/path": ["get", "post", ...]}
+    """
+    with open(input_file, 'r') as f:
+        swagger = yaml.safe_load(f)
+
+    filtered_paths = {}
+    tags = []
+    for path, methods in swagger.get('paths', {}).items():
+        if path in include_paths_methods:
+            print(f"Filtering path: {path}")
+            tags.append({"name": path.replace("/", "",2)})
+            filtered_methods = {
+                method: op
+                for method, op in methods.items()
+                if method.lower() in [m.lower() for m in include_paths_methods[path]]
+            }
+            if filtered_methods:
+                print
+                filtered_paths[path] = filtered_methods
+    swagger['tags'] = tags
+    swagger['paths'] = filtered_paths
+    info ={}
+    swagger["info"]['termsOfService'] = 'http://genai-logic.com/terms'
+    
+    # Save filtered swagger to a temporary file
+    with tempfile.NamedTemporaryFile(delete=False, mode='w', suffix='.yaml') as tmp:
+        yaml.dump(swagger, tmp)
+        tmp_input_file = tmp.name
+    
+    # Call swagger2openapi to convert to OpenAPI 3
+    
+    subprocess.run([
+        'swagger2openapi',
+        tmp_input_file,
+        '-o', output_file,
+        '--yaml',
+    ], check=True)
+
+    os.remove(tmp_input_file)
+    print(f"Converted OpenAPI 3.0 spec written to: {output_file}")
+
+
+# Example usage
+if __name__ == "__main__":
+    
+    input_swagger_file = 'api_logic_server_cli/prototypes/nw_no_cust/integration/mcp/resources/nw_swagger_2.yaml'
+    output_openapi_file = 'api_logic_server_cli/prototypes/nw_no_cust/integration/mcp/resources/openapi_3.yaml'
+    # Choose which paths and methods to include
+    include = {
+        "/Customer/": ["get", "post"],
+        "/Order/": ["get"]
+    }
+
+    filter_swagger(input_swagger_file, output_openapi_file, include)

api_logic_server_cli/prototypes/basic_demo/customizations/integration/mcp/z_old/3_executor_test_agent.py

@@ -0,0 +1,52 @@
+import requests, json
+
+# MCP-style tool_context
+# does not like this pagination
+tool_context = {
+    "method": "GET",
+    "url": "http://localhost:5656/api/Customer",
+    "query_params": {
+        "filter[Country]": "Germany",
+        "page[limit]": 2
+    },
+    "headers": {
+        "Accept": "application/vnd.api+json"
+    }
+}
+
+tool_context = {  # use this for nw
+    "method": "GET",
+    "url": "http://localhost:5656/api/Customer",
+    "query_params": {
+        "filter[Country]": "Germany"
+    },
+    "headers": {
+        "Accept": "application/vnd.api+json"
+        , "Authorization": "Bearer your_token"
+    }
+}
+
+tool_context = {  # use this for genai_demo
+    "method": "GET",
+    "url": "http://localhost:5656/api/Customer",
+    "query_params": {
+        "filter[name]": "Alice"
+    },
+    "headers": {
+        "Accept": "application/vnd.api+json"
+        , "Authorization": "Bearer your_token"
+    }
+}
+
+# Execute as a simulated MCP executor
+response = requests.get(  # use this for genai_demo
+    tool_context["url"],
+    headers=tool_context["headers"],
+    params=tool_context["query_params"]
+)
+
+# Display result
+print(response.status_code)
+# Print the response, format it as JSON with indent
+print(json.dumps(response.json(), indent=4))
+

api_logic_server_cli/prototypes/basic_demo/customizations/integration/openai_function/3_executor_test_agent.py

@@ -0,0 +1,52 @@
+import requests, json
+
+# MCP-style tool_context
+# does not like this pagination
+tool_context = {
+    "method": "GET",
+    "url": "http://localhost:5656/api/Customer",
+    "query_params": {
+        "filter[Country]": "Germany",
+        "page[limit]": 2
+    },
+    "headers": {
+        "Accept": "application/vnd.api+json"
+    }
+}
+
+tool_context = {  # use this for nw
+    "method": "GET",
+    "url": "http://localhost:5656/api/Customer",
+    "query_params": {
+        "filter[Country]": "Germany"
+    },
+    "headers": {
+        "Accept": "application/vnd.api+json"
+        , "Authorization": "Bearer your_token"
+    }
+}
+
+tool_context = {  # use this for genai_demo
+    "method": "GET",
+    "url": "http://localhost:5656/api/Customer",
+    "query_params": {
+        "filter[name]": "Alice"
+    },
+    "headers": {
+        "Accept": "application/vnd.api+json"
+        , "Authorization": "Bearer your_token"
+    }
+}
+
+# Execute as a simulated MCP executor
+response = requests.get(  # use this for genai_demo
+    tool_context["url"],
+    headers=tool_context["headers"],
+    params=tool_context["query_params"]
+)
+
+# Display result
+print(response.status_code)
+# Print the response, format it as JSON with indent
+print(json.dumps(response.json(), indent=4))
+

api_logic_server_cli/prototypes/basic_demo/customizations/integration/openai_function/README_functon.md

@@ -0,0 +1,201 @@
+**OpenAI functions** are tools that extend the capabilities of ChatGPT by allowing it to access real-time data, perform actions, or connect with external services via APIs. .
+
+Instead of being limited to its pre-trained knowledge, ChatGPT can use plugins to retrieve up-to-date information (like live weather, stock prices, or databases) or perform tasks (like booking a flight or running a query). 
+
+The goal is to turn ChatGPT into a more useful, interactive assistant that can bridge AI language understanding with real-world actions and live data.   
+
+>For example, in large companies, it can be remarkably hard to find corporate systems via an Intranet, and use different user interfaces.  ChatGPT can simplify finding these, and interacting with Natural Language.
+
+This is to explore:
+
+| Explore                                    | Status               |
+| ------------------------------------------ | -------------------- |
+| Nat Lang ALS Access using OpenAI Functions | Initial Test Running |
+|                                            |                      |
+
+A value prop might be summarized: *instantly expose legacy DBs to Natural Language, including critical business logic and security, to simplify user discovery and operation.*
+
+<br>
+
+## Status: Technology Exploration
+
+This is an initial experiment, without automation.  Many substantive issues need to be addressed, including but not limited to security, update, etc.
+
+We welcome participation in this exploration.  Please contact us via [discord](https://discord.gg/HcGxbBsgRF).
+
+This exploration is changing rapidly.  For updates, replace `integration/mcp` from [integration/msp](https://github.com/ApiLogicServer/ApiLogicServer-src/tree/main/api_logic_server_cli/prototypes/nw_no_cust/integration/openai_plugin)
+
+<br>
+
+## Nat Lang ALS Access using OpenAI Plugin
+
+Requires tunnel to local host such as [ngrok](https://ngrok.com/downloads/mac-os?tab=download), then
+
+```
+ngrok config add-authtoken <obtain from https://dashboard.ngrok.com/get-started/setup/macos>
+```
+
+then start the tunnel
+
+```
+ngrok http 5656
+```
+
+You should see:
+
+![ngrok](https://github.com/ApiLogicServer/Docs/blob/main/docs/images/integration/mcp/ngrok.png?raw=true)
+
+and note the url like: `https://42da-2601-644-4900-etc.ngrok-free.app -> http://localhost:5656`
+
+We'll call it `tunnel_url`
+
+Enter this into `config/default.env`
+
+<br>
+
+### Use GenAI_Demo
+
+See `mcp/README_mcp.md`
+
+<br>
+
+### Obtain swagger_3
+
+This has already been done using the procedure described below.
+
+Obtain swagger 2 from API Logic Server, eg, http://localhost:5656/api/swagger.json) 
+
+Convert to 3: https://converter.swagger.io or other.
+
+<br>
+
+#### Reduce to 30 Operations
+
+Reduce down to 30 operations (genai_demo has 69).
+
+For testing, you can copy `integration/openai_plugin/swagger_3_genai_demo.json` or `integration/openai_plugin/nw-swagger_3.json` over `integration/openai_plugin/swagger_3.json`.
+
+This was obtained using ChatGPT with prompts like:
+
+1. Optionally collapse GET by ID and GET collection into a single endpoint using query params
+2. remove POST from relationship endpoints
+3. remove delete
+4. collapse relationship endpoints further
+
+then fix the result:
+
+1. ensure servers and paths is retained (got deleted for me), and includes https:
+2. version 3.1.0
+
+Still seeing (fix with Chat):
+
+```
+In path /Customer, method get is missing operationId; skipping
+In path /Customer, method post is missing operationId; skipping
+In path /Order, method get is missing operationId; skipping
+In path /Order, method post is missing operationId; skipping
+In path /Item, method get is missing operationId; skipping
+In path /Item, method post is missing operationId; skipping
+In path /Product, method get is missing operationId; skipping
+In path /Product, method post is missing operationId; skipping
+```
+
+<br>
+
+### Custom endpoint for openapi
+
+OpenAI requires a openai document, so observe the custom endpoint - `api/api_discovery/openapi` - eg, to test locally: `http://localhost:5656/api/openai.json`
+
+Note: the url for use in ChatGPT is the tunnelled version, from the env variable.
+
+<br>
+
+### Configure in ChatGPT
+
+Then, upload it to the **Web** version of ChatGPT: 
+
+1. Explore GPTs
+2. Create
+3. Configure
+4. Create New Action
+
+Provide the url of the openai endpoint:
+
+https://tunnel_url.ngrok-free.app/api/openapi.json
+
+<br>
+
+### Retrieval worked:
+
+- list customers
+- list the items of order 1 with their product names
+
+<br>
+
+### Update: Resoved, pending verification
+
+We also experimented with update, using `integration/openai_plugin/swagger_3.json`.
+
+> It initially failed to load, which we repaired as noted in Appendix 2.
+
+> It then failed to generate proper update API, evidently due to bad OpenAPI spec as noted in Appendix 3.
+
+<br>
+
+## Appendices
+
+<br>
+
+### Appendix 1: Create ai_plug_in.json
+
+We also looked at openai plugins.  These appear to be discontinued.
+
+Prepare `ai_plug_in.json` as shown in this directory.  Observe that it It identifies the url for finding the openapi through the tunnel.
+
+Note: both ALS and and `ai_plug_in.json` presume the swagger and api are consistent:
+
+- swagger is at `http://localhost:5656/api/swagger.json`, 
+- typical API at `http://localhost:5656/api/Category`
+
+Not required for function - **Settings / Beta / Plugins > Plugin install → expects the ai-plugin.json manifest URL**
+
+This appears to be unavailable for ChatGPT 4o
+
+<br>
+
+### Appendix 2: Updateable openapi
+
+It initially failed to load with
+
+```
+In context=('paths', '/Customer/{CustomerId}/', 'patch', 'requestBody', 'content', 'application/json', 'schema'), reference to unknown component Customer_inst; using empty schema
+
+In path /Customer/{CustomerId}/, method patch, operationId UpdateCustomer_0, request body schema is not an object schema; skipping
+
+In path /Customer/{CustomerId}/, method patch, operationId UpdateCustomer_0, skipping function due to errors
+```
+
+We requested a revised jasonapi from ChatGPT to clear these errors, which loaded.  
+
+<br>
+
+### Appendix 3: Invalid Data Object
+
+ This appears to be caused by improper JSON:API openAPI spec, which caused ChatGPT to generate an improper json PATCH payload:
+
+```python
+            chatgpt_request_json = {
+                        "credit_limit": 25000,
+            }
+            standard_request_json = {
+                "data": {
+                    "type": "Customer",
+                    "id": "ALFKI",
+                    "attributes": {
+                        "name": "Alice",
+                        "credit_limit": 25000,
+                        "balance": 12345
+                    }
+                }
+            }
+```