haveapi-go-client 0.30.0 → 0.30.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 890df2231c3212cf60786444dca1049aaa7fa74a7b7d3b354aecefebc41d8972
-  data.tar.gz: 5fe100b28f13414663f0cef2c382040c612c512d6f1caefcc2744519d637fa15
+  metadata.gz: 6d7b665ff9866f57fd844908a8ee6d8ce83bf784578949ade2a057e465f50a0c
+  data.tar.gz: 549ecd828535d2a740758805ba7e04494e963a1e67acdf7c76a05eaaa2dcb6eb
 SHA512:
-  metadata.gz: 430d52e49783ab4b0699ce1ea03dbadc64a446ee1d29f71c114837e9013d1de60e17d70a9a41a149e258ad641858b0a7e3d1e50cb0fb220aa0d23b5685fabc5c
-  data.tar.gz: a2b472cd256d13b824540947f1d708bfd09ace1c2a2814f1b882ca8325fb05882e75fd2086dee07443a308249860829ac1931557fa5e44a69512e902c7b34e4c
+  metadata.gz: ae6a2f23d846e821d03ab0b9aa6c9cd64680d35db0c4996df2a1cbeea432a499cee1f6be57e86700282a297a73d82863e811e02d9216bfbbba0d868b2750255a
+  data.tar.gz: 39db10f2394870b215d28ad44a142318694d5ff295810c38e4407dda43677f73907e90c969dfb08228ba698096cc7cd9a3aa624a5b7839b8fe69db239224ce4e

data/docs/documentation.md

@@ -1,52 +1,70 @@
 # Generated API documentation examples
 
-The Ruby server can show Go examples for a configured generated SDK. The SDK's
-module version is independent of the HaveAPI gem version and API version.
-Install the `haveapi-go-client` gem at the exact generator version used for the
-SDK, alongside the server gem. Configure the profile before mounting the API:
+The Ruby server can show Go examples for a configured generated SDK. Install the
+optional `haveapi-go-client` generator gem alongside the server gem. Register the
+profile before mounting the API:
 
 ```ruby
-api.documentation_clients(
-  '7',
-  go: {
-    import_path: 'example.org/widget-sdk/v2/client',
-    module_version: 'v2.3.4',
-    description_path: '/etc/widget-api/sdk-v7.json',
-    generator_version: '0.30.0'
-  }
+api.documentation_clients('7',
+  go: { import_path: 'example.org/widget-sdk/v2/client' }
 )
+api.mount('/api/')
 ```
 
-`import_path` identifies the published SDK package, including its package
-subdirectory. Examples import it with the explicit alias `client`. The local
-absolute JSON file must contain the complete description used to generate that
-SDK, including sibling resources, aliases and authentication descriptions.
-Retain this file with the SDK release; do not create it from a filtered public
-documentation page. The Go description has no API-version field. The configuration's version key
-binds the retained description to that API version.
-Keep the description private because it can include privileged API information.
-
-A missing profile hides the Go overview entry and all Go example panels. An
-invalid profile or a missing or mismatched generator gem fails configuration.
-The server loads the file and constructs the adapter during configuration. HTML
-requests do not read files, fetch API descriptions, generate source, invoke Go
-or write an SDK. Removing the profile disables Go examples without changing API
-behavior or existing clients.
+`import_path` identifies the SDK package, including its package subdirectory.
+Examples use the explicit import alias `client`. `generator_version` defaults
+to the server's `HaveAPI::VERSION` and must match the installed generator gem.
+An explicit value requires the installed generator to report that version. It
+does not select the SDK version or download a generator.
+
+`module_version` is optional. Omission or nil renders
+`go get example.org/widget-sdk/v2/client@latest`; `module_version: 'v2.3.4'`
+selects that version instead. Go resolves latest by its normal rules and existing
+module configuration still applies. Latest can change over time. The server
+never queries a package registry or claims to have resolved the installed SDK.
+
+At the end of mount, the server builds one private structural model per
+configured API version from the complete declaration, including authentication
+routes and changes from post-mount hooks. The copy excludes prose, examples and
+parameter defaults; canonical names still include every sibling and ancestor.
+Requests use the current user's authorized help and samples. The configured SDK
+is expected to match this generation contract. Its package name or version does
+not prove that match; older SDKs can lack actions or use different collision names.
+
+For an older or deliberately restricted SDK, add
+`description_path: '/etc/widget-api/sdk-v7.json'`. This optional trusted absolute
+JSON file contains the complete description used to generate that SDK, including
+siblings, aliases and authentication descriptions. Retain it with the SDK; do
+not reconstruct it from a filtered documentation page. The description has no
+API-version field, so the profile's version key binds it to the selected version.
+Keep saved descriptions private because they can contain privileged information.
+The prior explicit `module_version`/`description_path`/`generator_version` form
+remains supported.
+
+A missing profile hides Go everywhere. Unknown fields, invalid profiles, missing
+files and actual generator-version mismatches fail startup. Saved descriptions
+are loaded during registration; automatic adapters are initialized at the end of
+mount. No profiles are published when mount fails. HTML requests read no files,
+fetch no descriptions and run no generator, compiler or formatter. Removing the
+profile changes documentation availability without changing API wire behavior.
+See the [server profile guide](../../../doc/client-examples.md) for configuration,
+compatibility assumptions and rollback requirements.
 
 ## Mapping and supported samples
 
 `HaveAPI::GoClient::Documentation` constructs the generator's `ApiVersion` from
