ludusavi/docs/schema/api-input.yaml at master · mtkennerly/ludusavi · 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
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
---
$schema: "http://json-schema.org/draft-07/schema#"
title: Input
description: "The full input to the `api` command."
type: object
required:
  - requests
properties:
  config:
    description: Override configuration.
    default:
      backupPath: ~
    allOf:
      - $ref: "#/definitions/ConfigOverride"
  requests:
    description: The order of the requests here will match the order of responses in the output.
    type: array
    items:
      $ref: "#/definitions/Request"
definitions:
  CheckAppUpdate:
    description: Check whether an application update is available.
    type: object
  ConfigOverride:
    description: Overridden configuration.
    type: object
    properties:
      backupPath:
        description: Directory where Ludusavi stores backups.
        anyOf:
          - $ref: "#/definitions/FilePath"
          - type: "null"
  EditBackup:
    description: "Edit a backup's metadata."
    type: object
    properties:
      backup:
        description: "Edit a specific backup, using an ID returned by the `backups` command. When not specified, this defaults to the latest backup."
        default: ~
        type:
          - string
          - "null"
      comment:
        description: "If set, update the backup's comment. To delete an existing comment, set this to an empty string."
        default: ~
        type:
          - string
          - "null"
      game:
        description: Which game to edit.
        default: ""
        type: string
      locked:
        description: "If set, indicates whether the backup should be locked."
        default: ~
        type:
          - boolean
          - "null"
  FilePath:
    type: string
  FindTitle:
    description: "Find game titles\n\nPrecedence: Steam ID -> GOG ID -> Lutris ID -> exact names -> normalized names. Once a match is found for one of these options, Ludusavi will stop looking and return that match, unless you set `multiple: true`, in which case, the results will be sorted by how well they match.\n\nDepending on the options chosen, there may be multiple matches, but the default is a single match.\n\nAliases will be resolved to the target title."
    type: object
    properties:
      backup:
        description: Ensure the game is recognized in a backup context.
        default: false
        type: boolean
      disabled:
        description: Select games that are disabled.
        default: false
        type: boolean
      fuzzy:
        description: Look up games with fuzzy matching. This may find multiple games for a single input.
        default: false
        type: boolean
      gogId:
        description: Look up game by a GOG ID.
        default: ~
        type:
          - integer
          - "null"
        format: uint64
        minimum: 0.0
      lutrisId:
        description: Look up game by a Lutris slug.
        default: ~
        type:
          - string
          - "null"
      multiple:
        description: "Keep looking for all potential matches, instead of stopping at the first match."
        default: false
        type: boolean
      names:
        description: "Look up game by an exact title. With multiple values, they will be checked in the order given."
        default: []
        type: array
        items:
          type: string
      normalized:
        description: "Look up game by an approximation of the title. Ignores capitalization, \"edition\" suffixes, year suffixes, and some special symbols. This may find multiple games for a single input."
        default: false
        type: boolean
      partial:
        description: Select games that have some saves disabled.
        default: false
        type: boolean
      restore:
        description: Ensure the game is recognized in a restore context.
        default: false
        type: boolean
      steamId:
        description: Look up game by a Steam ID.
        default: ~
        type:
          - integer
          - "null"
        format: uint32
        minimum: 0.0
  Request:
    description: An individual request.
    oneOf:
      - type: object
        required:
          - findTitle
        properties:
          findTitle:
            $ref: "#/definitions/FindTitle"
        additionalProperties: false
      - type: object
        required:
          - checkAppUpdate
        properties:
          checkAppUpdate:
            $ref: "#/definitions/CheckAppUpdate"
        additionalProperties: false
      - type: object
        required:
          - editBackup
        properties:
          editBackup:
            $ref: "#/definitions/EditBackup"
        additionalProperties: false