odm-specification-dpdescriptor/examples/tripexecution/ports/trip-status-oport.json at main · opendatamesh-initiative/odm-specification-dpdescriptor · GitHub

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
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
{
    "fullyQualifiedName": "urn:dpds:com.company-xyz:dataproducts:tripExecution:1:outputports:tripStatus",
    "name": "tripStatus",
    "displayName": "Trip Status",
    "description": "The last known status of each trip operated in the last 12 months",
    "version": "1.2.0",
    "promises": {
        "platform": "westeurope.azure::postgres",
        "serviceType": "datastore-services",
        "api": {
            "name": "tripStatusApi",
            "version": "1.0.0",
            "specification": "datastoreapi",
            "specificationVersion": "1.0.0",
            "definition": {
                "mediaType": "text/json",
                "$ref": "trip-status-oport-api.json"
            },
            "externalDocs": {
                "description": "The OpenAPI v3.1.0 specification used to define the API of this port",
                "mediaType": "text/html",
                "$href": "https://spec.openapis.org/oas/v3.1.0"
            }
        },
        "deprecationPolicy": {
            "name": "policy",
            "version": "1.0.0",
            "specification": "custom",
            "description": "When a new major version become available the previous one is kept online for 3 months",
            "definition": {
                "x-deprecation-period": "3M"
            }
        },
        "slo": {
            "name": "slo",
            "version": "1.0.0",
            "specification": "custom",
            "description": "The slo are hight for all base service indicators because this service is business critical",
            "definition": {
                "x-operationalSlo": {
                    "availability": "0.99999",
                    "responsetime": "1s"
                },
                "x-qualitySlo": {
                    "freshness": "5m"
                }
            }
        }
    },
    "expectatctions": {
        "audience": {
            "name": "audience",
            "version": "1.0.0",
            "specification": "custom",
            "description": "This port is designed to help operations departments. It is not for customer care and finance departments",
            "definition": {
                "x-includes": [
                    "operations"
                ],
                "x-excludes": [
                    "customer-care",
                    "finance"
                ]
            }
        },
        "usage": {
            "name": "usage",
            "version": "1.0.0",
            "specification": "custom",
            "description": "This port is designed to operational access not for analysis",
            "definition": {
                "x-filterOn": [
                    "id"
                ],
                "x-forbiddenOperations": [
                    "group-by",
                    "unfiltered-selections"
                ]
            }
        }
    },
    "obligations": {
        "termsAndConditions": {
            "name": "termsAndConditions",
            "version": "1.0.0",
            "specification": "custom",
            "description": "A detailed description of the data product, that include also the target audience",
            "definition": {},
            "externalDocs": {
                "mediaType": "text/html",
                "$href": "https://wiki.example-xyz.com/corporate-mesh/dp/trip-execution.html#terms-and-conditions"
            }
        },
        "billingPolicy": {
            "name": "billingPolicy",
            "version": "1.0.0",
            "specification": "custom",
            "description": "This port is billed by number of monthly queries",
            "definition": {
                "x-billingUnit": "milion queries",
                "x-pricePerUnit": 0.01,
                "x-billingPeriod": "month"
            }
        },
        "sla": {
            "name": "sla",
            "version": "1.0.0",
            "specification": "custom",
            "description": "The sla are hight for all base service indicators because this service is business critical",
            "definition": {
                "x-operationalSla": {
                    "availability": "0.999",
                    "responsetime": "5s"
                },
                "x-qualitySla": {
                    "freshness": "10m"
                }
            }
        }
    }
}