-the full saved description. Resource and action members, including aliases and
-collision suffixes, come from the generator's existing name allocator. The
-current user's filtered server description controls which samples and fields
-can appear. A saved SDK can lag unrelated server additions. Each rendered sample
-must still match its route, input and output layouts, and supplied field contracts.
+the complete private description, whether automatic or saved. Resource and
+action members, including aliases and collision suffixes, come from the
+generator's existing name allocator. The current user's filtered server
+description controls which samples and fields can appear. A saved SDK description
+can lag unrelated server additions. Each rendered sample must still match its
+route, input and output layouts, and supplied field contracts.
 Unsupported or stale samples show a short limitation instead of incomplete code.
 
 Programs initialize the client with the API origin. Saved action paths include
 the mounted root and selected `/vVERSION/` segment. Ordered sample path arguments
-become the generated `SetPathParamInt` or `SetPathParamString` calls. Object/hash input uses
-`NewInput().SelectParameters()` before setters; this preserves omitted fields,
+become the generated `SetPathParamInt` or `SetPathParamString` calls. Object/hash
+input uses `NewInput().SelectParameters()` before setters; this preserves omitted fields,
 explicit zero, false and empty strings. Nullable fields use `SetFIELDNil(true)`.
 An empty request selects no fields. A missing request leaves input unallocated.
 
