AbstractStreamDefinition.1.0.0.json 3.48 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
{
    "schemaInfo": {
        "schemaIdentity": {
            "authority": "{{schema-authority}}",
            "source": "wks",
            "entityType": "AbstractStreamDefinition",
            "schemaVersionMajor": 1,
            "schemaVersionMinor": 0,
            "schemaVersionPatch": 0,
            "id": "{{schema-authority}}:wks:AbstractStreamDefinition:1.0.0"
        },
        "createdBy": "OSDU Data Definition Group",
        "scope": "SHARED",
        "status": "DEVELOPMENT"
    },
    "schema": {
        "x-osdu-license": "Copyright 2021, The Open Group \\nLicensed 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 CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.",
        "x-osdu-review-status": "Proposed",
        "$id": "https://schema.osdu.opengroup.org/json/abstract/AbstractStreamDefinition.1.0.0.json",
        "$schema": "http://json-schema.org/draft-07/schema#",
        "x-osdu-schema-source": "osdu:wks:AbstractStreamDefinition:1.0.0",
        "title": "AbstractStreamDefinition",
        "description": "A schema fragment to describe stream definition.",
        "type": "object",
        "properties": {
            "SubscribeIds": {
                "type": "array",
                "title": "List of SubscribeIDs",
                "description": "List of Ids of the OSDU records for which the stream will be listening for messages. This property is required.",
                "items": {
                    "type": "string",
                    "example": "opendes:work-product-component--WellLog:be54a691c0384182944d71c6b2b6f699"
                }
            },
            "SourceBindings": {
                "type": "array",
                "title": "List of Source Bindings",
                "description": "List of sources to listen for new messages. If not explicitely provided, then the streams admin service can make an attempt to derive them from other parameters.",
                "items": {
                    "type": "string",
                    "example": "opendes_wks_work-product-component--WellLog_1.0.0"
                }
            },
            "SinkBindings": {
                "type": "array",
                "title": "List of Sink Bindings",
                "description": "List of sinks to route output messages to after the stream processing. If not explicitely provided, then the stream admin service will create a new sink.",
                "items": {
                    "type": "string",
                    "example": "opendes_4dc4e8ec354e4953b6968fcb1d9d9f38_work-product-component--WellLog_1.0.0"
                }
            },
            "Filter": {
                "type": "string",
                "title": "Stream Filter",
                "description": "Filtering clause for the processor stream. Syntax is TBD"
            },
            "Aggregate": {
                "type": "string",
                "title": "Stream Aggregator",
                "description": "Aggregation definition for the processor stream. Syntax is TBD"
            }
        },
        "required": [
            "SubscribeIds"
        ],
        "x-osdu-inheriting-from-kind": []
    }
}