ioc-cfn-mas-client-lib 0.2.0__tar.gz

ioc_cfn_mas_client_lib-0.2.0/LICENSE.md

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

ioc_cfn_mas_client_lib-0.2.0/PKG-INFO

@@ -0,0 +1,473 @@
+Metadata-Version: 2.4
+Name: ioc-cfn-mas-client-lib
+Version: 0.2.0
+Summary: Python SDK client library for IoC Cognition Fabric Node Multi-Agent System
+Author-email: Outshift Open <oss@cisco.com>
+License: Apache-2.0
+Project-URL: Homepage, https://github.com/outshift-open/ioc-cfn-mas-client-lib
+Project-URL: Documentation, https://github.com/outshift-open/ioc-cfn-mas-client-lib/blob/main/README.md
+Project-URL: Repository, https://github.com/outshift-open/ioc-cfn-mas-client-lib
+Project-URL: Issues, https://github.com/outshift-open/ioc-cfn-mas-client-lib/issues
+Project-URL: Changelog, https://github.com/outshift-open/ioc-cfn-mas-client-lib/blob/main/CHANGELOG.md
+Keywords: ioc,cognition-fabric,mas,multi-agent-system,sdk,cfn
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE.md
+Requires-Dist: pydantic>=2.5
+Requires-Dist: urllib3>=1.26
+Requires-Dist: python-dateutil>=2.8
+Requires-Dist: typing-extensions>=4.7
+Requires-Dist: a2a-sdk[http-server]==0.3.26
+Requires-Dist: uvicorn>=0.44.0
+Requires-Dist: aiohttp>=3.8.0
+Requires-Dist: grpcio>=1.60
+Requires-Dist: grpcio-tools>=1.60
+Requires-Dist: xds-protos>=1.60
+Provides-Extra: dev
+Requires-Dist: pytest>=7.4; extra == "dev"
+Requires-Dist: pytest-cov>=4.1; extra == "dev"
+Requires-Dist: ruff>=0.4; extra == "dev"
+Requires-Dist: mypy>=1.8; extra == "dev"
+Requires-Dist: build>=1.0; extra == "dev"
+Requires-Dist: twine>=4.0; extra == "dev"
+Dynamic: license-file
+
+# Internet of Cognition (IOC) - Cognition Fabric Node (CFN) MAS Client Library
+
+[![PyPI version](https://badge.fury.io/py/ioc-cfn-mas-client-lib.svg)](https://badge.fury.io/py/ioc-cfn-mas-client-lib)
+[![Python 3.10+](https://img.shields.io/badge/python-3.10+-blue.svg)](https://www.python.org/downloads/)
+[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
+
+Python SDK client library for the Internet of Cognition (IoC) Cognition Fabric Node Multi-Agent System.
+
+## Overview
+
+This repository contains:
+
+- `src/ioc_cfn_mas_client/client.py`: a small, user\-facing `Client` wrapper\.
+- `src/generated/`: OpenAPI\-generated code \(implementation detail\)\. Avoid editing generated files directly\.
+
+## Installation
+
+**Requires Python >= 3.10**
+
+```bash
+pip install ioc-cfn-mas-client-lib
+```
+
+## Quick start
+
+Create a client using the CFN URL:
+
+```python
+from ioc_cfn_mas_client.client import Client
+
+client = Client(cfn_url="http://localhost:9002")
+```
+
+### Shared Memories API
+
+#### Create or update shared memories from trace data
+
+```python
+# Create memories from trace data (e.g., OpenTelemetry traces)
+trace_data = [
+    {
+        "TraceId": "trace-001",
+        "SpanId": "span-001",
+        "SpanName": "user_login",
+        "ServiceName": "auth-service",
+        "SpanAttributes": {"user_id": "user123"},
+        "Duration": 150
+    }
+]
+
+response = client.create_shared_memories(
+    workspace_id="your_workspace_id",
+    mas_id="your_mas_id",
+    data=trace_data,
+    format="observe-sdk-otel",  # or "openclaw"
+    agent_id="your_agent_id",  # Optional
+)
+```
+
+#### Query shared memories with natural language
+
+```python
+# Query memories using natural language intent
+results = client.query_shared_memories(
+    workspace_id="your_workspace_id",
+    mas_id="your_mas_id",
+    intent="Find information about user login events",
+    agent_id="your_agent_id",
+    additional_context=[{"context": "prior conversation"}],  # Optional
+)
+```
+
+### Memory Operations API (Proxy to Remote Providers)
+
+Forward memory operations to remote providers like Mem0 or Graphiti:
+
+```python
+# GET memories from remote provider
+response = client.memory_operation(
+    workspace_id="your_workspace_id",
+    mas_id="your_mas_id",
+    agent_id="your_agent_id",
+    http_method="GET",
+    http_url="v1/memories/?user_id=test-user",
+)
+
+# POST memories to remote provider
+response = client.memory_operation(
+    workspace_id="your_workspace_id",
+    mas_id="your_mas_id",
+    agent_id="your_agent_id",
+    http_method="POST",
+    http_url="/v1/memories/",
+    http_body={
+        "messages": [{"role": "user", "content": "I prefer dark mode"}],
+        "user_id": "test-user"
+    },
+)
+```
+
+### Semantic Alignment API
+
+Run multi\-agent alignment sessions:
+
+```python
+# Start a alignment session
+response = client.start_alignment(
+    workspace_id="your_workspace_id",
+    mas_id="your_mas_id",
+    session_id="session-123",
+    agents=[
+        {"id": "agent1", "name": "Planner Agent"},
+        {"id": "agent2", "name": "Executor Agent"}
+    ],
+    content_text="Plan a deployment strategy",
+    n_steps=10,  # Optional, defaults to 20
+)
+
+# Advance alignment with agent replies
+response = client.advance_alignment(
+    workspace_id="your_workspace_id",
+    mas_id="your_mas_id",
+    session_id="session-123",
+    agent_replies=[
+        {
+            "agent_id": "agent1",
+            "action": "counter_offer",
+            "offer": {"strategy": "blue-green deployment"}
+        },
+        {
+            "agent_id": "agent2",
+            "action": "accept"
+        }
+    ],
+)
+```
+
+### Google A2A Protocol Integration
+
+Use `A2AInstrumentor` to automatically track all A2A agents without decorators (monkey patching approach):
+
+```python
+from ioc_cfn_mas_client import Client, A2AInstrumentor
+from a2a.server.agent_execution import AgentExecutor
+
+client = Client(cfn_url="http://localhost:9002")
+
+# One-time setup - instruments ALL AgentExecutor classes automatically
+instrumentor = A2AInstrumentor(
+    client=client,
+    workspace_id="my-workspace",
+    mas_id="my-mas",
+    publish_input=True,   # Publish incoming A2A messages
+    publish_output=True,  # Publish task results
+)
+instrumentor.instrument()
+
+# Now ALL agents are automatically tracked - no decorators needed!
+class MyA2AAgent(AgentExecutor):
+    async def execute(self, context, event_queue):
+        """Execute agent - automatically published to CFN."""
+        # Your A2A agent logic here
+        # All interactions automatically saved to CFN shared memory
+        pass
+```
+
+
+
+**Key Features:**
+
+- **Zero code changes** - works with any A2A agent
+- Automatic publishing of A2A messages to CFN shared memory
+- Uses monkey patching (similar to OpenTelemetry auto-instrumentation)
+- Preserves A2A protocol structure (messages, tasks, artifacts)
+- Can be enabled/disabled globally with `uninstrument()`
+
+For detailed documentation, see [docs/A2A_INTEGRATION.md](docs/A2A_INTEGRATION.md).
+
+**Example:**
+
+```bash
+# Terminal 1 - Start Agent B server
+uv run python examples/instrumentation/a2a/multi_agent_example.py --server
+
+# Terminal 2 - Run Agent A client
+uv run python examples/instrumentation/a2a/multi_agent_example.py --client
+```
+
+See [examples/instrumentation/a2a/multi_agent_example.py](examples/instrumentation/a2a/multi_agent_example.py) for the complete code, and [examples/instrumentation/README.md](examples/instrumentation/README.md) for more details.
+
+### MCP Client Integration
+
+Use the MCP (Model Context Protocol) client methods integrated into the main Client class:
+
+```python
+from ioc_cfn_mas_client import Client
+
+# Initialize client with MCP server URL
+client = Client(cfn_url="http://localhost:9001")
+
+# Retain shared memories using MCP-style interface
+result = await client.retain(
+    workspace_id="my-workspace",
+    mas_id="my-mas",
+    payload={
+        "metadata": {"format": "openclaw"},
+        "data": [{"example": "conversation data"}]
+    },
+    agent_id="my-agent"
+)
+print(f"Retain result: {result['status']}")
+
+# Recall shared memories using natural language intent
+result = await client.recall(
+    workspace_id="my-workspace",
+    mas_id="my-mas",
+    intent="Find information about user preferences",
+    search_strategy="semantic_graph_traversal",
+    agent_id="my-agent"
+)
+print(f"Recall result: {result['message']}")
+```
+
+**Key Features:**
+
+- **Integrated MCP Methods** - `retain()` and `recall()` methods built into the main Client class
+- **Mock Responses** - Returns structured mock data for testing without live MCP server
+- **OpenClaw Format** - Supports conversation data for retain operations
+- **Natural Language Queries** - Use intent-based queries for recall operations
+- **Semantic Search** - Built-in semantic graph traversal for memory retrieval
+
+**Examples:**
+
+```bash
+# Run the MCP client example demonstrating retain/recall methods
+uv run python examples/mcp/client_example.py
+
+# For direct MCP protocol testing (advanced users):
+uv run python -m src.ioc_cfn_mas_client.mcp.mcp_client_sample --operation list_tools
+uv run python -m src.ioc_cfn_mas_client.mcp.mcp_client_sample --operation retain
+uv run python -m src.ioc_cfn_mas_client.mcp.mcp_client_sample --operation recall
+```
+
+For complete examples and implementation details, see [examples/mcp/client_example.py](examples/mcp/client_example.py) and [src/ioc_cfn_mas_client/mcp/](src/ioc_cfn_mas_client/mcp/).
+
+### A2A Sidecar Proxy Pattern (Production - ZTA Approach with Istio)
+
+For production deployments, use the **Envoy-based sidecar** following the **ZTA (Zero Trust Architecture)** pattern with **Istio service mesh**. This provides **truly transparent** interception with zero agent configuration.
+
+**Prerequisites:** Istio must be installed in your Kubernetes cluster.
+
+```
+┌──────────────────────────────────────┐
+│        Kubernetes Pod                │
+│                                      │
+│  Agent (UNCHANGED) → Istio/iptables  │
+│         ↓                            │
+│      Envoy Proxy                     │
+│         ↓                            │
+│   ext_authz (A2A Parser)             │
+│         ↓                            │
+│   Logs/CFN API                       │
+└──────────────────────────────────────┘
+```
+
+**Quick Start:**
+
+```bash
+# 1. Build ext-authz image (Istio approach)
+docker build -t ext-authz-only:latest -f sidecar/istio/Dockerfile .
+
+# 2. Apply EnvoyFilter to Kubernetes (requires Istio)
+kubectl apply -f sidecar/istio/envoy-filter.yaml
+
+# 3. Deploy your agent with ext-authz sidecar container
+# See examples/sidecar/k8s/ for complete manifests
+
+# 4. That's it! Agent is completely agnostic - no changes needed!
+```
+
+**Key Features:**
+
+- **✅ Truly agnostic** - zero code changes, zero configuration changes
+- **✅ Istio-based** - automatic sidecar injection and iptables setup
+- **✅ Production-ready** - uses Istio service mesh
+- **✅ Language agnostic** - works with any HTTP client (Python, Go, Node.js, Java, Rust, etc.)
+- **✅ High performance** - Envoy proxy (50K+ req/s)
+- **✅ Protocol-aware** - parses A2A messages (JSON-RPC 2.0)
+
+**Architecture:**
+
+- **Istio**: Automatic sidecar injection and traffic interception
+- **Envoy Proxy**: C++ high-performance proxy for traffic interception
+- **ext_authz Service**: Python gRPC service for A2A message parsing
+
+**Documentation:**
+
+- [Sidecar README](sidecar/README.md) - Complete implementation guide
+- [Working Demo](examples/sidecar/) - End-to-end example with Istio
+- [ZTA Implementation Summary](docs/ZTA_IMPLEMENTATION_SUMMARY.md) - Architecture details
+- [Transparent Interception Guide](docs/TRANSPARENT_INTERCEPTION.md) - How iptables works
+
+**Comparison with Monkey-Patching:**
+
+| Feature | Envoy Sidecar (ZTA) | Monkey-Patching |
+|---------|---------------------|-----------------|
+| **Agent Code** | ✅ Unchanged | ⚠️ One instrumentation call |
+| **Agent Config** | ✅ Unchanged | ✅ Unchanged |
+| **Languages** | Any (Python, Go, Node.js, Java, etc.) | Python only |
+| **Performance** | 50K+ req/s | Minimal overhead |
+| **Production** | ✅ Recommended | Development only |
+| **Platform** | Kubernetes | Any |
+| **Isolation** | Strong (separate process) | Weak (same process) |
+
+**Recommendation:** Use **Envoy sidecar for production** (truly agnostic, language-independent), **monkey-patching for development/testing** (quick setup, Python-only).
+
+### Advanced Usage
+
+For power users who need direct access to the generated OpenAPI clients:
+
+```python
+# Access the underlying API clients
+shared_memories_api = client.shared_memories_api
+memory_operations_api = client.memory_operations_api
+semantic_alignment_api = client.semantic_alignment_api
+
+# Use generated methods directly
+response = shared_memories_api.api_workspaces_workspace_id_multi_agentic_systems_mas_id_shared_memories_post_with_http_info(...)
+```
+
+For a complete example, see `examples/example.py`\.
+
+## Configuration
+
+The `Client` constructor accepts the following parameters:
+
+- `cfn_url` \(required\): CFN API endpoint URL \(e\.g\., `http://localhost:9002`\)
+- `timeout` \(optional\): Request timeout in seconds
+- `configuration` \(optional\): Pre\-configured Configuration object \(for advanced users\)
+- `api_client` \(optional\): Pre\-configured ApiClient object \(for advanced users\)
+
+### Environment variables
+
+Optional environment variable:
+
+- `CFN_URL`: CFN API endpoint URL \(defaults to `http://localhost:9002` if not set\)
+
+## Development (macOS)
+
+Using `uv`:
+
+```bash
+uv venv
+source .venv/bin/activate
+uv pip install -e ".[dev]"
+
+# Run tests
+uv run pytest
+
+# Run examples
+uv run python examples/example.py
+```
+
+## OpenAPI SDK generation
+
+- **OpenAPI spec source**: [ioc-cfn-svc public-api-v1.1.yaml](https://github.com/outshift-open/ioc-cfn-svc/blob/main/docs/public-api/public-api-v1.1.yaml)
+- **Local spec**: `openapi/public-api-v1.1.yaml` (copied from source)
+- **Generated output**: `src/generated/`
+
+### Prerequisites
+
+**Docker** (required):
+
+```bash
+docker pull openapitools/openapi-generator-cli
+```
+
+Or use the make target:
+
+```bash
+make pull-openapi-generator
+```
+
+### Generate
+
+```bash
+make gen-openapi
+```
+
+This regenerates `src/generated/` from `openapi/public-api-v1.1.yaml` using Docker.
+
+**Important**: After regenerating, add copyright/license headers to the generated files:
+
+```bash
+make add-headers-generated
+```
+
+This adds Apache 2.0 license headers to all generated Python files to maintain OSPO compliance.
+
+**Note**: The spec follows Python naming conventions (snake_case for methods/fields, PascalCase for classes). See [ioc-cfn-svc public API docs](https://github.com/outshift-open/ioc-cfn-svc/tree/main/docs/public-api) for details.
+
+### Updating the spec
+
+To update to a newer version:
+
+1. Copy the latest spec from ioc-cfn-svc:
+
+   ```bash
+   cp /path/to/ioc-cfn-svc/docs/public-api/public-api-v1.1.yaml openapi/
+   ```
+
+2. Regenerate:
+
+   ```bash
+   make gen-openapi
+   ```
+
+3. Update `client.py` if the API surface changed\.
+
+## License
+
+This project is licensed under the Apache License, Version 2.0 - see the [LICENSE.md](LICENSE.md) file for full details.
+
+Copyright (c) 2024-2026 Cisco Systems, Inc. and its affiliates. All rights reserved.
+
+Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at:
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.