@@ -78,9 +96,9 @@ The documentation adapter accepts loaded data and returns frozen plain results:
 
 ```ruby
 adapter = HaveAPI::GoClient::Documentation.new(
-  description: saved_description,
+  description: full_description,
   import_path: 'example.org/widget-sdk/v2/client',
-  module_version: 'v2.3.4'
+  module_version: nil # Optional; use 'v2.3.4' to select a version.
 )
 resolved = adapter.resolve(resource_path: %w[widget], action_name: 'update')
 result = adapter.render(kind: :example, context: context, mode: :sync)
@@ -91,7 +109,8 @@ adapter does not depend on the server gem. Results have either
 `{status: :code, code: source}` or `{status: :limitation, reason: text}`. Renderers
 return source/plain text; the server template escapes HTML once.
 
-For SDK fixtures or an already captured schema, use the offline constructor. It preserves the ordinary URL constructor's generation options:
+For SDK fixtures or an already captured schema, use the offline constructor.
+It preserves the ordinary URL constructor's generation options:
 
 ```ruby
 generator = HaveAPI::GoClient::Generator.from_description(

data/haveapi-go-client.gemspec

@@ -18,5 +18,5 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'haveapi-client', '~> 0.30.0'
+  spec.add_dependency 'haveapi-client', '~> 0.30.2'
 end

data/lib/haveapi/go_client/documentation.rb

@@ -4,7 +4,7 @@ require 'haveapi/go_client'
 require 'haveapi/go_client/utils'
 
 module HaveAPI::GoClient
-  # Pure adapter over the complete schema used to generate a published SDK.
+  # Pure adapter over a complete description matching the configured SDK.
   # Never reconstruct names from a user's reduced documentation description.
   class Documentation
     include Utils
@@ -15,15 +15,15 @@ module HaveAPI::GoClient
     PARAMETER_CONTRACT = %i[type nullable resource value_id value_label].freeze
     INPUT_MEMBERS = %w[SelectParameters UnselectParameters AnySelected].freeze
 
-    def initialize(description:, import_path:, module_version:)
+    def initialize(description:, import_path:, module_version: nil)
       unless import_path.is_a?(String) && import_path.match?(%r{\A[A-Za-z0-9][A-Za-z0-9._~/-]*\z}) \
           && import_path.split('/').none? { |part| ['', '.', '..'].include?(part) } \
-          && module_version.is_a?(String) && module_version.match?(/\Av\d+\.\d+\.\d+(?:-[0-9A-Za-z.-]+)?(?:\+[0-9A-Za-z.-]+)?\z/)
+          && (module_version.nil? || (module_version.is_a?(String) && module_version.match?(/\Av\d+\.\d+\.\d+(?:-[0-9A-Za-z.-]+)?(?:\+[0-9A-Za-z.-]+)?\z/)))
         raise ArgumentError, 'invalid Go SDK import path or module version'
       end
 
       @import_path = import_path.dup.freeze
-      @module_version = module_version.dup.freeze
+      @module_version = module_version&.dup&.freeze
       @description = copy(description)
       validate_description
       @api = ApiVersion.new(@description)
@@ -433,7 +433,7 @@ module HaveAPI::GoClient
       origin = URI.parse(context.base_url)
       origin.path = ''
       origin.query = origin.fragment = nil
-      header = ["// go get #{@import_path}@#{@module_version}", 'package main', '', 'import (']
+      header = ["// go get #{@import_path}@#{@module_version || 'latest'}", 'package main', '', 'import (']
       imports.each { |name| header << "  #{go_string_literal(name)}" }
       header << "  client #{go_string_literal(@import_path)}"
       header.push(')', '', 'func main() {', "  api := client.New(#{go_string_literal(origin.to_s)})")
@@ -457,7 +457,14 @@ module HaveAPI::GoClient
     end
 
     def parameter_contract(desc)
-      PARAMETER_CONTRACT.map { |key| desc[key] }
+      PARAMETER_CONTRACT.map do |key|
+        value = desc[key]
+        if %i[value_id value_label].include?(key) && (value.is_a?(String) || value.is_a?(Symbol))
+          value.to_s
+        else
+          value
+        end
+      end
     end
 
     def visible_action(description, path, name)

data/lib/haveapi/go_client/version.rb

@@ -1,5 +1,5 @@
 module HaveAPI
   module GoClient
-    VERSION = '0.30.0'.freeze
+    VERSION = '0.30.2'.freeze
   end
 end

data/spec/documentation_acceptance.rb

@@ -59,6 +59,7 @@ class GoDocumentationAcceptance
         generator_version: Gem.loaded_specs.fetch('haveapi-go-client').version.to_s
       })
       profiles.mount(['7'])
+      profiles.finalize(nil)
       raise 'configured Go profile is unavailable' unless profiles.for_version('7').fetch(:go).language == :go
     end
   end
@@ -125,6 +126,7 @@ class GoDocumentationAcceptance
       generator_version: HaveAPI::GoClient::VERSION
     })
     profiles.mount(['7'])
+    profiles.finalize(nil)
     @profile = profiles.for_version('7').fetch(:go)
     FileUtils.mkdir_p(File.join(dir, 'consumer'))
     FileUtils.mkdir_p(File.join(dir, 'bin'))

data/spec/documentation_build_check.rb

