cadenya 0.23.0 → 0.25.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 88a495d13fa3197bd62108f4a356f43b3dc8d8b280f6a11584afd3484fbb0135
-  data.tar.gz: 7cd25a4bbea3d69c830e18e2f61db051165da239d5d41d0c9547b426ea166aa9
+  metadata.gz: 85a23df17834062235e1de7898d6d6c30f688f8a42a0cb899446c44b860625cf
+  data.tar.gz: fb33b235dc855b0bf55c8ef4a968db692d3a06f652997d9c572a00627c7c544a
 SHA512:
-  metadata.gz: b2f73a4957a9e5f1adcf9b8f51b9a39223a4cf1bc9e8c721c4c4d7ace807ce1eb73acc57cba38847967b99211b87726f1ca625b0ddfeeb140a3526851bfbb7da
-  data.tar.gz: 8974859e7ae5d2035635ea7f0ea5a3c843cafd2f71b0efae359af83572b73402a81b4d683b306db724fc3b65beecd44eb1b50705f57bef1116f54ff63515ce82
+  metadata.gz: c8439ad320e591096765d4ea8b9a4537999afc841fcbf55b4ff0d6e09c5f9693f8faf48eadd8f373a56aa805c80347bab004b64db484f81a2498bd8efd605a8d
+  data.tar.gz: e65efdeaabac43576f78ad4e2f32c96de41cd4674679eeffaa815c7222de795b34f3b758b40137da6302aabee78b0efe0ac2f2dc918fd33abd75866fa90e6efa

data/CHANGELOG.md

@@ -1,5 +1,21 @@
 # Changelog
 
