Skip to content

Commit 457f42e

Browse files
committed
describe additional metadata
1 parent e911731 commit 457f42e

File tree

1 file changed

+21
-16
lines changed

1 file changed

+21
-16
lines changed

README.md

+21-16
Original file line numberDiff line numberDiff line change
@@ -178,26 +178,28 @@ Once the [event `end-all`](#validation-events) is emitted, the metadata should b
178178
The `options` accepted are equal to those in `validate()`, except that a `profile` is not necessary and will be ignored (finding out the profile is one of the
179179
goals of this method).
180180

181-
`this.meta` will be an `Object` and may include up to 16 properties described below:
181+
`this.meta` will be an `Object` and may include up to 20 properties described below:
182182

183183
- `profile`
184-
- `title`: The (possible) title of the document.
185-
- `docDate`: The date associated to the document.
186-
- `thisVersion`: URL of this version of the document.
187-
- `latestVersion`: URL of the latest version of the document.
188-
- `previousVersion`: URL of the previous version of the document (the last one, if multiple are shown).
189-
- `editorsDraft`: URL of the latest editor's draft.
190-
- `delivererIDs`: ID(s) of the deliverer(s); an `Array` of `Number`s.
191-
- `editorIDs`: ID(s) of the editor(s) responsible for the document; an `Array` of `Number`s.
192-
- `informative`: Whether the document in informative or not.
193-
- `process`: The process rules link.
194-
- `sameWorkAs`: The previous shortlink if any.
195-
- `implementationFeedbackDue`: The implementation review date for CRs.
196-
- `prReviewsDue`: The review date for PRs.
197-
- `implementationReport`: Implementation report link for CRs, PRs and RECs.
198-
- `errata`: The errata link of the document.
184+
- `title`: The (possible) title of the document
185+
- `docDate`: The date associated to the document
186+
- `thisVersion`: URL of this version of the document
187+
- `latestVersion`: URL of the latest version of the document
188+
- `previousVersion`: URL of the previous version of the document (the last one, if multiple are shown)
189+
- `editorsDraft`: URL of the latest editor's draft
190+
- `delivererIDs`: ID(s) of the deliverer(s); an `Array` of `Number`s
191+
- `editorIDs`: ID(s) of the editor(s) responsible for the document; an `Array` of `Number`s
192+
- `informative`: Whether the document in informative or not
193+
- `process`: The process rules link
194+
- `sameWorkAs`: The previous shortlink if any
195+
- `implementationFeedbackDue`: The implementation review date for CRs
196+
- `prReviewsDue`: The review date for PRs
197+
- `implementationReport`: Implementation report link for CRs, PRs and RECs
198+
- `errata`: The errata link of the document
199199
- `substantiveChanges`: Whether the document is a REC and has proposed amendments
200200
- `newFeatures`: Whether the document is a REC and has proposed additions
201+
- `sotd`: The section "Status of this Document"
202+
- `abstract`: The abstract of the document
201203

202204
If some of these pieces of metadata cannot be deduced, that key will not exist, or its value will not be defined.
203205

@@ -259,6 +261,9 @@ curl "https://www.w3.org/pubrules/api/metadata?url=https://example.com/doc.html"
259261

260262
# POST
261263
curl "https://www.w3.org/pubrules/api/metadata" -F "file=@/tmp/foo.html"
264+
265+
# GET with additional metadata
266+
curl "https://www.w3.org/pubrules/api/metadata?url=https://example.com/doc.html&additionalMetadata=true"
262267
```
263268

264269
Metadata is a bunch of data extracted from the document. It includes the type (profile) of the document, publish date, editors' names, Patent Policy version the document is under, etc...

0 commit comments

Comments
 (0)