ApiProperties interface

Paquete:

@azure/arm-apicenter

Propiedades de API.

Propiedades

contacts	Conjunto de contactos
customProperties	Metadatos personalizados definidos para las entidades del catálogo de API.
description	Descripción de la API.
externalDocumentation	Conjunto de documentación externa
kind	Tipo de API. Por ejemplo, REST o GraphQL.
license	La información de licencia de la API.
lifecycleStage	Fase actual del ciclo de vida de la API. NOTA: Esta propiedad no se serializará. Solo el servidor puede rellenarlo.
summary	Descripción breve de la API.
termsOfService	Términos de servicio para la API.
title	Título de la API.

Detalles de las propiedades

contacts

Conjunto de contactos

contacts?: Contact[]

Valor de propiedad

Contact[]

customProperties

Metadatos personalizados definidos para las entidades del catálogo de API.

customProperties?: Record<string, unknown>

Valor de propiedad

Record<string, unknown>

description

Descripción de la API.

description?: string

Valor de propiedad

string

externalDocumentation

Conjunto de documentación externa

externalDocumentation?: ExternalDocumentation[]

Valor de propiedad

ExternalDocumentation[]

kind

Tipo de API. Por ejemplo, REST o GraphQL.

kind: string

Valor de propiedad

string

license

La información de licencia de la API.

license?: License

Valor de propiedad

License

lifecycleStage

Fase actual del ciclo de vida de la API. NOTA: Esta propiedad no se serializará. Solo el servidor puede rellenarlo.

lifecycleStage?: string

Valor de propiedad

string

summary

Descripción breve de la API.

summary?: string

Valor de propiedad

string

termsOfService

Términos de servicio para la API.

termsOfService?: TermsOfService

Valor de propiedad

TermsOfService

title

Título de la API.

title: string

Valor de propiedad

string