@open-resource-discovery/specification 1.10.0 → 1.11.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (8) hide show
  1. package/README.md +2 -1
  2. package/dist/types/v1/Configuration.d.ts +12 -1
  3. package/dist/types/v1/Document.d.ts +111 -59
  4. package/package.json +5 -5
  5. package/static/spec-v1/interfaces/Configuration.annotated.schema.json +17 -2
  6. package/static/spec-v1/interfaces/Configuration.schema.json +17 -2
  7. package/static/spec-v1/interfaces/Document.annotated.schema.json +596 -72
  8. package/static/spec-v1/interfaces/Document.schema.json +418 -66
package/static/spec-v1/interfaces/Configuration.annotated.schema.json CHANGED
@@ -2,6 +2,7 @@
2
2
  "description": "The ORD configuration response will indicate that ORD is available for the given host and how to proceed with the discovery.\n\nMost notably, the ORD configuration will tell an ORD consumer which ORD documents are available and where/how they can be accessed.\n\nThe configuration endpoint is a [Well-Known URI](https://tools.ietf.org/html/rfc8615#section-3) discovery mechanism.",
3
3
  "$schema": "http://json-schema.org/draft-07/schema#",
4
4
  "$id": "https://open-resource-discovery.github.io/specification/spec-v1/interfaces/Configuration.schema.json#",
5
+ "title": "ORD Configuration",
5
6
  "definitions": {
6
7
  "OpenResourceDiscoveryV1": {
7
8
  "type": "object",
@@ -14,6 +15,9 @@
14
15
  "items": {
15
16
  "$ref": "#/definitions/V1DocumentDescription"
16
17
  }
18
+ },
19
+ "capabilities": {
20
+ "$ref": "#/definitions/V1Capabilities"
17
21
  }
18
22
  },
19
23
  "additionalProperties": false
@@ -56,6 +60,18 @@
56
60
  "accessStrategies"
57
61
  ]
58
62
  },
63
+ "V1Capabilities": {
64
+ "type": "object",
65
+ "title": "ORD V1 Capabilities",
66
+ "description": "List of capabilities that are supported by the ORD provider.",
67
+ "properties": {
68
+ "selector": {
69
+ "type": "boolean",
70
+ "default": false,
71
+ "description": "Whether the ORD provider supports the optional [select parameter](../index.md#select-parameter) for retrieving the ORD config and ORD documents."
72
+ }
73
+ }
74
+ },
59
75
  "AccessStrategy": {
60
76
  "type": "object",
61
77
  "title": "Access Strategy",
@@ -124,13 +140,12 @@
124
140
  ]
125
141
  }
126
142
  },
127
- "title": "ORD Configuration",
128
143
  "type": "object",
129
144
  "properties": {
130
145
  "$schema": {
131
146
  "type": "string",
132
147
  "format": "uri-reference",
133
- "description": "Optional URL to the ORD document schema (defined as JSON Schema).\nIf given, this enables code intelligence and validation in supported editors (like VSCode) and tools.",
148
+ "description": "Optional URL to the ORD Configuration schema (defined as JSON Schema).\nIf given, this enables code intelligence and validation in supported editors (like VSCode) and tools.",
134
149
  "anyOf": [
135
150
  {
136
151
  "type": "string",
package/static/spec-v1/interfaces/Configuration.schema.json CHANGED
@@ -1,6 +1,7 @@
1
1
  {
2
2
  "$schema": "http://json-schema.org/draft-07/schema#",
3
3
  "$id": "https://open-resource-discovery.github.io/specification/spec-v1/interfaces/Configuration.schema.json#",
4
+ "title": "ORD Configuration",
4
5
  "description": "The ORD configuration response will indicate that ORD is available for the given host and how to proceed with the discovery.\n\nMost notably, the ORD configuration will tell an ORD consumer which ORD documents are available and where/how they can be accessed.\n\nThe configuration endpoint is a [Well-Known URI](https://tools.ietf.org/html/rfc8615#section-3) discovery mechanism.",
5
6
  "definitions": {
6
7
  "OpenResourceDiscoveryV1": {
@@ -14,6 +15,9 @@
14
15
  "items": {
15
16
  "$ref": "#/definitions/V1DocumentDescription"
16
17
  }
18
+ },
19
+ "capabilities": {
20
+ "$ref": "#/definitions/V1Capabilities"
17
21
  }
18
22
  },
19
23
  "additionalProperties": false
@@ -56,6 +60,18 @@
56
60
  "accessStrategies"
57
61
  ]
58
62
  },
63
+ "V1Capabilities": {
64
+ "type": "object",
65
+ "title": "ORD V1 Capabilities",
66
+ "description": "List of capabilities that are supported by the ORD provider.",
67
+ "properties": {
68
+ "selector": {
69
+ "type": "boolean",
70
+ "default": false,
71
+ "description": "Whether the ORD provider supports the optional [select parameter](../index.md#select-parameter) for retrieving the ORD config and ORD documents."
72
+ }
73
+ }
74
+ },
59
75
  "AccessStrategy": {
60
76
  "type": "object",
61
77
  "title": "Access Strategy",
@@ -124,13 +140,12 @@
124
140
  ]
125
141
  }
126
142
  },
127
- "title": "ORD Configuration",
128
143
  "type": "object",
129
144
  "properties": {
130
145
  "$schema": {
131
146
  "type": "string",
132
147
  "format": "uri-reference",
133
- "description": "Optional URL to the ORD document schema (defined as JSON Schema).\nIf given, this enables code intelligence and validation in supported editors (like VSCode) and tools.",
148
+ "description": "Optional URL to the ORD Configuration schema (defined as JSON Schema).\nIf given, this enables code intelligence and validation in supported editors (like VSCode) and tools.",
134
149
  "anyOf": [
135
150
  {
136
151
  "type": "string",