aip.dev/aip/general/0156/singleton.oas.yaml at 729bb81368088e27db8d261fc57b5735c85356af · aip-dev/aip.dev · 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
openapi: 3.0.3
info:
  title: Library
  version: 1.0.0
paths:
  /authors/{author}/config:
    parameters:
      - name: author
        in: path
        description: The id of the author.
        required: true
        schema:
          type: string
    get:
      operationId: getConfig
      description: Get the configuration for a author.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Config'

    patch:
      operationId: updateConfig
      description: Get the configuration for a author.
      requestBody:
        content:
          'application/json':
            schema:
               $ref: '#/components/schemas/Config'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Config'
components:
  schemas:
    Config:
      description: The configuration options for a author.
      type: object
      properties:
        name:
          type: string
          description: |
            The name of the config.
            Format: authors/{author}/config
        languageCode:
          type: string
          description: |
            The author's preferred language.
        timeZone:
          type: string
          description: TThe time zone where the author resides.