| Package | Description |
|---|---|
| com.grpc.gateway.protoc_gen_openapiv2.options |
| Modifier and Type | Method and Description |
|---|---|
Swagger.Builder |
Swagger.Builder.addAllConsumes(Iterable<String> values)
A list of MIME types the APIs can consume.
|
Swagger.Builder |
Swagger.Builder.addAllProduces(Iterable<String> values)
A list of MIME types the APIs can produce.
|
Swagger.Builder |
Swagger.Builder.addAllSchemes(Iterable<? extends Scheme> values)
The transfer protocol of the API.
|
Swagger.Builder |
Swagger.Builder.addAllSchemesValue(Iterable<Integer> values)
The transfer protocol of the API.
|
Swagger.Builder |
Swagger.Builder.addAllSecurity(Iterable<? extends SecurityRequirement> values)
A declaration of which security schemes are applied for the API as a whole.
|
Swagger.Builder |
Swagger.Builder.addAllTags(Iterable<? extends Tag> values)
A list of tags for API documentation control.
|
Swagger.Builder |
Swagger.Builder.addConsumes(String value)
A list of MIME types the APIs can consume.
|
Swagger.Builder |
Swagger.Builder.addConsumesBytes(com.google.protobuf.ByteString value)
A list of MIME types the APIs can consume.
|
Swagger.Builder |
Swagger.Builder.addProduces(String value)
A list of MIME types the APIs can produce.
|
Swagger.Builder |
Swagger.Builder.addProducesBytes(com.google.protobuf.ByteString value)
A list of MIME types the APIs can produce.
|
Swagger.Builder |
Swagger.Builder.addSchemes(Scheme value)
The transfer protocol of the API.
|
Swagger.Builder |
Swagger.Builder.addSchemesValue(int value)
The transfer protocol of the API.
|
Swagger.Builder |
Swagger.Builder.addSecurity(int index,
SecurityRequirement.Builder builderForValue)
A declaration of which security schemes are applied for the API as a whole.
|
Swagger.Builder |
Swagger.Builder.addSecurity(int index,
SecurityRequirement value)
A declaration of which security schemes are applied for the API as a whole.
|
Swagger.Builder |
Swagger.Builder.addSecurity(SecurityRequirement.Builder builderForValue)
A declaration of which security schemes are applied for the API as a whole.
|
Swagger.Builder |
Swagger.Builder.addSecurity(SecurityRequirement value)
A declaration of which security schemes are applied for the API as a whole.
|
Swagger.Builder |
Swagger.Builder.addTags(int index,
Tag.Builder builderForValue)
A list of tags for API documentation control.
|
Swagger.Builder |
Swagger.Builder.addTags(int index,
Tag value)
A list of tags for API documentation control.
|
Swagger.Builder |
Swagger.Builder.addTags(Tag.Builder builderForValue)
A list of tags for API documentation control.
|
Swagger.Builder |
Swagger.Builder.addTags(Tag value)
A list of tags for API documentation control.
|
Swagger.Builder |
Swagger.Builder.clear() |
Swagger.Builder |
Swagger.Builder.clearBasePath()
The base path on which the API is served, which is relative to the host.
|
Swagger.Builder |
Swagger.Builder.clearConsumes()
A list of MIME types the APIs can consume.
|
Swagger.Builder |
Swagger.Builder.clearExtensions() |
Swagger.Builder |
Swagger.Builder.clearExternalDocs()
Additional external documentation.
|
Swagger.Builder |
Swagger.Builder.clearHost()
The host (name or ip) serving the API.
|
Swagger.Builder |
Swagger.Builder.clearInfo()
Provides metadata about the API.
|
Swagger.Builder |
Swagger.Builder.clearProduces()
A list of MIME types the APIs can produce.
|
Swagger.Builder |
Swagger.Builder.clearResponses() |
Swagger.Builder |
Swagger.Builder.clearSchemes()
The transfer protocol of the API.
|
Swagger.Builder |
Swagger.Builder.clearSecurity()
A declaration of which security schemes are applied for the API as a whole.
|
Swagger.Builder |
Swagger.Builder.clearSecurityDefinitions()
Security scheme definitions that can be used across the specification.
|
Swagger.Builder |
Swagger.Builder.clearSwagger()
Specifies the OpenAPI Specification version being used.
|
Swagger.Builder |
Swagger.Builder.clearTags()
A list of tags for API documentation control.
|
Swagger.Builder |
Swagger.Builder.mergeExternalDocs(ExternalDocumentation value)
Additional external documentation.
|
Swagger.Builder |
Swagger.Builder.mergeFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
Swagger.Builder |
Swagger.Builder.mergeFrom(com.google.protobuf.Message other) |
Swagger.Builder |
Swagger.Builder.mergeFrom(Swagger other) |
Swagger.Builder |
Swagger.Builder.mergeInfo(Info value)
Provides metadata about the API.
|
Swagger.Builder |
Swagger.Builder.mergeSecurityDefinitions(SecurityDefinitions value)
Security scheme definitions that can be used across the specification.
|
static Swagger.Builder |
Swagger.newBuilder() |
static Swagger.Builder |
Swagger.newBuilder(Swagger prototype) |
Swagger.Builder |
Swagger.newBuilderForType() |
protected Swagger.Builder |
Swagger.newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent) |
Swagger.Builder |
Swagger.Builder.putAllExtensions(Map<String,com.google.protobuf.Value> values)
Custom properties that start with "x-" such as "x-foo" used to describe
extra functionality that is not covered by the standard OpenAPI Specification.
|
Swagger.Builder |
Swagger.Builder.putAllResponses(Map<String,Response> values)
An object to hold responses that can be used across operations.
|
Swagger.Builder |
Swagger.Builder.putExtensions(String key,
com.google.protobuf.Value value)
Custom properties that start with "x-" such as "x-foo" used to describe
extra functionality that is not covered by the standard OpenAPI Specification.
|
Swagger.Builder |
Swagger.Builder.putResponses(String key,
Response value)
An object to hold responses that can be used across operations.
|
Swagger.Builder |
Swagger.Builder.removeExtensions(String key)
Custom properties that start with "x-" such as "x-foo" used to describe
extra functionality that is not covered by the standard OpenAPI Specification.
|
Swagger.Builder |
Swagger.Builder.removeResponses(String key)
An object to hold responses that can be used across operations.
|
Swagger.Builder |
Swagger.Builder.removeSecurity(int index)
A declaration of which security schemes are applied for the API as a whole.
|
Swagger.Builder |
Swagger.Builder.removeTags(int index)
A list of tags for API documentation control.
|
Swagger.Builder |
Swagger.Builder.setBasePath(String value)
The base path on which the API is served, which is relative to the host.
|
Swagger.Builder |
Swagger.Builder.setBasePathBytes(com.google.protobuf.ByteString value)
The base path on which the API is served, which is relative to the host.
|
Swagger.Builder |
Swagger.Builder.setConsumes(int index,
String value)
A list of MIME types the APIs can consume.
|
Swagger.Builder |
Swagger.Builder.setExternalDocs(ExternalDocumentation.Builder builderForValue)
Additional external documentation.
|
Swagger.Builder |
Swagger.Builder.setExternalDocs(ExternalDocumentation value)
Additional external documentation.
|
Swagger.Builder |
Swagger.Builder.setHost(String value)
The host (name or ip) serving the API.
|
Swagger.Builder |
Swagger.Builder.setHostBytes(com.google.protobuf.ByteString value)
The host (name or ip) serving the API.
|
Swagger.Builder |
Swagger.Builder.setInfo(Info.Builder builderForValue)
Provides metadata about the API.
|
Swagger.Builder |
Swagger.Builder.setInfo(Info value)
Provides metadata about the API.
|
Swagger.Builder |
Swagger.Builder.setProduces(int index,
String value)
A list of MIME types the APIs can produce.
|
Swagger.Builder |
Swagger.Builder.setSchemes(int index,
Scheme value)
The transfer protocol of the API.
|
Swagger.Builder |
Swagger.Builder.setSchemesValue(int index,
int value)
The transfer protocol of the API.
|
Swagger.Builder |
Swagger.Builder.setSecurity(int index,
SecurityRequirement.Builder builderForValue)
A declaration of which security schemes are applied for the API as a whole.
|
Swagger.Builder |
Swagger.Builder.setSecurity(int index,
SecurityRequirement value)
A declaration of which security schemes are applied for the API as a whole.
|
Swagger.Builder |
Swagger.Builder.setSecurityDefinitions(SecurityDefinitions.Builder builderForValue)
Security scheme definitions that can be used across the specification.
|
Swagger.Builder |
Swagger.Builder.setSecurityDefinitions(SecurityDefinitions value)
Security scheme definitions that can be used across the specification.
|
Swagger.Builder |
Swagger.Builder.setSwagger(String value)
Specifies the OpenAPI Specification version being used.
|
Swagger.Builder |
Swagger.Builder.setSwaggerBytes(com.google.protobuf.ByteString value)
Specifies the OpenAPI Specification version being used.
|
Swagger.Builder |
Swagger.Builder.setTags(int index,
Tag.Builder builderForValue)
A list of tags for API documentation control.
|
Swagger.Builder |
Swagger.Builder.setTags(int index,
Tag value)
A list of tags for API documentation control.
|
Swagger.Builder |
Swagger.toBuilder() |
Copyright © 2024. All rights reserved.