steam-scraper-server/openapi.yaml at master · kernel-panic-codecave/steam-scraper-server · 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
openapi: 3.0.0
info:
  license:
    name: GPL-3.0
  title: Scraper
  version: 1.0.0
servers:
- url: https://repo.withertech.com/scraper/api/
security:
- {}
paths:
  /scrape:
    get:
      operationId: scrape
      parameters:
      - description: name of the rom
        explode: true
        in: query
        name: filename
        required: true
        schema:
          type: string
        style: form
      - description: md5 of the rom
        explode: true
        in: query
        name: md5
        required: true
        schema:
          type: string
        style: form
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ImagesResult'
          description: Urls to the images for the rom
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResult'
          description: unexpected error
      summary: Scrapes a rom for steam rom manager from screenscraper.fr using name
        of file and md5 sum
      tags:
      - scrape
components:
  schemas:
    ImagesResult:
      example:
        images:
          icon: https://openapi-generator.tech
          logo: https://openapi-generator.tech
          hero: https://openapi-generator.tech
          tall: https://openapi-generator.tech
          long: https://openapi-generator.tech
        system: system
        name: name
      properties:
        name:
          title: name
          type: string
        system:
          title: system
          type: string
        images:
          $ref: '#/components/schemas/ImagesResult_images'
      required:
      - images
      - name
      - system
      title: ImagesResult
      type: object
    ErrorResult:
      properties:
        code:
          format: int32
          title: code
          type: integer
        message:
          title: message
          type: string
      required:
      - code
      - message
      title: ErrorResult
      type: object
    ImagesResult_images:
      example:
        icon: https://openapi-generator.tech
        logo: https://openapi-generator.tech
        hero: https://openapi-generator.tech
        tall: https://openapi-generator.tech
        head: https://openapi-generator.tech
      properties:
        head:
          format: uri
          title: long
          type: string
        tall:
          format: uri
          title: tall
          type: string
        hero:
          format: uri
          title: hero
          type: string
        logo:
          format: uri
          title: logo
          type: string
        icon:
          format: uri
          title: icon
          type: string
      required:
      - hero
      - icon
      - logo
      - head
      - tall
      title: ImagesResult_images
      type: object