stackql-devel/docs/examples/registry/src/publicapis/v1/services/api-v1.yaml at main · stackql/stackql-devel · 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
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
components:
  schemas:
    Api:
      type: object
      properties:
        API:
          type: string
        Description:
          type: string
        Auth:
          type: string
        HTTPS:
          type: string
        Cors:
          type: boolean
        Link:
          type: string
    ApiList:
      type: object
      properties:
        count:
          type: integer
        entries:
          items:
            $ref: '#/components/schemas/Api'
          type: array
    CategoryList:
      type: object
      properties:
        count:
          type: integer
        categories:
          items:
            type: string
          type: array
    HealthStatus:
      type: string
  x-stackQL-resources:
    apis:
      id: publicapis.api.apis
      name: apis
      title: apis
      methods:
        list:
          operation:
            $ref: GET
          path:
            $ref: /entries
          response:
            mediaType: application/json
            openAPIDocKey: '200'
            objectKey: entries
    random:
      id: publicapis.api.random
      name: random
      title: random
      methods:
        list:
          operation:
            $ref: GET
          path:
            $ref: /random
          response:
            mediaType: application/json
            openAPIDocKey: '200'
            objectKey: entries
    categories:
      id: publicapis.api.categories
      name: categories
      title: categories
      methods:
        list:
          operation:
            $ref: GET
          path:
            $ref: /categories
          response:
            mediaType: application/json
            openAPIDocKey: '200'
            objectKey: categories
    health:
      id: publicapis.api.health
      name: health
      title: health
      methods:
        get:
          operation:
            $ref: GET
          path:
            $ref: /health
          response:
            mediaType: text/plain
            openAPIDocKey: '200'
externalDocs:
  description: Find more info here
  url: https://api.publicapis.org/
info:
  contact:
    url: https://api.publicapis.org/
  x-serviceName: api
openapi: 3.0.1
paths:
  /entries:
    get:
      description: apis currently present in the repository.
        Can be filtered through parameters.
      parameters:
      - description: 'name of entry (matches via substring - i.e. "at" would return "cat" and "atlas")'
        in: query
        name: title
        schema:
          type: string
      - description: description of entry (matches via substring)
        in: query
        name: description
        schema:
          type: string
      - description: auth type of entry (can only be values matching in project or null)
        in: query
        name: auth
        schema:
          type: string
      - description: return entries that support HTTPS or not
        in: query
        name: https
        schema:
          type: boolean
      - description: 'CORS support for entry ("yes", "no", or "unknown")'
        in: query
        name: cors
        schema:
          type: string
      - description: return entries of a specific category
        in: query
        name: category
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiList'
          description: Success
  /random:
    get:
      description: random selection from apis currently present in the repository.
        Can be filtered through parameters.
      parameters:
      - description: 'name of entry (matches via substring - i.e. "at" would return "cat" and "atlas")'
        in: query
        name: title
        schema:
          type: string
      - description: description of entry (matches via substring)
        in: query
        name: description
        schema:
          type: string
      - description: auth type of entry (can only be values matching in project or null)
        in: query
        name: auth
        schema:
          type: string
      - description: return entries that support HTTPS or not
        in: query
        name: https
        schema:
          type: boolean
      - description: 'CORS support for entry ("yes", "no", or "unknown")'
        in: query
        name: cors
        schema:
          type: string
      - description: return entries of a specific category
        in: query
        name: category
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiList'
          description: Success
  /categories:
    get:
      description: list of categories currently present.
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CategoryList'
          description: Success
  /health:
    get:
      description: apis currently present in the repository.
        Can be filtered through parameters.
      responses:
        '200':
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/HealthStatus'
          description: Success
servers:
- url: https://api.publicapis.org