File tree Expand file tree Collapse file tree 2 files changed +34
-0
lines changed Expand file tree Collapse file tree 2 files changed +34
-0
lines changed Original file line number Diff line number Diff line change @@ -133,6 +133,30 @@ classes:
133
133
multiple output `FileTypes`. Defaults to the `FileType->id` for
134
134
each supported output file type.
135
135
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
+
136
160
Usage :
137
161
description : >-
138
162
A machine-actionable specification of a set of usage instructions of the
Original file line number Diff line number Diff line change @@ -59,6 +59,16 @@ classes:
59
59
These should match `FileTypes` present in the registry. They can
60
60
be specified on extractor execution using the templates described
61
61
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.
62
72
source_repository :
63
73
description : >-
64
74
A URL or URI for a source code repository associated with this
You can’t perform that action at this time.
0 commit comments