io.muserver.openapi

Class ComponentsObject

java.lang.Object

io.muserver.openapi.ComponentsObject

public class ComponentsObject
extends Object

See Also:

ComponentsObjectBuilder

Field Summary

Fields

Modifier and Type	Field and Description
Map<String,CallbackObject>	callbacks Deprecated.
Map<String,ExampleObject>	examples Deprecated.
Map<String,HeaderObject>	headers Deprecated.
Map<String,LinkObject>	links Deprecated.
Map<String,ParameterObject>	parameters Deprecated.
Map<String,RequestBodyObject>	requestBodies Deprecated.
Map<String,ResponseObject>	responses Deprecated.
Map<String,SchemaObject>	schemas Deprecated.
Map<String,SecuritySchemeObject>	securitySchemes Deprecated.

Method Summary

Modifier and Type	Method and Description
Map<String,CallbackObject>	callbacks()
Map<String,ExampleObject>	examples()
Map<String,HeaderObject>	headers()
Map<String,LinkObject>	links()
Map<String,ParameterObject>	parameters()
Map<String,RequestBodyObject>	requestBodies()
Map<String,ResponseObject>	responses()
Map<String,SchemaObject>	schemas()
Map<String,SecuritySchemeObject>	securitySchemes()
void	writeJson(Writer writer) Writes this object as a JSON Object

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

schemas

@Deprecated
public final Map<String,SchemaObject> schemas

Deprecated.

Use schemas() instead

responses

@Deprecated
public final Map<String,ResponseObject> responses

Deprecated.

Use responses() instead

parameters

@Deprecated
public final Map<String,ParameterObject> parameters

Deprecated.

Use parameters() instead

examples

@Deprecated
public final Map<String,ExampleObject> examples

Deprecated.

Use examples() instead

requestBodies

@Deprecated
public final Map<String,RequestBodyObject> requestBodies

Deprecated.

Use requestBodies() instead

headers

@Deprecated
public final Map<String,HeaderObject> headers

Deprecated.

Use headers() instead

securitySchemes

@Deprecated
public final Map<String,SecuritySchemeObject> securitySchemes

Deprecated.

Use securitySchemes() instead

links

@Deprecated
public final Map<String,LinkObject> links

Deprecated.

Use links() instead

callbacks

@Deprecated
public final Map<String,CallbackObject> callbacks

Deprecated.

Use callbacks() instead

Method Detail

writeJson

public void writeJson(Writer writer)
               throws IOException

Writes this object as a JSON Object

Parameters:

writer - The writer to write to

Throws:

IOException - Thrown if the writer throws this while writing

schemas

public Map<String,SchemaObject> schemas()

Returns:

The value described by ComponentsObjectBuilder.withSchemas(java.util.Map<java.lang.String, io.muserver.openapi.SchemaObject>)

responses

public Map<String,ResponseObject> responses()

Returns:

The value described by ComponentsObjectBuilder.withResponses(java.util.Map<java.lang.String, io.muserver.openapi.ResponseObject>)

parameters

public Map<String,ParameterObject> parameters()

Returns:

The value described by ComponentsObjectBuilder.withParameters(java.util.Map<java.lang.String, io.muserver.openapi.ParameterObject>)

examples

public Map<String,ExampleObject> examples()

Returns:

The value described by ComponentsObjectBuilder.withExamples(java.util.Map<java.lang.String, io.muserver.openapi.ExampleObject>)

requestBodies

public Map<String,RequestBodyObject> requestBodies()

Returns:

The value described by ComponentsObjectBuilder.withRequestBodies(java.util.Map<java.lang.String, io.muserver.openapi.RequestBodyObject>)

headers

public Map<String,HeaderObject> headers()

Returns:

The value described by ComponentsObjectBuilder.withHeaders(java.util.Map<java.lang.String, io.muserver.openapi.HeaderObject>)

securitySchemes

public Map<String,SecuritySchemeObject> securitySchemes()

Returns:

The value described by ComponentsObjectBuilder.withSecuritySchemes(java.util.Map<java.lang.String, io.muserver.openapi.SecuritySchemeObject>)

links

public Map<String,LinkObject> links()

Returns:

The value described by ComponentsObjectBuilder.withLinks(java.util.Map<java.lang.String, io.muserver.openapi.LinkObject>)

callbacks

public Map<String,CallbackObject> callbacks()

Returns:

The value described by ComponentsObjectBuilder.withCallbacks(java.util.Map<java.lang.String, io.muserver.openapi.CallbackObject>)