@@ -3,6 +3,7 @@ require_relative 'documentation_acceptance'
 
 class GoDocumentationBuildCheck
   def self.run!
+    GoDocumentationAcceptance.check_environment!
     Dir.mktmpdir('haveapi-go-documentation-build-') do |root|
       # Own this invalid ancestor marker; never rely on or alter ambient Git state.
       Dir.mkdir(File.join(root, '.git'))

data/spec/documentation_profile_check.rb

@@ -0,0 +1,99 @@
+# Pure mounted-DSL/profile regression. No generation, compiler or listener.
+require 'json'
+require 'tempfile'
+require 'haveapi'
+require 'haveapi/go_client/documentation'
+require_relative 'support/documentation_profile_fixture'
+
+class GoDocumentationProfileCheck
+  FIXTURE = GoDocumentationProfileFixture
+
+  def self.run!
+    new.run!
+  end
+
+  def run!
+    server = FIXTURE.server
+    profile = server.documentation_client_profiles('7').fetch(:go)
+    assert(profile.package_version.nil?, 'omitted module version must remain unresolved')
+    full = FIXTURE.description(server)
+    model = HaveAPI::GoClient::ApiVersion.new(full)
+    public_description = FIXTURE.description(server, user: :public)
+    privileged_description = FIXTURE.description(server, user: :privileged)
+    context = FIXTURE.context(public_description)
+    adapter = profile.adapter
+    structural = adapter.instance_variable_get(:@description).dig(:resources, :set_timeout_resource, :resources, :child, :actions, :client)
+    assert(!structural.has_key?(:examples), 'the private model must not retain example payloads')
+    assert(!structural.dig(:input, :parameters, :private_value).has_key?(:default), 'the private model must not retain parameter defaults')
+    resolved = adapter.resolve(resource_path: context.resource_path, action_name: 'perform')
+    canonical = model.resources.find { |resource| resource.name == 'set_timeout_resource' }
+    assert(resolved.resource.parent.go_member_name == canonical.go_member_name, 'full-DSL sibling allocation must be canonical')
+    assert(canonical.go_member_name != 'SetTimeoutResource', 'hidden reserved-name sibling must affect allocation')
+    assert(resolved.action.go_member_name == 'ClientAction', 'nested action must keep the generator collision name')
+
+    source = code(adapter, context)
+    assert(source.start_with?("// go get example.test/current-sdk/client@latest\n"), 'omitted version must emit valid latest selection')
+    assert(source.include?('client "example.test/current-sdk/client"'), 'SDK import alias must stay explicit')
+    assert(source.include?("api.#{canonical.go_member_name}.Child.ClientAction.Prepare()"), 'rendered nested members must use the full model')
+    assert(source.include?('SetPathParamString("parent_id", "parent/with space")'), 'ordered string path argument was lost')
+    assert(source.include?('SetPathParamInt("child_id", 0)'), 'ordered zero path argument was lost')
+    assert(source.include?('input := invocation.NewInput().SelectParameters()'), 'input omission selection must stay explicit')
+    assert(source.include?('input.SetEnabled(false)') && source.include?('input.SetCount(0)'), 'false/zero inputs were lost')
+    assert(source.include?("input.SetName(#{JSON.generate(FIXTURE::HOSTILE)})"), 'hostile source literal was not escaped')
+    assert(source.include?('response.Output.Owner.Id') && !source.include?('Owner.Label'), 'nested output must use only supplied attributes')
+    assert(source.include?('// metadata.SetIncludes(value)'), 'advertised optional includes guidance must remain')
+    assert(!source.match?(/private sample|private result|private default|SetPrivateValue|SetUnused|\.PrivateValue/), 'filtered fields or values leaked')
+
+    privileged = code(adapter, FIXTURE.context(privileged_description))
+    assert(privileged.include?('input.SetPrivateValue("private sample")'), 'authorized supplied field was lost')
+    assert(code(adapter, FIXTURE.context(public_description)) == source, 'sequential users must not change the shared model')
+    hidden = full.fetch(:resources).fetch('set_timeout').fetch(:actions).fetch('secret')
+    hidden_context = context.with(resource_path: ['set_timeout'], action_name: 'secret', action: hidden,
+                                  sample: { status: true, response: { private_value: 'must not leak' } })
+    limited(adapter, hidden_context, 'unavailable')
+
+    root_context = FIXTURE.context(public_description, path: ['set_timeout_resource'], action_name: 'child')
+    root_source = code(adapter, root_context)
+    assert(root_source.include?("api.#{canonical.go_member_name}.ChildAction.Prepare()"), 'resource/action collision was reconstructed incorrectly')
+    assert(root_source.include?('input.SetNameNil(true)'), 'nullable supplied input must use the nil setter')
+
+    pinned = FIXTURE.server(module_version: 'v2.3.4', generator_version: HaveAPI::GoClient::VERSION)
+    pinned_adapter = pinned.documentation_client_profiles('7').fetch(:go).adapter
+    pinned_source = code(pinned_adapter, FIXTURE.context(FIXTURE.description(pinned, user: :public)))
+    assert(pinned_source == source.sub('@latest', '@v2.3.4'), 'explicit version must preserve all other rendering')
+    check_legacy(full, source)
+    $stdout.write("Go documentation profiles: current mounted DSL, optional/pinned versions, legacy data and authorized rendering passed\n") # rubocop:disable RSpec/Output
+  end
+
+  private
+
+  def check_legacy(full, current_source)
+    Tempfile.create(['haveapi-go-profile-', '.json']) do |file|
+      file.write(JSON.generate(full))
+      file.flush
+      server = FIXTURE.server(description_path: file.path, module_version: 'v2.3.4',
+                              generator_version: HaveAPI::GoClient::VERSION)
+      adapter = server.documentation_client_profiles('7').fetch(:go).adapter
+      context = FIXTURE.context(FIXTURE.description(server, user: :public))
+      assert(code(adapter, context) == current_source.sub('@latest', '@v2.3.4'), 'legacy saved profile must preserve current matching rendering')
+    end
+  end
+
+  def code(adapter, context)
+    result = adapter.render(kind: :example, context:, mode: :sync)
+    assert(result[:status] == :code, "unexpected limitation: #{result[:reason]}")
+    result.fetch(:code)
+  end
+
+  def limited(adapter, context, reason)
+    result = adapter.render(kind: :example, context:, mode: :sync)
+    assert(result[:status] == :limitation && result[:reason].include?(reason), 'hidden action must remain unavailable')
+    assert(!result.to_s.include?('must not leak'), 'limitation disclosed the hidden sample')
+  end
+
+  def assert(condition, message)
+    raise message unless condition
+  end
+end
+
+GoDocumentationProfileCheck.run! if $0 == __FILE__

