api-typescript-nodejs/spec.yaml at master · romykundal/api-typescript-nodejs · 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
openapi: 3.0.0
info:
  title: Counties
  version: '1.0'
  description: ''
servers:
  - url: 'http://localhost:3000'
paths:
  /suggest:
    parameters: []
    get:
      summary: Suggest Counties
      tags: []
      responses:
        '200':
          description: County Suggestions
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CountySuggestion'
              examples:
                q=cowl:
                  value:
                    - fips: '20035'
                      state: KS
                      name: Cowley
                    - fips: '53015'
                      state: WA
                      name: Cowlitz
                'q=cowlitz, wa':
                  value:
                    - fips: '53015'
                      state: WA
                      name: Cowlitz
                q=wa:
                  value:
                    - fips: '53001'
                      state: WA
                      name: Adams
                    - fips: '53003'
                      state: WA
                      name: Asotin
                    - fips: '53005'
                      state: WA
                      name: Benton
                    - fips: '53007'
                      state: WA
                      name: Chelan
                    - fips: '53009'
                      state: WA
                      name: Clallam
      operationId: suggest-counties
      description: 'Get suggested counties based on provided query string. Responds with an array, limited to 5 results, of counties where the county name or state matches the provided query string.'
      parameters:
        - schema:
            type: string
            example: 'cowlitz, wa'
          in: query
          name: q
          description: county name and/or state fragment
          required: true
components:
  schemas:
    CountySuggestion:
      title: CountySuggestion
      type: object
      x-examples:
        Example:
          fips: '01001'
          state: AL
          name: Autauga
      properties:
        fips:
          type: string
        state:
          type: string
        name:
          type: string
      required:
        - fips
        - state
        - name