Package org.mule.apikit.model

Interface ApiSpecification

All Superinterfaces:

Serializable

public interface ApiSpecification
extends Serializable

Method Summary

Modifier and Type	Method	Description
String	dump(String newBaseUri)
List<String>	getAllReferences()
ApiVendor	getApiVendor()
String	getBaseUri()
Map<String,Parameter>	getBaseUriParameters()
Map<String,Object>	getCompiledSchemas()
Map<String,String>	getConsolidatedSchemas()
String	getLocation()
Resource	getResource(String path)
Map<String,Resource>	getResources()
List<Map<String,String>>	getSchemas()
List<Map<String,SecurityScheme>>	getSecuritySchemes()
List<Map<String,Template>>	getTraits()
ApiType	getType()
String	getUri()
String	getVersion()
default Map<String,Resource>	getWebhooks()	Returns the webhooks defined in the API specification (OAS 3.1+).

Method Details

getResource

Resource getResource(String path)

getConsolidatedSchemas

Map<String,String> getConsolidatedSchemas()

getCompiledSchemas

Map<String,Object> getCompiledSchemas()

getBaseUri

String getBaseUri()

getLocation

String getLocation()

getResources

Map<String,Resource> getResources()

getVersion

String getVersion()

getBaseUriParameters

Map<String,Parameter> getBaseUriParameters()

getSecuritySchemes

List<Map<String,SecurityScheme>> getSecuritySchemes()

getTraits

List<Map<String,Template>> getTraits()

getUri

String getUri()

getSchemas

List<Map<String,String>> getSchemas()

getAllReferences

List<String> getAllReferences()

dump

String dump(String newBaseUri)

getApiVendor

ApiVendor getApiVendor()

getType

ApiType getType()

getWebhooks

default Map<String,Resource> getWebhooks()

Returns the webhooks defined in the API specification (OAS 3.1+). Each entry maps the webhook name to its Resource representation, which contains the operations (actions) and their request/response schemas.

Returns:

a map of webhook name to Resource, or an empty map if the spec does not define webhooks or the format does not support them.