@adobe/helix-pipeline/docs/content.schema.json

This project provides helper functions and default implementations for creating Hypermedia Processing Pipelines.

{"meta:license":["Copyright 2018 Adobe. All rights reserved.","This file is licensed to you under the Apache License, Version 2.0 (the \"License\");","you may not use this file except in compliance with the License. You may obtain a copy","of the License at http://www.apache.org/licenses/LICENSE-2.0","","Unless required by applicable law or agreed to in writing, software distributed under","the License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS","OF ANY KIND, either express or implied. See the License for the specific language","governing permissions and limitations under the License."],"$id":"https://ns.adobe.com/helix/pipeline/content","$schema":"http://json-schema.org/draft-07/schema#","title":"Content","meta:status":"stabilizing","type":"object","description":"The `content` object represents the content that is being processed in the pipeline.\n\nWith each step of the pipeline, the `content` will be enriched and gain additional properties.\n\nIn a typical processing, `content` will start empty, and then gain a [`body`](#body) as the resource is fetched from the content repository.\n\nIn the second step, the `body` will be parsed using a Markdown parser, resulting in the populated [`mdast`](#mdast) property, which is a representation of the Markdown.\n\nAfter that, the Markdown AST is processed furthermore to extract [`sections`](#meta), [`title`](#title), [`intro`](#intro), and [`meta`](#meta).","additionalProperties":false,"properties":{"sources":{"type":"array","description":"List of URIs that have been retrieved for this piece of content","items":{"type":"string"}},"body":{"type":"string","description":"The content body of the retrieved source document"},"mdast":{"$ref":"https://ns.adobe.com/helix/pipeline/mdast"},"document":{"type":"object","description":"The DOM-compatible representation of the document's inner HTML"},"json":{"type":"object","description":"The JSON object to emit."},"xml":{"type":"object","description":"The XML object to emit. See xmlbuilder-js for syntax."},"meta":{"$ref":"https://ns.adobe.com/helix/pipeline/meta#/definitions/meta"},"title":{"$ref":"https://ns.adobe.com/helix/pipeline/meta#/definitions/meta/properties/title"},"intro":{"$ref":"https://ns.adobe.com/helix/pipeline/meta#/definitions/meta/properties/intro"},"image":{"$ref":"https://ns.adobe.com/helix/pipeline/meta#/definitions/meta/properties/image"},"data":{"type":"object","description":"Custom object that can hold any user defined data."}}}