ApiProperties interface

Pacote:

@azure/arm-apicenter

Propriedades da API.

Propriedades

contacts	O conjunto de contatos
customProperties	Os metadados personalizados definidos para entidades de catálogo de API.
description	A descrição da API.
externalDocumentation	O conjunto de documentação externa
kind	Tipo de API. Por exemplo, REST ou GraphQL.
license	As informações de licença para a API.
lifecycleStage	Estágio atual do ciclo de vida da API. OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.
summary	Breve descrição da API.
termsOfService	Termos de serviço para a API.
title	Título da API.

Detalhes da propriedade

contacts

O conjunto de contatos

contacts?: Contact[]

Valor da propriedade

Contact[]

customProperties

Os metadados personalizados definidos para entidades de catálogo de API.

customProperties?: Record<string, unknown>

Valor da propriedade

Record<string, unknown>

description

A descrição da API.

description?: string

Valor da propriedade

string

externalDocumentation

O conjunto de documentação externa

externalDocumentation?: ExternalDocumentation[]

Valor da propriedade

ExternalDocumentation[]

kind

Tipo de API. Por exemplo, REST ou GraphQL.

kind: string

Valor da propriedade

string

license

As informações de licença para a API.

license?: License

Valor da propriedade

License

lifecycleStage

Estágio atual do ciclo de vida da API. OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.

lifecycleStage?: string

Valor da propriedade

string

summary

Breve descrição da API.

summary?: string

Valor da propriedade

string

termsOfService

Termos de serviço para a API.

termsOfService?: TermsOfService

Valor da propriedade

TermsOfService

title

Título da API.

title: string

Valor da propriedade

string