feat: update to v0.2 ACP spec (#41)

* chore: restore code to add manifest spec version to package.

* fix: add prereqs for docs and fix typo.

* chore: update submodule versions

* chore: update client to v0.2 ACP specification

* fix: deleted files from previous version

* fix: updated generator to match spec. used fixed spec to regenerate clients.

* chore: updated clients to support api key auth from spec.

* fix: updated version to dev

* feat: remove security scheme from ACP spec and move to ACP SDK objects to support workflow server API key.

* chore: remove unneeded imports.

* chore: bump version for dev

* fix: updated to latest 0.2.1 ACP spec.

* chore: remove dev suffix from version and handle dev publishing entirely with tags.

* chore: bump version to reflect new spec.

* fix: address bug in sed command.

* fix: working on sed command.

* chore: add exceptions to package import.

* fix: remove stale type

* fix: add back code deleted in error.

* fix: update property name to conform to 0.2

* fix: get values for output because typing does not work.

* fix: handle workflow server return values correctly. Added unit test for LangGraph ACPNode integration.

* chore: bump version. Fix docstring and remove extra file.

* fix: added project URLs for pypi.

Author: jnapper7

.github/workflows/pypi.yml

@@ -43,15 +43,21 @@ jobs:
         env:
           TAG_NAME: ${{ github.ref_name }}
         run: |
-          TAG="${TAG_NAME##v}"
+          TAG="${TAG_NAME#v}"
           PYPROJECT_VERSION=$(awk '/version/ { gsub("\"", ""); print $3; exit; }' pyproject.toml)
       
-          if [ ! "${PYPROJECT_VERSION}" = "${TAG}" ]; then
+          if [ ! "${PYPROJECT_VERSION}" = "${TAG%.dev*}" ]; then
               echo "You created the \"${{ github.ref_name }}\" git tag; it is fine, BUT it does not match the pyproject.toml file"
               exit 1
           fi
 
-          echo "Building and publishing version: ${PYPROJECT_VERSION}" >> $GITHUB_STEP_SUMMARY
+          # Update version to match in case it is a dev version
+          if [ ! "${TAG%.dev*}" = "${TAG}" ]; then
+            sed "s/version = \"${TAG%.dev*}\"/version = \"${TAG}\"/" pyproject.toml >pyproject.toml.bak \
+              && mv pyproject.toml.bak pyproject.toml
+          fi
+
+          echo "Building and publishing version: ${TAG}" >> $GITHUB_STEP_SUMMARY
 
       - name: Build package
         env:

Makefile

@@ -11,7 +11,7 @@ install:
 ACP_SPEC_DIR=acp-spec
 ACP_CLIENT_DIR:=acp-sync-client-generated
 ACP_SUBPACKAGE_PREFIX=acp_v
-ACP_SPEC_FILE:=$(ACP_SPEC_DIR)/openapi.yaml
+ACP_SPEC_FILE:=$(ACP_SPEC_DIR)/openapi.json
 GEN_ACP_SYNC_PACKAGE_PREFIX:=acp_client_v
 SDK_ACP_SYNC_PACKAGE_NAME:=sync_client
 
@@ -21,7 +21,7 @@ $(ACP_SPEC_FILE):
 # Generate client and correct models for convenience.
 generate_acp_client $(ACP_CLIENT_DIR)/README.md : $(ACP_SPEC_FILE)
 	export SPEC_FILE="$(ACP_SPEC_FILE)" ; \
-	export SPEC_VERSION=$$(yq '.info.version | sub("\.\d+", "")' "$${SPEC_FILE}") ; \
+	SPEC_VERSION=$$(jq -r '.info.version | capture("(?<version>\\d+)\\.\\d+"; "") | .version' "$${SPEC_FILE}") ; \
 	export CLIENT_DIR="$(ACP_CLIENT_DIR)" ; \
 	export GEN_PACKAGE_NAME="$(GEN_ACP_SYNC_PACKAGE_PREFIX)$${SPEC_VERSION}" ; \
 	export SDK_SUBPACKAGE_NAME="agntcy_acp.$(ACP_SUBPACKAGE_PREFIX)$${SPEC_VERSION}" ; \
@@ -42,7 +42,7 @@ SDK_ACP_ASYNC_PACKAGE_NAME:=async_client
 
 generate_acp_async_client $(ACP_ASYNC_CLIENT_DIR)/README.md : $(ACP_SPEC_FILE)
 	export SPEC_FILE="$(ACP_SPEC_FILE)" ; \
-	export SPEC_VERSION=$$(yq '.info.version | sub("\.\d+", "")' "$${SPEC_FILE}") ; \
+	SPEC_VERSION=$$(jq -r '.info.version | capture("(?<version>\\d+)\\.\\d+"; "") | .version' "$${SPEC_FILE}") ; \
 	export CLIENT_DIR="$(ACP_ASYNC_CLIENT_DIR)" ; \
 	export GEN_PACKAGE_NAME="$(GEN_ACP_ASYNC_PACKAGE_PREFIX)$${SPEC_VERSION}" ; \
 	export SDK_SUBPACKAGE_NAME="agntcy_acp.$(ACP_SUBPACKAGE_PREFIX)$${SPEC_VERSION}" ; \
@@ -64,17 +64,22 @@ $(AGNT_WKFW_SPEC_FILE):
 	git submodule update $(AGENT_WORKFLOW_DIR)
 
 generate_manifest_models: $(AGNT_WKFW_SPEC_FILE)
-	ACP_SPEC_VERSION=$$(yq '.info.version | sub("\.\d+", "")' $(AGNT_WKFW_SPEC_FILE)) ; \
+	ACP_SPEC_VERSION=$$(yq '.info.version | sub("\.\d+", "")' "$(AGNT_WKFW_SPEC_FILE)") ; \
 	AGNT_WKFW_MODEL_PACKAGE_DIR="agntcy_acp/agws_v$${ACP_SPEC_VERSION}" ; \
+	{ mkdir "$${AGNT_WKFW_MODEL_PACKAGE_DIR}" || true ; } ; \
 	poetry run datamodel-codegen \
 		--input $(AGNT_WKFW_SPEC_FILE) \
 		--input-file-type openapi \
 		--output-model-type pydantic_v2.BaseModel \
 		--output "$${AGNT_WKFW_MODEL_PACKAGE_DIR}"/models.py \
-		--disable-timestamp
+		--disable-timestamp && \
+	cp .spdx_header "$${AGNT_WKFW_MODEL_PACKAGE_DIR}/spec_version.py" && \
+	echo VERSION="\""$$(yq '.info.version' "$(AGNT_WKFW_SPEC_FILE)")"\"" >>"$${AGNT_WKFW_MODEL_PACKAGE_DIR}/spec_version.py" && \
+	echo MAJOR_VERSION="\"$${ACP_SPEC_VERSION}\"" >>"$${AGNT_WKFW_MODEL_PACKAGE_DIR}/spec_version.py" && \
+	echo MINOR_VERSION="\""$$(yq '.info.version | sub("\d+\.", "")' "$(AGNT_WKFW_SPEC_FILE)")"\"" >>"$${AGNT_WKFW_MODEL_PACKAGE_DIR}/spec_version.py"
 
 update_python_subpackage: $(ACP_CLIENT_DIR)/README.md $(ACP_ASYNC_CLIENT_DIR)/README.md
-	ACP_SPEC_VERSION=$$(yq '.info.version | sub("\.\d+", "")' $(ACP_SPEC_FILE)) ; \
+	ACP_SPEC_VERSION=$$(jq -r '.info.version | capture("(?<version>\\d+)\\.\\d+"; "") | .version' $(ACP_SPEC_FILE)) ; \
 	ACP_CLIENT_PACKAGE_DIR="$(ACP_CLIENT_DIR)/$(GEN_ACP_SYNC_PACKAGE_PREFIX)$${ACP_SPEC_VERSION}" ; \
 	ACP_ASYNC_CLIENT_PACKAGE_DIR="$(ACP_ASYNC_CLIENT_DIR)/$(GEN_ACP_ASYNC_PACKAGE_PREFIX)$${ACP_SPEC_VERSION}" ; \
 	cp -pR "$${ACP_CLIENT_PACKAGE_DIR}/__init__.py" \
@@ -91,7 +96,7 @@ update_python_subpackage: $(ACP_CLIENT_DIR)/README.md $(ACP_ASYNC_CLIENT_DIR)/RE
 	cp -pR "$${ACP_ASYNC_CLIENT_PACKAGE_DIR}/api" \
 		"$${ACP_ASYNC_CLIENT_PACKAGE_DIR}/api_client.py" \
 		"$${ACP_ASYNC_CLIENT_PACKAGE_DIR}/rest.py" \
-		"agntcy_acp/$(ACP_SUBPACKAGE_PREFIX)$${ACP_SPEC_VERSION}/$(SDK_ACP_ASYNC_PACKAGE_NAME)/" && \
+		"agntcy_acp/$(ACP_SUBPACKAGE_PREFIX)$${ACP_SPEC_VERSION}/$(SDK_ACP_ASYNC_PACKAGE_NAME)/"
 
 update_docs: $(ACP_CLIENT_DIR)/README.md $(ACP_ASYNC_CLIENT_DIR)/README.md
 	cp -p "$(ACP_CLIENT_DIR)"/docs/*.md docs/models/ && \

acp-spec

@@ -4,11 +4,13 @@
 from os import getenv
 from typing import Optional, Any, Dict, Union
 
-from .acp_v0.sync_client import ApiClient, AgentsApi, RunsApi, ThreadsApi
-from .acp_v0.async_client import AgentsApi as AsyncAgentsApi
-from .acp_v0.async_client import RunsApi as AsyncRunsApi
-from .acp_v0.async_client import ThreadsApi as AsyncThreadsApi
-from .acp_v0.async_client import ApiClient as AsyncApiClient
+from .acp_v0.sync_client.api_client import ApiClient
+from .acp_v0.sync_client.api import AgentsApi, ThreadsApi, StatelessRunsApi, ThreadRunsApi
+from .acp_v0.async_client.api import AgentsApi as AsyncAgentsApi
+from .acp_v0.async_client.api import StatelessRunsApi as AsyncStatelessRunsApi
+from .acp_v0.async_client.api import ThreadsApi as AsyncThreadsApi
+from .acp_v0.async_client.api import ThreadRunsApi as AsyncThreadRunsApi
+from .acp_v0.async_client.api_client import ApiClient as AsyncApiClient
 from .acp_v0 import ApiResponse
 from .acp_v0 import Configuration
 from .acp_v0.configuration import ServerVariablesT
@@ -26,19 +28,44 @@
     ApiKeyError,
     ApiAttributeError,
     ApiException,
+    BadRequestException,
+    NotFoundException,
+    UnauthorizedException,
+    ForbiddenException,
+    ServiceException,
+    ConflictException,
+    UnprocessableEntityException,
 )
 
-class ACPClient(AgentsApi, RunsApi, ThreadsApi):
+class ACPClient(AgentsApi, StatelessRunsApi, ThreadsApi, ThreadRunsApi):
     """Client for ACP API.
     """
     def __init__(self, api_client: Optional[ApiClient] = None):
         super().__init__(api_client)
+        self.__workflow_server_update_api_client()
 
-class AsyncACPClient(AsyncAgentsApi, AsyncRunsApi, AsyncThreadsApi):
+    def __workflow_server_update_api_client(self):
+        if self.api_client.configuration.api_key is not None:
+            # Check for 'x-api-key' config and move to header.
+            try:
+                self.api_client.default_headers['x-api-key'] = self.api_client.configuration.api_key['x-api-key']
+            except KeyError:
+                pass # ignore
+
+class AsyncACPClient(AsyncAgentsApi, AsyncStatelessRunsApi, AsyncThreadsApi, AsyncThreadRunsApi):
     """Async client for ACP API.
     """
     def __init__(self, api_client: Optional[AsyncApiClient] = None):
         super().__init__(api_client)
+        self.__workflow_server_update_api_client()
+    
+    def __workflow_server_update_api_client(self):
+        if self.api_client.configuration.api_key is not None:
+            # Check for 'x-api-key' config and move to header.
+            try:
+                self.api_client.default_headers['x-api-key'] = self.api_client.configuration.api_key['x-api-key']
+            except KeyError:
+                pass # ignore
 
 __ENV_VAR_SPECIAL_CHAR_TABLE = str.maketrans("-.", "__")
 
@@ -73,6 +100,7 @@ class ApiClientConfiguration(Configuration):
     :param ca_cert_data: verify the peer using concatenated CA certificate data
       in PEM (str) or DER (bytes) format.
     :param debug: Debug switch.
+
     """
     def __init__(
         self, 
@@ -115,12 +143,13 @@ def fromEnvPrefix(
         debug: Optional[bool] = None,
     ) -> "ApiClientConfiguration":
         """Construct a configuration object using environment variables as
-        default source of parameter values.
+        default source of parameter values. For example, with env_var_prefix="MY_", 
+        the default host parameter value would be looked up in the "MY_HOST" 
+        environment variable if not provided.
 
         :param env_var_prefix: String used as prefix for environment variable 
-        names. For example, with env_var_prefix="MY_", the default host parameter
-        value would be looked up in the "MY_HOST" environment variable if not
-        provided.
+          names.
+
         :return: Configuration object
         :rtype: ApiClientConfiguration
         """
@@ -196,6 +225,13 @@ def fromEnvPrefix(
     "ApiKeyError",
     "ApiAttributeError",
     "ApiException",
+    "BadRequestException",
+    "NotFoundException",
+    "UnauthorizedException",
+    "ForbiddenException",
+    "ServiceException",
+    "ConflictException",
+    "UnprocessableEntityException",
     "ACP_VERSION",
     "ACP_MAJOR_VERSION",
     "ACP_MINOR_VERSION",

agntcy_acp/__init__.py

@@ -9,7 +9,7 @@
 
     No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
 
-    The version of the OpenAPI document: 0.1
+    The version of the OpenAPI document: 0.2.1
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 
     Do not edit the class manually.
@@ -20,7 +20,8 @@
 
 # import apis into sdk package
 from agntcy_acp.acp_v0.sync_client.api.agents_api import AgentsApi
-from agntcy_acp.acp_v0.sync_client.api.runs_api import RunsApi
+from agntcy_acp.acp_v0.sync_client.api.stateless_runs_api import StatelessRunsApi
+from agntcy_acp.acp_v0.sync_client.api.thread_runs_api import ThreadRunsApi
 from agntcy_acp.acp_v0.sync_client.api.threads_api import ThreadsApi
 
 # import ApiClient
@@ -43,19 +44,37 @@
 from agntcy_acp.acp_v0.models.agent_metadata import AgentMetadata
 from agntcy_acp.acp_v0.models.agent_ref import AgentRef
 from agntcy_acp.acp_v0.models.agent_search_request import AgentSearchRequest
+from agntcy_acp.acp_v0.models.config import Config
+from agntcy_acp.acp_v0.models.content import Content
+from agntcy_acp.acp_v0.models.content_one_of_inner import ContentOneOfInner
 from agntcy_acp.acp_v0.models.custom_run_result_update import CustomRunResultUpdate
+from agntcy_acp.acp_v0.models.message import Message
+from agntcy_acp.acp_v0.models.message_any_block import MessageAnyBlock
+from agntcy_acp.acp_v0.models.message_text_block import MessageTextBlock
 from agntcy_acp.acp_v0.models.run import Run
 from agntcy_acp.acp_v0.models.run_create import RunCreate
+from agntcy_acp.acp_v0.models.run_create_stateful import RunCreateStateful
+from agntcy_acp.acp_v0.models.run_create_stateless import RunCreateStateless
 from agntcy_acp.acp_v0.models.run_error import RunError
 from agntcy_acp.acp_v0.models.run_interrupt import RunInterrupt
 from agntcy_acp.acp_v0.models.run_output import RunOutput
 from agntcy_acp.acp_v0.models.run_output_stream import RunOutputStream
 from agntcy_acp.acp_v0.models.run_result import RunResult
 from agntcy_acp.acp_v0.models.run_search_request import RunSearchRequest
+from agntcy_acp.acp_v0.models.run_stateful import RunStateful
+from agntcy_acp.acp_v0.models.run_stateless import RunStateless
 from agntcy_acp.acp_v0.models.run_status import RunStatus
+from agntcy_acp.acp_v0.models.run_wait_response_stateful import RunWaitResponseStateful
+from agntcy_acp.acp_v0.models.run_wait_response_stateless import RunWaitResponseStateless
 from agntcy_acp.acp_v0.models.stream_event_payload import StreamEventPayload
+from agntcy_acp.acp_v0.models.stream_mode import StreamMode
 from agntcy_acp.acp_v0.models.streaming_mode import StreamingMode
 from agntcy_acp.acp_v0.models.streaming_modes import StreamingModes
 from agntcy_acp.acp_v0.models.thread import Thread
+from agntcy_acp.acp_v0.models.thread_checkpoint import ThreadCheckpoint
 from agntcy_acp.acp_v0.models.thread_create import ThreadCreate
+from agntcy_acp.acp_v0.models.thread_patch import ThreadPatch
 from agntcy_acp.acp_v0.models.thread_search_request import ThreadSearchRequest
+from agntcy_acp.acp_v0.models.thread_state import ThreadState
+from agntcy_acp.acp_v0.models.thread_status import ThreadStatus
+from agntcy_acp.acp_v0.models.value_run_result_update import ValueRunResultUpdate

agntcy_acp/acp_v0/__init__.py

@@ -4,6 +4,7 @@
 
 # import apis into api package
 from agntcy_acp.acp_v0.async_client.api.agents_api import AgentsApi
-from agntcy_acp.acp_v0.async_client.api.runs_api import RunsApi
+from agntcy_acp.acp_v0.async_client.api.stateless_runs_api import StatelessRunsApi
+from agntcy_acp.acp_v0.async_client.api.thread_runs_api import ThreadRunsApi
 from agntcy_acp.acp_v0.async_client.api.threads_api import ThreadsApi
 

agntcy_acp/acp_v0/async_client/__init__.py

@@ -7,7 +7,7 @@
 
     No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
 
-    The version of the OpenAPI document: 0.1
+    The version of the OpenAPI document: 0.2.1
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 
     Do not edit the class manually.
@@ -365,7 +365,6 @@ async def get_agent_by_id(
         _response_types_map: Dict[str, Optional[str]] = {
             '200': "Agent",
             '404': "str",
-            '422': "str",
         }
         response_data = await self.api_client.call_api(
             *_param,
@@ -434,7 +433,6 @@ async def get_agent_by_id_with_http_info(
         _response_types_map: Dict[str, Optional[str]] = {
             '200': "Agent",
             '404': "str",
-            '422': "str",
         }
         response_data = await self.api_client.call_api(
             *_param,
@@ -503,7 +501,6 @@ async def get_agent_by_id_without_preload_content(
         _response_types_map: Dict[str, Optional[str]] = {
             '200': "Agent",
             '404': "str",
-            '422': "str",
         }
         response_data = await self.api_client.call_api(
             *_param,