Package dev.rafex.ether.http.openapi.model

OpenAPI domain models used to serialize specifications. More...

Functions
record	OpenApiComponents (Map< String, OpenApiSchema > schemas, Map< String, OpenApiResponse > responses)
record	OpenApiDocument (String openapi, OpenApiInfo info, List< OpenApiServer > servers, Map< String, OpenApiPathItem > paths, OpenApiComponents components)
record	OpenApiInfo (String title, String version, String description, String termsOfService, String license)
record	OpenApiMediaType (OpenApiSchema schema, Object example)
record	OpenApiOperation (String operationId, String summary, String description, List< String > tags, List< OpenApiParameter > parameters, Map< String, OpenApiResponse > responses, OpenApiRequestBody requestBody)
record	OpenApiParameter (String name, String in, String description, boolean required, OpenApiSchema schema)
record	OpenApiPathItem (Map< String, OpenApiOperation > operations)
record	OpenApiRequestBody (String description, boolean required, Map< String, OpenApiMediaType > content)
record	OpenApiResponse (String description, Map< String, OpenApiMediaType > content)
record	OpenApiSchema (String type, String format, String description, boolean nullable, Object example, String ref, Map< String, OpenApiSchema > properties, List< String > required, OpenApiSchema items)
record	OpenApiServer (String url, String description)

Detailed Description

OpenAPI domain models used to serialize specifications.

Function Documentation

OpenApiComponents()

record dev.rafex.ether.http.openapi.model.OpenApiComponents	(	Map< String, OpenApiSchema >	schemas,
		Map< String, OpenApiResponse >	responses )

Definition at line 31 of file OpenApiComponents.java.

References OpenApiComponents().

Referenced by OpenApiComponents(), and OpenApiDocument().

Here is the call graph for this function:

Here is the caller graph for this function:

OpenApiDocument()

record dev.rafex.ether.http.openapi.model.OpenApiDocument	(	String	openapi,
		OpenApiInfo	info,
		List< OpenApiServer >	servers,
		Map< String, OpenApiPathItem >	paths,
		OpenApiComponents	components )

Definition at line 34 of file OpenApiDocument.java.

References OpenApiComponents(), OpenApiDocument(), OpenApiInfo(), dev.rafex.ether.json.JsonUtils.toJson(), and dev.rafex.ether.json.JsonUtils.toPrettyJson().

Referenced by OpenApiDocument().

Here is the call graph for this function:

Here is the caller graph for this function:

OpenApiInfo()

record dev.rafex.ether.http.openapi.model.OpenApiInfo	(	String	title,
		String	version,
		String	description,
		String	termsOfService,
		String	license )

Definition at line 29 of file OpenApiInfo.java.

Referenced by OpenApiDocument().

Here is the caller graph for this function:

OpenApiMediaType()

record dev.rafex.ether.http.openapi.model.OpenApiMediaType	(	OpenApiSchema	schema,
		Object	example )

Definition at line 29 of file OpenApiMediaType.java.

References OpenApiSchema().

Referenced by OpenApiResponse().

Here is the call graph for this function:

Here is the caller graph for this function:

OpenApiOperation()

record dev.rafex.ether.http.openapi.model.OpenApiOperation	(	String	operationId,
		String	summary,
		String	description,
		List< String >	tags,
		List< OpenApiParameter >	parameters,
		Map< String, OpenApiResponse >	responses,
		OpenApiRequestBody	requestBody )

Definition at line 32 of file OpenApiOperation.java.

References OpenApiOperation(), and OpenApiRequestBody().

Referenced by OpenApiOperation(), and OpenApiPathItem().

Here is the call graph for this function:

Here is the caller graph for this function:

OpenApiParameter()

record dev.rafex.ether.http.openapi.model.OpenApiParameter	(	String	name,
		String	in,
		String	description,
		boolean	required,
		OpenApiSchema	schema )

Definition at line 29 of file OpenApiParameter.java.

References OpenApiSchema().

Here is the call graph for this function:

OpenApiPathItem()

record dev.rafex.ether.http.openapi.model.OpenApiPathItem

(

Map< String, OpenApiOperation >

operations

)

Definition at line 32 of file OpenApiPathItem.java.

References OpenApiOperation(), and OpenApiPathItem().

Referenced by OpenApiPathItem().

Here is the call graph for this function:

Here is the caller graph for this function:

OpenApiRequestBody()

record dev.rafex.ether.http.openapi.model.OpenApiRequestBody	(	String	description,
		boolean	required,
		Map< String, OpenApiMediaType >	content )

Definition at line 31 of file OpenApiRequestBody.java.

References OpenApiRequestBody().

Referenced by OpenApiOperation(), and OpenApiRequestBody().

Here is the call graph for this function:

Here is the caller graph for this function:

OpenApiResponse()

record dev.rafex.ether.http.openapi.model.OpenApiResponse	(	String	description,
		Map< String, OpenApiMediaType >	content )

Definition at line 31 of file OpenApiResponse.java.

References OpenApiMediaType(), OpenApiResponse(), and OpenApiSchema().

Referenced by OpenApiResponse().

Here is the call graph for this function:

Here is the caller graph for this function:

OpenApiSchema()

record dev.rafex.ether.http.openapi.model.OpenApiSchema	(	String	type,
		String	format,
		String	description,
		boolean	nullable,
		Object	example,
		String	ref,
		Map< String, OpenApiSchema >	properties,
		List< String >	required,
		OpenApiSchema	items )

Definition at line 32 of file OpenApiSchema.java.

References OpenApiSchema().

Referenced by OpenApiMediaType(), OpenApiParameter(), OpenApiResponse(), and OpenApiSchema().

Here is the call graph for this function:

Here is the caller graph for this function:

OpenApiServer()

record dev.rafex.ether.http.openapi.model.OpenApiServer	(	String	url,
		String	description )

Definition at line 29 of file OpenApiServer.java.