+## 0.25.0 (2026-07-02)
+
+Full Changelog: [v0.24.0...v0.25.0](https://github.com/cadenya/cadenya-ruby/compare/v0.24.0...v0.25.0)
+
+### Features
+
+* **api:** api update ([9adf4ad](https://github.com/cadenya/cadenya-ruby/commit/9adf4adeaf93b4774163acaad8ad941d55e6e3d0))
+
+## 0.24.0 (2026-07-01)
+
+Full Changelog: [v0.23.0...v0.24.0](https://github.com/cadenya/cadenya-ruby/compare/v0.23.0...v0.24.0)
+
+### Features
+
+* **api:** api update ([2dc6e63](https://github.com/cadenya/cadenya-ruby/commit/2dc6e631c0c63392b148ea3458ce560593bcf27a))
+
 ## 0.23.0 (2026-07-01)
 
 Full Changelog: [v0.22.0...v0.23.0](https://github.com/cadenya/cadenya-ruby/compare/v0.22.0...v0.23.0)

data/README.md

@@ -17,7 +17,7 @@ To use this gem, install via Bundler by adding the following to your application
 <!-- x-release-please-start-version -->
 
 ```ruby
-gem "cadenya", "~> 0.23.0"
+gem "cadenya", "~> 0.25.0"
 ```
 
 <!-- x-release-please-end -->

data/lib/cadenya/models/ai_provider_key_spec.rb

@@ -3,20 +3,23 @@
 module Cadenya
   module Models
     class AIProviderKeySpec < Cadenya::Internal::Type::BaseModel
-      # @!attribute api_key
-      #   The provider credential. Accepted on create/update; never populated in responses
-      #   (the server returns an empty value to avoid leaking it).
+      # @!attribute config
+      #   AIProviderConfig holds non-secret, provider-specific settings. The set case must
+      #   correspond to AIProviderKeySpec.provider. Providers with no settings (Anthropic,
+      #   Gemini) simply leave this unset. The endpoint of a named provider is fixed and
+      #   intentionally not overridable here; use the OpenAI-compatible provider to target
+      #   a custom endpoint.
       #
-      #   @return [String, nil]
-      optional :api_key, String, api_name: :apiKey
+      #   @return [Cadenya::Models::AIProviderKeySpec::Config, nil]
+      optional :config, -> { Cadenya::AIProviderKeySpec::Config }
 
-      # @!attribute openrouter
-      #   OpenRouterConfig holds OpenRouter-specific settings. Empty for now; it exists as
-      #   the oneof seam so provider-specific options (region, base URL, etc.) can be
-      #   added later without restructuring the spec.
+      # @!attribute credentials
+      #   AIProviderCredential is the secret material used to authenticate with a
+      #   provider. The set case must correspond to AIProviderKeySpec.provider. The server
+      #   encrypts the serialized message at rest and never returns it on reads.
       #
-      #   @return [Object, nil]
-      optional :openrouter, Cadenya::Internal::Type::Unknown
+      #   @return [Cadenya::Models::AIProviderKeySpec::Credentials, nil]
+      optional :credentials, -> { Cadenya::AIProviderKeySpec::Credentials }
 
       # @!attribute provider
       #   The AI provider this key authenticates against.
@@ -24,16 +27,163 @@ module Cadenya
       #   @return [Symbol, Cadenya::Models::AIProviderKeySpec::Provider, nil]
       optional :provider, enum: -> { Cadenya::AIProviderKeySpec::Provider }
 
-      # @!method initialize(api_key: nil, openrouter: nil, provider: nil)
+      # @!method initialize(config: nil, credentials: nil, provider: nil)
       #   Some parameter documentations has been truncated, see
       #   {Cadenya::Models::AIProviderKeySpec} for more details.
       #
-      #   @param api_key [String] The provider credential. Accepted on create/update; never populated in
+      #   @param config [Cadenya::Models::AIProviderKeySpec::Config] AIProviderConfig holds non-secret, provider-specific settings. The set case
       #
-      #   @param openrouter [Object] OpenRouterConfig holds OpenRouter-specific settings. Empty for now; it exists
+      #   @param credentials [Cadenya::Models::AIProviderKeySpec::Credentials] AIProviderCredential is the secret material used to authenticate with a
       #
       #   @param provider [Symbol, Cadenya::Models::AIProviderKeySpec::Provider] The AI provider this key authenticates against.
 
+      # @see Cadenya::Models::AIProviderKeySpec#config
+      class Config < Cadenya::Internal::Type::BaseModel
+        # @!attribute openai
+        #   OpenAIConfig holds OpenAI-specific settings.
+        #
+        #   @return [Cadenya::Models::AIProviderKeySpec::Config::OpenAI, nil]
+        optional :openai, -> { Cadenya::AIProviderKeySpec::Config::OpenAI }
+
+        # @!attribute openai_compatible
+        #   OpenAICompatibleConfig configures a generic endpoint that speaks the OpenAI Chat
+        #   Completions API. The base URL is required and its model catalog is discovered
+        #   live via GET {base_url}/models.
+        #
+        #   @return [Cadenya::Models::AIProviderKeySpec::Config::OpenAICompatible, nil]
+        optional :openai_compatible,
+                 -> { Cadenya::AIProviderKeySpec::Config::OpenAICompatible },
+                 api_name: :openaiCompatible
+
+        # @!attribute openrouter
+        #   OpenRouterConfig holds OpenRouter-specific settings.
+        #
+        #   @return [Cadenya::Models::AIProviderKeySpec::Config::Openrouter, nil]
+        optional :openrouter, -> { Cadenya::AIProviderKeySpec::Config::Openrouter }
+
+        # @!method initialize(openai: nil, openai_compatible: nil, openrouter: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Cadenya::Models::AIProviderKeySpec::Config} for more details.
+        #
+        #   AIProviderConfig holds non-secret, provider-specific settings. The set case must
+        #   correspond to AIProviderKeySpec.provider. Providers with no settings (Anthropic,
+        #   Gemini) simply leave this unset. The endpoint of a named provider is fixed and
+        #   intentionally not overridable here; use the OpenAI-compatible provider to target
+        #   a custom endpoint.
+        #
+        #   @param openai [Cadenya::Models::AIProviderKeySpec::Config::OpenAI] OpenAIConfig holds OpenAI-specific settings.
+        #
+        #   @param openai_compatible [Cadenya::Models::AIProviderKeySpec::Config::OpenAICompatible] OpenAICompatibleConfig configures a generic endpoint that speaks the OpenAI
+        #
+        #   @param openrouter [Cadenya::Models::AIProviderKeySpec::Config::Openrouter] OpenRouterConfig holds OpenRouter-specific settings.
+
+        # @see Cadenya::Models::AIProviderKeySpec::Config#openai
+        class OpenAI < Cadenya::Internal::Type::BaseModel
+          # @!attribute organization_id
+          #   Sent as the OpenAI-Organization header when set.
+          #
+          #   @return [String, nil]
+          optional :organization_id, String, api_name: :organizationId
+
+          # @!attribute project_id
+          #   Sent as the OpenAI-Project header when set.
+          #
+          #   @return [String, nil]
+          optional :project_id, String, api_name: :projectId
+
+          # @!method initialize(organization_id: nil, project_id: nil)
+          #   OpenAIConfig holds OpenAI-specific settings.
+          #
+          #   @param organization_id [String] Sent as the OpenAI-Organization header when set.
+          #
+          #   @param project_id [String] Sent as the OpenAI-Project header when set.
+        end
+
+        # @see Cadenya::Models::AIProviderKeySpec::Config#openai_compatible
+        class OpenAICompatible < Cadenya::Internal::Type::BaseModel
+          # @!attribute base_url
+          #
+          #   @return [String, nil]
+          optional :base_url, String, api_name: :baseUrl
+
+          # @!method initialize(base_url: nil)
+          #   OpenAICompatibleConfig configures a generic endpoint that speaks the OpenAI Chat
+          #   Completions API. The base URL is required and its model catalog is discovered
+          #   live via GET {base_url}/models.
+          #
+          #   @param base_url [String]
+        end
+
+        # @see Cadenya::Models::AIProviderKeySpec::Config#openrouter
+        class Openrouter < Cadenya::Internal::Type::BaseModel
+          # @!attribute region
+          #   Data-residency region (e.g. "us", "eu"). Empty uses the provider default.
+          #
+          #   @return [String, nil]
+          optional :region, String
+
+          # @!method initialize(region: nil)
+          #   OpenRouterConfig holds OpenRouter-specific settings.
+          #
+          #   @param region [String] Data-residency region (e.g. "us", "eu"). Empty uses the provider default.
+        end
+      end
+
+      # @see Cadenya::Models::AIProviderKeySpec#credentials
+      class Credentials < Cadenya::Internal::Type::BaseModel
+        # @!attribute api_key
+        #   CredentialAPIKey carries a single bearer/header API key.
+        #
+        #   @return [Cadenya::Models::AIProviderKeySpec::Credentials::APIKey, nil]
+        optional :api_key, -> { Cadenya::AIProviderKeySpec::Credentials::APIKey }, api_name: :apiKey
+
+        # @!attribute headers
+        #   CredentialHeaders carries arbitrary HTTP headers sent with every request to the
+        #   provider (e.g. {"Authorization": "Bearer ...", "X-Api-Key": "..."}).
+        #
+        #   @return [Cadenya::Models::AIProviderKeySpec::Credentials::Headers, nil]
+        optional :headers, -> { Cadenya::AIProviderKeySpec::Credentials::Headers }
+
+        # @!method initialize(api_key: nil, headers: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Cadenya::Models::AIProviderKeySpec::Credentials} for more details.
+        #
+        #   AIProviderCredential is the secret material used to authenticate with a
+        #   provider. The set case must correspond to AIProviderKeySpec.provider. The server
+        #   encrypts the serialized message at rest and never returns it on reads.
+        #
+        #   @param api_key [Cadenya::Models::AIProviderKeySpec::Credentials::APIKey] CredentialAPIKey carries a single bearer/header API key.
+        #
+        #   @param headers [Cadenya::Models::AIProviderKeySpec::Credentials::Headers] CredentialHeaders carries arbitrary HTTP headers sent with every request to
+
+        # @see Cadenya::Models::AIProviderKeySpec::Credentials#api_key
+        class APIKey < Cadenya::Internal::Type::BaseModel
+          # @!attribute api_key
+          #
+          #   @return [String, nil]
+          optional :api_key, String, api_name: :apiKey
+
+          # @!method initialize(api_key: nil)
+          #   CredentialAPIKey carries a single bearer/header API key.
+          #
+          #   @param api_key [String]
+        end
+
+        # @see Cadenya::Models::AIProviderKeySpec::Credentials#headers
+        class Headers < Cadenya::Internal::Type::BaseModel
+          # @!attribute headers
+          #
+          #   @return [Hash{Symbol=>String}, nil]
+          optional :headers, Cadenya::Internal::Type::HashOf[String]
+
+          # @!method initialize(headers: nil)
+          #   CredentialHeaders carries arbitrary HTTP headers sent with every request to the
+          #   provider (e.g. {"Authorization": "Bearer ...", "X-Api-Key": "..."}).
+          #
+          #   @param headers [Hash{Symbol=>String}]
+        end
+      end
+
       # The AI provider this key authenticates against.
       #
       # @see Cadenya::Models::AIProviderKeySpec#provider
@@ -42,6 +192,10 @@ module Cadenya
 
         AI_PROVIDER_UNSPECIFIED = :AI_PROVIDER_UNSPECIFIED
         AI_PROVIDER_OPENROUTER = :AI_PROVIDER_OPENROUTER
+        AI_PROVIDER_OPENAI = :AI_PROVIDER_OPENAI
+        AI_PROVIDER_ANTHROPIC = :AI_PROVIDER_ANTHROPIC
+        AI_PROVIDER_GEMINI = :AI_PROVIDER_GEMINI
+        AI_PROVIDER_OPENAI_COMPATIBLE = :AI_PROVIDER_OPENAI_COMPATIBLE
 
         # @!method self.values
         #   @return [Array<Symbol>]

data/lib/cadenya/models/tool_sets/config_mcp.rb

@@ -3,8 +3,23 @@
 module Cadenya
   module Models
     module ToolSets
-      # @type [Cadenya::Internal::Type::Converter]
-      ConfigMcp = Cadenya::Internal::Type::Unknown
+      class ConfigMcp < Cadenya::Internal::Type::BaseModel
+        # @!attribute annotations
+        #   Behavior hints synced from the MCP server's tool definition (ToolAnnotations in
+        #   the MCP specification). All hints are advisory: servers are not required to send
+        #   them, and clients should not rely on them for security decisions. Absent hints
+        #   keep the MCP spec defaults (destructiveHint and openWorldHint default to true;
+        #   readOnlyHint and idempotentHint default to false).
+        #
+        #   @return [Cadenya::Models::ToolSets::McpAnnotations, nil]
+        optional :annotations, -> { Cadenya::ToolSets::McpAnnotations }
+
+        # @!method initialize(annotations: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Cadenya::Models::ToolSets::ConfigMcp} for more details.
+        #
+        #   @param annotations [Cadenya::Models::ToolSets::McpAnnotations] Behavior hints synced from the MCP server's tool definition
+      end
     end
   end
 end

data/lib/cadenya/models/tool_sets/mcp_annotations.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module Cadenya
+  module Models
+    module ToolSets
+      class McpAnnotations < Cadenya::Internal::Type::BaseModel
+        # @!attribute destructive_hint
+        #   If true, the tool may perform destructive updates to its environment. Only
+        #   meaningful when read_only_hint is false.
+        #
+        #   @return [Boolean, nil]
+        optional :destructive_hint, Cadenya::Internal::Type::Boolean, api_name: :destructiveHint
+
+        # @!attribute idempotent_hint
+        #   If true, calling the tool repeatedly with the same arguments has no additional
+        #   effect. Only meaningful when read_only_hint is false.
+        #
+        #   @return [Boolean, nil]
+        optional :idempotent_hint, Cadenya::Internal::Type::Boolean, api_name: :idempotentHint
+
+        # @!attribute open_world_hint
+        #   If true, the tool may interact with an "open world" of external entities (e.g.
+        #   web search); if false, its domain is closed.
+        #
+        #   @return [Boolean, nil]
+        optional :open_world_hint, Cadenya::Internal::Type::Boolean, api_name: :openWorldHint
+
+        # @!attribute read_only_hint
+        #   If true, the tool does not modify its environment.
+        #
+        #   @return [Boolean, nil]
+        optional :read_only_hint, Cadenya::Internal::Type::Boolean, api_name: :readOnlyHint
+
+        # @!attribute title
+        #   A human-readable title for the tool.
+        #
+        #   @return [String, nil]
+        optional :title, String
+
+        # @!method initialize(destructive_hint: nil, idempotent_hint: nil, open_world_hint: nil, read_only_hint: nil, title: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Cadenya::Models::ToolSets::McpAnnotations} for more details.
+        #
+        #   Behavior hints synced from the MCP server's tool definition (ToolAnnotations in
+        #   the MCP specification). All hints are advisory: servers are not required to send
+        #   them, and clients should not rely on them for security decisions. Absent hints
+        #   keep the MCP spec defaults (destructiveHint and openWorldHint default to true;
+        #   readOnlyHint and idempotentHint default to false).
+        #
+        #   @param destructive_hint [Boolean] If true, the tool may perform destructive updates to its environment.
+        #
+        #   @param idempotent_hint [Boolean] If true, calling the tool repeatedly with the same arguments has no
+        #
+        #   @param open_world_hint [Boolean] If true, the tool may interact with an "open world" of external
+        #
+        #   @param read_only_hint [Boolean] If true, the tool does not modify its environment.
+        #
+        #   @param title [String] A human-readable title for the tool.
+      end
+    end
+  end
+end

data/lib/cadenya/models/tool_sets/tool_spec_config.rb

@@ -11,8 +11,8 @@ module Cadenya
 
         # @!attribute mcp
         #
-        #   @return [Object, nil]
-        optional :mcp, Cadenya::Internal::Type::Unknown
+        #   @return [Cadenya::Models::ToolSets::ConfigMcp, nil]
+        optional :mcp, -> { Cadenya::ToolSets::ConfigMcp }
 
         # @!attribute openapi
         #
@@ -25,7 +25,7 @@ module Cadenya
         #   be Http. If the tool is an inline tool, the adapter will be Inline.
         #
         #   @param http [Cadenya::Models::ToolSets::ConfigHTTP]
-        #   @param mcp [Object]
+        #   @param mcp [Cadenya::Models::ToolSets::ConfigMcp]
         #   @param openapi [Cadenya::Models::ToolSets::ConfigOpenAPI]
       end
     end

data/lib/cadenya/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Cadenya
-  VERSION = "0.23.0"
+  VERSION = "0.25.0"
 end

data/lib/cadenya.rb

@@ -258,6 +258,7 @@ require_relative "cadenya/models/tool_set_retrieve_params"
 require_relative "cadenya/models/tool_sets/config_http"
 require_relative "cadenya/models/tool_sets/config_mcp"
 require_relative "cadenya/models/tool_sets/config_openapi"
+require_relative "cadenya/models/tool_sets/mcp_annotations"
 require_relative "cadenya/models/tool_sets/secret_create_params"
 require_relative "cadenya/models/tool_sets/secret_delete_params"
 require_relative "cadenya/models/tool_sets/secret_list_params"