Use it when reviewing YAML, graded proposals and unmapped elements before acceptance; use object_import to draft or apply. Returns the named object, proposals and differences from its registered definition. Supply importId and the exact object name. Reading never rewrites the staged report. Full schema: oods://schemas/object_import_read.input.json.

Inputs

Name Type Required Description
action "show" yes Choose show.
importId string no Content-addressed import id from draft. Required by show and apply.
object string no Exact draft object name for show.

Outputs: draft

Name Type Required Description
action "draft" yes
importId string yes
directory string yes
contentHash string yes
counts object yes
objectCount integer yes
objects string[] yes
objectsTruncated boolean yes
shippedClashes string[] yes
diff object yes
proposalGrades object yes
cycleCount integer yes
files object yes
proposalTraits object no

Outputs: show

Name Type Required Description
action "show" yes
importId string yes
name string yes
yaml string yes
proposals object[] yes
unmapped object[] yes
diff object yes

Outputs: apply

Name Type Required Description
action "apply" yes
importId string yes
count integer yes
applied object[] yes

A real call

Recorded by this site's tools run, step object-import-show, with the published OODS Foundry 0.11.0.

Its input:

{
  "action": "show",
  "importId": "import-9b81d91c8453593c6acffa0af9d2d7ac36590eeb9230fe43200055cf1cc1628c",
  "object": "Error"
}

Its result:

{
  "action": "show",
  "importId": "import-9b81d91c8453593c6acffa0af9d2d7ac36590eeb9230fe43200055cf1cc1628c",
  "name": "Error",
  "yaml": "metadata:\n  references:\n    - petstore.yaml#/components/schemas/Error\n  supportedContexts:\n    - list\n    - detail\n    - form\nobject:\n  description: Imported Error schema. Samples without source examples are illustrative.\n  domain: imported\n  name: Error\n  version: 1.0.0\nrelationships: []\nsamples:\n  - code: 1\n    message: Message 1\n  - code: 2\n    message: Message 2\n  - code: 3\n    message: Message 3\n  - code: 4\n    message: Message 4\n  - code: 5\n    message: Message 5\nschema:\n  code:\n    description: ''\n    required: true\n    type: integer\n    validation:\n      format: int32\n  message:\n    description: ''\n    required: true\n    type: string\nsemantics:\n  message:\n    semantic_type: text.label\n    token_mapping: tokenMap(text.primary)\ntokens: {}\ntraits: []\n",
  "proposals": [],
  "unmapped": [],
  "diff": {
    "name": "Error",
    "status": "new",
    "fields": {
      "added": [
        "code",
        "message"
      ],
      "removed": [],
      "changed": []
    },
    "screens": [
      "list",
      "detail",
      "form"
    ],
    "traitsChanged": false,
    "relationshipsChanged": false
  }
}

The whole call, 2 KB of JSON