Skip to content

docs(schema): clarify ValueSpecification.inputs key order and fix FQName/Reference examples in IR v4 #1103

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
whawk46 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs(schema): clarify ValueSpecification.inputs key order and fix FQName/Reference examples in IR v4 #1103

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions website/static/schemas/morphir-ir-v4.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,7 @@ definitions:
- $ref: "#/definitions/ModuleName"
- $ref: "#/definitions/Name"
description: "Legacy array representation: [packageName, moduleName, name]"
examples: [["morphir/SDK", "list", "map"], [["morphir"], ["s", "d", "k"], ["list"], ["map"]]]
examples: [["morphir/SDK", "list", "map"], [[["morphir"], ["s", "d", "k"]], [["list"]], ["map"]]]

# Attributes
SourceLocation:
Expand Down Expand Up @@ -832,7 +832,7 @@ definitions:
Reference to a named type, optionally with type arguments.

Canonical (no args): "morphir/SDK:basics#int"
Canonical (with args): {"Reference": ["morphir/SDK:list#list", "a"]}
Canonical (with args): {"Reference": {"fqname": "morphir/SDK:list#list", "args": ["a"]}}

Accepted formats:
- Bare FQName string: "morphir/SDK:basics#int"
Expand Down Expand Up @@ -2069,7 +2069,7 @@ definitions:
- $ref: "#/definitions/Type"
description: |
Input parameters.
Canonical (output): Object keyed by parameter name: { "x": type, "y": type }
Canonical (output): Object keyed by parameter name: { "x": type, "y": type }. The key order of "inputs" is the parameter order.
Accepted (input): Array format: [["x", type], ["y", type]]
Can be omitted if empty (no inputs).
output: { $ref: "#/definitions/Type" }
Expand All @@ -2079,7 +2079,7 @@ definitions:
description: |
Value specification (public interface - signature only, no implementation).

Canonical format: { "inputs": { "a": type, "b": type }, "output": type }
Canonical format: { "inputs": { "a": type, "b": type }, "output": type }, where the key order of "inputs" is the parameter order.
The "inputs" field can be omitted if empty.

Encoders should output the canonical object format.
Expand Down