API reference and version identity

API reference and version identity

Find the exact API contract

Start with a discovery map, follow its operation guide, then check the declaring type in the SDK that your script actually uses. The map explains where to look; it is not an exhaustive list of overloads.

Choose the matching reference

SourceWhat it establishesVersion to retain
Generated API referencePublic declarations and available XML comments for the assemblies used by that generationThe assembly/package version used to generate it
SDK assemblies and accompanying XML documentation in an exported script projectThe contract available to that project's compiler, including inherited members and extension methodsEyeAuras build, assembly identity and resolved package versions
Source at a fixed commitImplementation details such as ownership, cancellation and service registrationCommit SHA and submodule revisions
Optional NuGet SDKThe public surface of that specific package, which may differ from built-in APIsExact package version and supported host version

The public reference is a separate publication from Wiki. A newer Wiki page or a successful Git refresh does not establish that the reference was regenerated. If a reference page does not identify the required version, check your installed SDK before copying a signature. A missing generated page is not evidence that a public member is absent from the installed assembly.

Inspect the contract used by a script

Export the script as a project through the IDE integration workflow and open it in your IDE. Navigate to the declaring type, inspect its base types and extension methods, and use the adjacent XML documentation for parameter and return semantics. Keep the exported project's resolved dependencies; replacing an optional package with its latest version changes the contract being checked.

For example, IVariablesScriptingApi inherits IVariablesAccessor; reading only its directly declared Get<T> overloads misses inherited operations. Pair the Variables guide with the declaring interface at the source revision and follow its inherited contract. A declaration alone does not prove a service is registered in every host; use the runtime context map.

In a top-level EyeAuras C# Script, this logs the assembly identity of the contract loaded by the running host:

Log.Info(typeof(EyeAuras.Scripting.Api.IVariablesScriptingApi).Assembly.FullName);

Assembly identity helps detect a mismatch but does not uniquely identify a Git commit or NuGet package. Retain the EyeAuras build and resolved package version as well. Ordinary helper classes must receive their own logger.

How the generated reference is built

The existing DocFX configuration reads selected SDK assemblies and generates reference pages. Its API filter excludes several implementation areas. It is therefore a selected reference, not proof of coverage of every optional SDK or all runtime services.

For a version-specific check, use the matching SDK assemblies and XML files. Do not substitute a hand-maintained method dump for that contract: it loses inherited members, overloads and version identity as the implementation changes.