Spec gap: deprecated instances top-level section has no syntax or migration guidance #16

Open
opened 2026-05-27 05:26:24 +00:00 by hurui200320 · 0 comments
Member

Problem

§3.2 lists instances as a valid (but deprecated) top-level section:

| instances | No | mapping | Template instances (deprecated form). (§8.7) |

However, §8.7 describes only the current inline instantiation form. The syntax of the old instances section — what it looked like and how it differs from the current form — is never described anywhere in the spec.

A library must be able to either:

  1. Parse and migrate the old instances form (requires knowing its syntax)
  2. Reject with a helpful error pointing users to the new form (requires knowing what the old form looks like so it can be detected)

Neither is possible without knowing what the deprecated syntax was.

Fix Needed

Add one of the following to §8.7 or a dedicated "Migration" appendix:

  1. The YAML syntax of the old instances section with an example
  2. A clear statement that instances keys should be rejected with ConfigurationError pointing to the inline form, along with a note on its former structure for documentation purposes

References

  • §3.2 — Top-Level Sections (instances listed as deprecated)
  • §8.7 — Template Instances (current form, does not describe old form)
## Problem §3.2 lists `instances` as a valid (but deprecated) top-level section: > | `instances` | No | mapping | Template instances (deprecated form). (§8.7) | However, §8.7 describes only the current inline instantiation form. The syntax of the old `instances` section — what it looked like and how it differs from the current form — is never described anywhere in the spec. A library must be able to either: 1. **Parse and migrate** the old `instances` form (requires knowing its syntax) 2. **Reject with a helpful error** pointing users to the new form (requires knowing what the old form looks like so it can be detected) Neither is possible without knowing what the deprecated syntax was. ## Fix Needed Add one of the following to §8.7 or a dedicated "Migration" appendix: 1. The YAML syntax of the old `instances` section with an example 2. A clear statement that `instances` keys should be rejected with `ConfigurationError` pointing to the inline form, along with a note on its former structure for documentation purposes ## References - §3.2 — Top-Level Sections (`instances` listed as deprecated) - §8.7 — Template Instances (current form, does not describe old form)
Sign in to join this conversation.
No milestone
No project
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
cleveragents/actors-spec#16
No description provided.