DocumentationPartLocation

data class DocumentationPartLocation(val method: String? = null, val name: String? = null, val path: String? = null, val statusCode: String? = null, val type: String)

Constructors

Link copied to clipboard
constructor(method: String? = null, name: String? = null, path: String? = null, statusCode: String? = null, type: String)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
val method: String? = null

HTTP verb of a method. The default value is * for any method.

Link copied to clipboard
val name: String? = null

Name of the targeted API entity.

Link copied to clipboard
val path: String? = null

URL path of the target. The default value is / for the root resource.

Link copied to clipboard
val statusCode: String? = null

HTTP status code of a response. The default value is * for any status code.

Link copied to clipboard

Type of API entity to which the documentation content appliesE.g., API, METHOD or REQUEST_BODY