xref: /openbmc/bmcweb/redfish-core/schema/dmtf/json-schema/JobDocumentCollection.json (revision c6d7a45d427f9a6d9e761afcf305761dca60d7cf)
1*c6d7a45dSGunnar Mills{
2*c6d7a45dSGunnar Mills    "$id": "http://redfish.dmtf.org/schemas/v1/JobDocumentCollection.json",
3*c6d7a45dSGunnar Mills    "$ref": "#/definitions/JobDocumentCollection",
4*c6d7a45dSGunnar Mills    "$schema": "http://redfish.dmtf.org/schemas/v1/redfish-schema-v1.json",
5*c6d7a45dSGunnar Mills    "copyright": "Copyright 2014-2025 DMTF. For the full DMTF copyright policy, see http://www.dmtf.org/about/policies/copyright",
6*c6d7a45dSGunnar Mills    "definitions": {
7*c6d7a45dSGunnar Mills        "JobDocumentCollection": {
8*c6d7a45dSGunnar Mills            "anyOf": [
9*c6d7a45dSGunnar Mills                {
10*c6d7a45dSGunnar Mills                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/idRef"
11*c6d7a45dSGunnar Mills                },
12*c6d7a45dSGunnar Mills                {
13*c6d7a45dSGunnar Mills                    "additionalProperties": false,
14*c6d7a45dSGunnar Mills                    "description": "The collection of `JobDocument` resource instances.",
15*c6d7a45dSGunnar Mills                    "longDescription": "This resource shall represent a resource collection of `JobDocument` instances for a Redfish implementation.",
16*c6d7a45dSGunnar Mills                    "patternProperties": {
17*c6d7a45dSGunnar Mills                        "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
18*c6d7a45dSGunnar Mills                            "description": "This property shall specify a valid odata or Redfish property.",
19*c6d7a45dSGunnar Mills                            "type": [
20*c6d7a45dSGunnar Mills                                "array",
21*c6d7a45dSGunnar Mills                                "boolean",
22*c6d7a45dSGunnar Mills                                "integer",
23*c6d7a45dSGunnar Mills                                "number",
24*c6d7a45dSGunnar Mills                                "null",
25*c6d7a45dSGunnar Mills                                "object",
26*c6d7a45dSGunnar Mills                                "string"
27*c6d7a45dSGunnar Mills                            ]
28*c6d7a45dSGunnar Mills                        }
29*c6d7a45dSGunnar Mills                    },
30*c6d7a45dSGunnar Mills                    "properties": {
31*c6d7a45dSGunnar Mills                        "@odata.context": {
32*c6d7a45dSGunnar Mills                            "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/context"
33*c6d7a45dSGunnar Mills                        },
34*c6d7a45dSGunnar Mills                        "@odata.etag": {
35*c6d7a45dSGunnar Mills                            "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/etag"
36*c6d7a45dSGunnar Mills                        },
37*c6d7a45dSGunnar Mills                        "@odata.id": {
38*c6d7a45dSGunnar Mills                            "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/id"
39*c6d7a45dSGunnar Mills                        },
40*c6d7a45dSGunnar Mills                        "@odata.type": {
41*c6d7a45dSGunnar Mills                            "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/type"
42*c6d7a45dSGunnar Mills                        },
43*c6d7a45dSGunnar Mills                        "Description": {
44*c6d7a45dSGunnar Mills                            "anyOf": [
45*c6d7a45dSGunnar Mills                                {
46*c6d7a45dSGunnar Mills                                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Description"
47*c6d7a45dSGunnar Mills                                },
48*c6d7a45dSGunnar Mills                                {
49*c6d7a45dSGunnar Mills                                    "type": "null"
50*c6d7a45dSGunnar Mills                                }
51*c6d7a45dSGunnar Mills                            ],
52*c6d7a45dSGunnar Mills                            "readonly": true
53*c6d7a45dSGunnar Mills                        },
54*c6d7a45dSGunnar Mills                        "Members": {
55*c6d7a45dSGunnar Mills                            "description": "The members of this collection.",
56*c6d7a45dSGunnar Mills                            "items": {
57*c6d7a45dSGunnar Mills                                "$ref": "http://redfish.dmtf.org/schemas/v1/JobDocument.json#/definitions/JobDocument"
58*c6d7a45dSGunnar Mills                            },
59*c6d7a45dSGunnar Mills                            "longDescription": "This property shall contain an array of links to the members of this collection.",
60*c6d7a45dSGunnar Mills                            "readonly": true,
61*c6d7a45dSGunnar Mills                            "type": "array"
62*c6d7a45dSGunnar Mills                        },
63*c6d7a45dSGunnar Mills                        "Members@odata.count": {
64*c6d7a45dSGunnar Mills                            "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count"
65*c6d7a45dSGunnar Mills                        },
66*c6d7a45dSGunnar Mills                        "Members@odata.nextLink": {
67*c6d7a45dSGunnar Mills                            "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/nextLink"
68*c6d7a45dSGunnar Mills                        },
69*c6d7a45dSGunnar Mills                        "Name": {
70*c6d7a45dSGunnar Mills                            "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Name",
71*c6d7a45dSGunnar Mills                            "readonly": true
72*c6d7a45dSGunnar Mills                        },
73*c6d7a45dSGunnar Mills                        "Oem": {
74*c6d7a45dSGunnar Mills                            "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem",
75*c6d7a45dSGunnar Mills                            "description": "The OEM extension property.",
76*c6d7a45dSGunnar Mills                            "longDescription": "This property shall contain the OEM extensions.  All values for properties contained in this object shall conform to the Redfish Specification-described requirements."
77*c6d7a45dSGunnar Mills                        }
78*c6d7a45dSGunnar Mills                    },
79*c6d7a45dSGunnar Mills                    "required": [
80*c6d7a45dSGunnar Mills                        "Members",
81*c6d7a45dSGunnar Mills                        "Members@odata.count",
82*c6d7a45dSGunnar Mills                        "@odata.id",
83*c6d7a45dSGunnar Mills                        "@odata.type",
84*c6d7a45dSGunnar Mills                        "Name"
85*c6d7a45dSGunnar Mills                    ],
86*c6d7a45dSGunnar Mills                    "type": "object"
87*c6d7a45dSGunnar Mills                }
88*c6d7a45dSGunnar Mills            ],
89*c6d7a45dSGunnar Mills            "deletable": false,
90*c6d7a45dSGunnar Mills            "insertable": true,
91*c6d7a45dSGunnar Mills            "updatable": false,
92*c6d7a45dSGunnar Mills            "uris": [
93*c6d7a45dSGunnar Mills                "/redfish/v1/JobService/Documents"
94*c6d7a45dSGunnar Mills            ]
95*c6d7a45dSGunnar Mills        }
96*c6d7a45dSGunnar Mills    },
97*c6d7a45dSGunnar Mills    "language": "en",
98*c6d7a45dSGunnar Mills    "owningEntity": "DMTF",
99*c6d7a45dSGunnar Mills    "title": "#JobDocumentCollection.JobDocumentCollection"
100*c6d7a45dSGunnar Mills}