openapi-nexus 0.2.3

OpenAPI 3.x multi-language code generator
Documentation 
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

openapi: 3.1.0
info:
  title: Multipart and Binary Example
  version: 1.0.0
  description: Shows multipart file uploads and raw octet-stream bodies.
paths:
  /avatars:
    post:
      tags:
        - avatars
      operationId: upload_avatar
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              type: object
              required:
                - file
                - profile
                - purpose
              properties:
                file:
                  type: string
                  format: binary
                  description: Avatar image bytes.
                profile:
                  $ref: '#/components/schemas/ProfileAttributes'
                purpose:
                  type: string
                  description: Why the avatar is being uploaded.
            encoding:
              file:
                contentType: image/png
              profile:
                contentType: application/json
              purpose:
                contentType: text/plain
      responses:
        '200':
          description: Avatar accepted.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AvatarUpload'
  /avatars/{avatar_id}/content:
    get:
      tags:
        - avatars
      operationId: download_avatar
      parameters:
        - name: avatar_id
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Raw avatar content.
          content:
            application/octet-stream:
              schema:
                type: string
                format: binary
        '404':
          description: Avatar not found.
    put:
      tags:
        - avatars
      operationId: replace_avatar_content
      parameters:
        - name: avatar_id
          in: path
          required: true
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/octet-stream:
            schema:
              type: string
              format: binary
      responses:
        '204':
          description: Avatar content replaced.
components:
  schemas:
    ProfileAttributes:
      type: object
      required:
        - display_name
      properties:
        display_name:
          type: string
        alt_text:
          type: string
    AvatarUpload:
      type: object
      required:
        - id
        - filename
        - bytes
      properties:
        id:
          type: string
        filename:
          type: string
        bytes:
          type: integer
          format: int64