data/spec/support/documentation_profile_fixture.rb

@@ -0,0 +1,122 @@
+# Real mounted DSL for the pure documentation-profile check; no action is run.
+module GoDocumentationProfileFixture
+  HOSTILE = "quote\"\\\n雪</script>".freeze
+
+  module Resources
+    class Owner < HaveAPI::Resource
+      version '7'
+      auth false
+
+      define_action(:Index) do
+        authorize { allow }
+        output(:hash_list) do
+          integer :id
+          string :label
+        end
+      end
+
+      define_action(:Show) do
+        route '{owner_id}'
+        authorize { allow }
+        output(:hash) do
+          integer :id
+          string :label
+        end
+      end
+    end
+
+    class SetTimeout < HaveAPI::Resource
+      version '7'
+      auth false
+
+      define_action(:Secret) do
+        authorize { |user| user == :privileged ? allow : deny }
+        output(:hash) { string :private_value }
+      end
+    end
+
+    class SetTimeoutResource < HaveAPI::Resource
+      version '7'
+      route 'parents'
+      auth false
+
+      define_resource(:Child) do
+        route '{parent_id}/children'
+        auth false
+        define_action(:Client) do
+          route '{child_id}'
+          http_method :post
+          aliases ['perform']
+          authorize do |user|
+            input blacklist: [:private_value] unless user == :privileged
+            output blacklist: [:private_value] unless user == :privileged
+            allow
+          end
+
+          input(:hash) do
+            string :name, nullable: true
+            bool :enabled
+            integer :count
+            string :private_value, default: 'private default'
+            string :unused
+          end
+          output(:hash) do
+            integer :id
+            string :private_value
+            resource Owner, name: :owner, nullable: true
+          end
+          meta(:global) do
+            input { custom :includes }
+          end
+
+          example 'filtered sample' do # rubocop:disable RSpec/NoExpectationExample -- HaveAPI sample DSL.
+            path_params 'parent/with space', 0
+            request name: HOSTILE, enabled: false, count: 0, private_value: 'private sample'
+            response id: 0, private_value: 'private result', owner: { id: 9 }
+          end
+
+          def exec
+            raise 'Documentation must not execute an action'
+          end
+        end
+      end
+
+      define_action(:Update) do
+        self.action_name = 'child'
+        route 'update'
+        aliases ['perform']
+        authorize { allow }
+        input(:hash) { string :name, nullable: true }
+        output(:hash) { integer :id }
+
+        example 'nullable sample' do # rubocop:disable RSpec/NoExpectationExample -- HaveAPI sample DSL.
+          request name: nil
+          response id: 0
+        end
+      end
+    end
+  end
+
+  def self.server(**go)
+    server = HaveAPI::Server.new(Resources)
+    server.use_version('7')
+    server.default_version = '7'
+    server.documentation_clients('7', go: { import_path: 'example.test/current-sdk/client', **go })
+    server.mount('/mounted/')
+    server
+  end
+
+  def self.description(server, user: nil)
+    server.describe_version(HaveAPI::Context.new(server, version: '7', user:, endpoint: false, doc: true))
+  end
+
+  def self.context(description, path: %w[set_timeout_resource child], action_name: 'client', sample: nil)
+    resource = path.inject(description) { |parent, name| parent.fetch(:resources).fetch(name) }
+    action = resource.fetch(:actions).fetch(action_name)
+    HaveAPI::ClientExample::Context.new(
+      version: '7', host: 'api.example.test', base_url: 'https://api.example.test/mounted/',
+      version_url: 'https://api.example.test/mounted/v7/', description:, resource_path: path,
+      resource:, action_name:, action:, sample: sample || action.fetch(:examples).first
+    )
+  end
+end

