Skip to content

Commit f451963

Browse files
committed
Playing around with possible output schemas
1 parent 855e927 commit f451963

File tree

2 files changed

+34
-0
lines changed

2 files changed

+34
-0
lines changed

schemas/base.yaml

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -133,6 +133,30 @@ classes:
133133
multiple output `FileTypes`. Defaults to the `FileType->id` for
134134
each supported output file type.
135135
136+
OutputSchema:
137+
description: >-
138+
A human-readable specification of the schema that the output of an `Extractor`.
139+
attributes:
140+
supported_filetypes:
141+
range: SupportedFileType
142+
multivalued: true
143+
required: false
144+
description: >-
145+
The file types that this schema can be used for; defaults to all if not provided.
146+
schema:
147+
required: true
148+
description: >-
149+
A human-readable schema definition, with a reference to a machine-actionable
150+
schema definition if available.
151+
attributes:
152+
description:
153+
description: >-
154+
A human-readable description of the schema and its usage.
155+
href:
156+
description: >-
157+
A URL or URI for a machine-actionable schema definition.
158+
159+
136160
Usage:
137161
description: >-
138162
A machine-actionable specification of a set of usage instructions of the

schemas/extractor.yaml

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,16 @@ classes:
5959
These should match `FileTypes` present in the registry. They can
6060
be specified on extractor execution using the templates described
6161
in the `Extractor->Usage->command` slot, [see the `Usage` class](Usage.md).
62+
supported_output_schemas:
63+
multivalued: true
64+
required: false
65+
range: OutputSchema
66+
description: >-
67+
A description of the schema that a extractor output can follow; this may be
68+
scoped per file type, or a global schema that works for all file types.
69+
This should refer to any machine-actionable schema definition, for example,
70+
JSONSchema, XMLSchema, or it may refer to a self-describing format such as
71+
JSON-LD or RDF.
6272
source_repository:
6373
description: >-
6474
A URL or URI for a source code repository associated with this

0 commit comments

Comments
 (0)