generator/io.github.edricchan03.koogle_api.plugin.generator.data/RestDescription

RestDescription

data class RestDescription(val kind: String = "discovery#restDescription", val etag: String? = null, val discoveryVersion: String? = null, val id: String? = null, val name: String? = null, val canonicalName: String? = null, val version: String? = null, val revision: String? = null, val title: String? = null, val description: String? = null, val ownerDomain: String? = null, val ownerName: String? = null, val icons: SchemaIcons? = null, val documentationLink: String? = null, val labels: List<String>? = emptyList(), val protocol: String? = null, val baseUrl: String? = null, val basePath: String? = null, val rootUrl: String? = null, val servicePath: String? = null, val batchPath: String? = null, val packagePath: String? = null, val parameters: RestParameters? = null, val auth: SchemaAuth? = null, val features: List<String>? = emptyList(), val schemas: RestItems? = null, val methods: RestMethods? = null, val resources: RestResources? = null, val versionModule: Boolean? = null, val exponentialBackoffDefault: Boolean? = null)(source)

Data class representing a resource from Google's Discovery API.

Constructors

RestDescription

constructor(kind: String = "discovery#restDescription", etag: String? = null, discoveryVersion: String? = null, id: String? = null, name: String? = null, canonicalName: String? = null, version: String? = null, revision: String? = null, title: String? = null, description: String? = null, ownerDomain: String? = null, ownerName: String? = null, icons: SchemaIcons? = null, documentationLink: String? = null, labels: List<String>? = emptyList(), protocol: String? = null, baseUrl: String? = null, basePath: String? = null, rootUrl: String? = null, servicePath: String? = null, batchPath: String? = null, packagePath: String? = null, parameters: RestParameters? = null, auth: SchemaAuth? = null, features: List<String>? = emptyList(), schemas: RestItems? = null, methods: RestMethods? = null, resources: RestResources? = null, versionModule: Boolean? = null, exponentialBackoffDefault: Boolean? = null)

Properties

auth

val auth: SchemaAuth? = null

Authentication information.

basePath

val basePath: String? = null

[DEPRECATED] The base path for REST requests.

baseUrl

val baseUrl: String? = null

[DEPRECATED] The base URL for REST requests.

batchPath

val batchPath: String? = null

The path for REST batch requests.

canonicalName

val canonicalName: String? = null

Indicates how the API name should be capitalized and split into various parts. Useful for generating pretty class names.

description

val description: String? = null

The description of this API.

discoveryVersion

val discoveryVersion: String? = null

Indicate the version of the Discovery API used to generate this doc.

documentationLink

val documentationLink: String? = null

A link to human-readable documentation for the API.

etag

val etag: String? = null

The ETag for this response.

exponentialBackoffDefault

val exponentialBackoffDefault: Boolean? = null

Enable exponential backoff for suitable methods in the generated clients.

features

val features: List<String>?

A list of supported features for this API.

icons

val icons: SchemaIcons? = null

Links to 16x16 and 32x32 icons representing the API.

val id: String? = null

The ID of the Discovery document for the API. For example, urlshortener:v1.

kind

val kind: String

The kind for this response.

labels

val labels: List<String>?

Labels for the status of this API. Valid values include limited_availability or deprecated.

methods

val methods: RestMethods? = null

API-level methods for this API.

name

val name: String? = null

The name of the API. For example, urlshortener.

ownerDomain

val ownerDomain: String? = null

The domain of the owner of this API. Together with the ownerName and a packagePath values, this can be used to generate a library for this API which would have a unique fully qualified name.

ownerName

val ownerName: String? = null

The name of the owner of this API. See ownerDomain.

packagePath

val packagePath: String? = null

The package of the owner of this API. See ownerDomain.

parameters

val parameters: RestParameters? = null

Common parameters that apply across all APIs.

protocol

val protocol: String? = null

The protocol described by the document. For example, REST.