@portpowered/reference-data 0.4.4 → 0.4.6

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.
@@ -1,22 +1,50 @@
1
1
  {
2
2
  "$schema": "http://json-schema.org/draft-07/schema#",
3
3
  "type": "object",
4
+ "additionalProperties": false,
4
5
  "required": [
5
6
  "query"
6
7
  ],
7
8
  "properties": {
8
9
  "query": {
9
- "$ref": "/docs/references/schemas/Query.json"
10
+ "$ref": "/docs/references/schemas/Query.json",
11
+ "description": "A bounded shared Query expression. An empty object selects unfiltered readable inventory. This endpoint supports match, and, or, and not. Scalar match keys are id, name, type, ownerId, manufacturer, model, and enablement. interfaces matches membership in the endpoint's declared interface names; groupId matches membership in a readable endpoint group. Comparisons, patterns, freeform search, unknown keys, ambiguous nodes, expressions deeper than eight levels, or more than 64 nodes return 400. Values are exact strings. Collections hide disabled endpoints unless the expression explicitly filters enablement. Results include readable shared endpoints, regardless of their owner. A groupId predicate additionally requires group:read for delegated OAuth and read permission on that group."
10
12
  },
11
13
  "paginationContext": {
12
- "$ref": "/docs/references/schemas/PaginationContext.json"
14
+ "type": "object",
15
+ "additionalProperties": false,
16
+ "properties": {
17
+ "maxResults": {
18
+ "type": "integer",
19
+ "minimum": 1,
20
+ "maximum": 100,
21
+ "default": 10,
22
+ "description": "Maximum authorized matching endpoints in this page."
23
+ },
24
+ "nextToken": {
25
+ "type": "string",
26
+ "minLength": 1,
27
+ "description": "Opaque server-issued continuation token. Repeat the same query, page size, expansions, forceDeviceQuery setting, and authenticated grant. Modified, expired, or differently bound tokens return 400; restart without nextToken. Follow nextToken until absent, including empty pages."
28
+ }
29
+ }
13
30
  },
14
31
  "expand": {
15
32
  "type": "array",
16
- "description": "Expansion tokens that request related or computed endpoint fields.",
33
+ "uniqueItems": true,
34
+ "maxItems": 1,
35
+ "description": "Optional reported state expansion; only interfaces.attributes is supported.",
17
36
  "items": {
18
- "type": "string"
37
+ "type": "string",
38
+ "enum": [
39
+ "interfaces.attributes"
40
+ ],
41
+ "x-enum-exempt": "Existing published REST expansion token shared with GET /endpoints."
19
42
  }
43
+ },
44
+ "forceDeviceQuery": {
45
+ "type": "boolean",
46
+ "default": false,
47
+ "description": "Refresh reported device attributes for the selected page. Requires expand to contain interfaces.attributes. An accepted command is not proof of device state; inspect the returned sample times and partial errors. Disabled endpoints cannot be forcibly refreshed."
20
48
  }
21
49
  }
22
50
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@portpowered/reference-data",
3
- "version": "0.4.4",
3
+ "version": "0.4.6",
4
4
  "private": false,
5
5
  "publishConfig": { "access": "public" },
6
6
  "repository": { "type": "git", "url": "https://github.com/portpowered/portos-reference-data.git" },