data/spec/unit/documentation_spec.rb

@@ -15,6 +15,46 @@ RSpec.describe HaveAPI::GoClient::Documentation do
     adapter.render(kind: :example, context:, mode: :sync)
   end
 
+  it 'leaves an omitted module version unresolved and prints the Go latest selector' do
+    unversioned = described_class.new(description:, import_path: 'example.test/sdk/client')
+    expect(unversioned).to be_frozen
+    expect(unversioned.instance_variable_get(:@module_version)).to be_nil
+    expect(unversioned.render(kind: :init, context:, mode: :sync).fetch(:code)).to start_with("// go get example.test/sdk/client@latest\n")
+    expect(unversioned.render(kind: :example, context:, mode: :sync).fetch(:code)).to eq(
+      render.fetch(:code).sub('@v1.2.3', '@latest')
+    )
+  end
+
+  it 'treats an explicit nil version as omission without changing the canonical model' do
+    unversioned = described_class.new(description:, import_path: 'example.test/sdk/client', module_version: nil)
+    resolved = unversioned.resolve(resource_path: %w[client child], action_name: 'perform')
+    expect(resolved.action.go_member_names).to eq(adapter.resolve(resource_path: %w[client child], action_name: 'perform').action.go_member_names)
+    expect(unversioned.render(kind: :example, context:, mode: :sync).fetch(:code)).to include('client "example.test/sdk/client"', 'api.Client.Child.ClientAction.Prepare()')
+  end
+
+  it 'still rejects hostile imports when the module version is omitted' do
+    expect do
+      described_class.new(description:, import_path: "example.test/sdk/client\npackage injected")
+    end.to raise_error(ArgumentError, 'invalid Go SDK import path or module version')
+  end
+
+  it 'retains explicit version selectors and copies configuration strings' do
+    version = +'v2.3.4-rc.1+build.7'
+    path = +'example.test/sdk/v2/client'
+    pinned = described_class.new(description:, import_path: path, module_version: version)
+    version.replace('v9.9.9')
+    path.replace('other.test/sdk/client')
+    expect(pinned.render(kind: :init, context:, mode: :sync).fetch(:code)).to start_with("// go get example.test/sdk/v2/client@v2.3.4-rc.1+build.7\n")
+  end
+
+  ['', 'latest', '1.2.3', "v1.2.3\npackage injected", false, 7].each do |invalid|
+    it "rejects a supplied invalid module version #{invalid.inspect}" do
+      expect do
+        described_class.new(description:, import_path: 'example.test/sdk/client', module_version: invalid)
+      end.to raise_error(ArgumentError, 'invalid Go SDK import path or module version')
+    end
+  end
+
   it 'resolves canonical generator members and aliases without generator or serving I/O' do
     allow(HaveAPI::GoClient::Generator).to receive(:new).and_call_original
     allow(HaveAPI::GoClient::Generator).to receive(:allocate).and_call_original
