-
Notifications
You must be signed in to change notification settings - Fork 241
/
openapi_string_enum.yaml
125 lines (124 loc) · 4.97 KB
/
openapi_string_enum.yaml
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
# Generated with protoc-gen-openapi
# https://github.com/google/gnostic/tree/master/cmd/protoc-gen-openapi
openapi: 3.0.3
info:
title: Title from annotation
description: Description from annotation
contact:
name: Contact Name
url: https://github.com/google/gnostic
email: gnostic@google.com
license:
name: Apache License
url: https://github.com/google/gnostic/blob/master/LICENSE
version: Version from annotation
paths:
/v1/messages/{message_id}:
patch:
tags:
- Messaging1
operationId: Messaging1_UpdateMessage
parameters:
- name: message_id
in: path
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Message'
required: true
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Message'
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Status'
security:
- BasicAuth: []
/v1/messages2/{id}:
get:
tags:
- Messaging1
description: while field in message has overriden field, it should reflect in "parameters" section
operationId: Messaging1_GetMessageById
parameters:
- name: id
in: path
required: true
schema:
title: this is an overriden field schema title
maxLength: 255
type: string
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Message2'
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Status'
components:
schemas:
GoogleProtobufAny:
type: object
properties:
'@type':
type: string
description: The type of the serialized message.
additionalProperties: true
description: Contains an arbitrary serialized message along with a @type that describes the type of the serialized message.
Message:
title: This is an overridden message schema title
type: object
properties:
id:
type: string
label:
title: this is an overriden field schema title
maxLength: 255
type: string
Message2:
title: This is an overridden message schema title
type: object
properties:
id:
title: this is an overriden field schema title
maxLength: 255
type: string
Status:
type: object
properties:
code:
type: integer
description: The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].
format: int32
message:
type: string
description: A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.
details:
type: array
items:
$ref: '#/components/schemas/GoogleProtobufAny'
description: A list of messages that carry the error details. There is a common set of message types for APIs to use.
description: 'The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).'
securitySchemes:
BasicAuth:
type: http
scheme: basic
tags:
- name: Messaging1