@@ -261,6 +301,36 @@ RSpec.describe HaveAPI::GoClient::Documentation do
     expect(render).to include(status: :limitation, reason: /requires an object/)
   end
 
+  it 'matches live Resource identifier symbols against a saved JSON contract' do
+    action[:output][:parameters][:owner] = { type: 'Resource', resource: ['owner'], value_id: :id, value_label: :label, nullable: true }
+    sample[:response][:owner] = { id: 9 }
+    saved = JSON.parse(JSON.generate(description))
+    json_adapter = described_class.new(description: saved, import_path: 'example.test/sdk/client', module_version: 'v1.2.3')
+    result = json_adapter.render(kind: :example, context:, mode: :sync)
+
+    expect(result[:status]).to eq(:code)
+    expect(result[:code]).to include('fmt.Println(response.Output.Owner.Id)')
+    expect(result[:code]).not_to include('Owner.Label')
+    expect(result[:code]).to eq(render.fetch(:code))
+  end
+
+  {
+    value_id: ['other', nil, false, 7, [], {}],
+    value_label: ['other', nil, false, 7, [], {}],
+    type: [:Resource], nullable: [false], resource: [[:owner]]
+  }.each do |key, values|
+    values.each do |value|
+      it "rejects a changed or invalid live Resource contract #{key}: #{value.inspect}" do
+        action[:output][:parameters][:owner] = { type: 'Resource', resource: ['owner'], value_id: 'id', value_label: 'label', nullable: true }
+        sample[:response][:owner] = { id: 9 }
+        adapter
+        action[:output][:parameters][:owner][key] = value
+
+        expect(render).to include(status: :limitation, reason: 'This response field does not match the configured Go SDK.')
+      end
+    end
+  end
+
   it 'does not print associated fields missing from another documented list row' do
     action[:output][:layout] = 'hash_list'
     action[:output][:parameters][:owner] = { type: 'Resource', resource: ['owner'], value_id: 'id', value_label: 'label' }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: haveapi-go-client
 version: !ruby/object:Gem::Version
-  version: 0.30.0
+  version: 0.30.2
 platform: ruby
 authors:
 - Jakub Skokan
@@ -15,14 +15,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.30.0
+        version: 0.30.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.30.0
+        version: 0.30.2
 description: Go client generator
 email:
 - jakub.skokan@vpsfree.cz
@@ -66,10 +66,12 @@ files:
 - spec/documentation.Gemfile
 - spec/documentation_acceptance.rb
 - spec/documentation_build_check.rb
+- spec/documentation_profile_check.rb
 - spec/documentation_wire_check.rb
 - spec/integration/generator_spec.rb
 - spec/spec_helper.rb
 - spec/support/documentation_fixture.rb
+- spec/support/documentation_profile_fixture.rb
 - spec/support/test_server.rb
 - spec/unit/documentation_spec.rb
 - template/action.go.erb