ApiProperties interface

Pacchetto:

@azure/arm-apicenter

Proprietà API.

Proprietà

contacts	Set di contatti
customProperties	Metadati personalizzati definiti per le entità del catalogo API.
description	Descrizione dell'API.
externalDocumentation	Set di documentazione esterna
kind	Tipo di API. Ad esempio, REST o GraphQL.
license	Informazioni sulla licenza per l'API.
lifecycleStage	Fase del ciclo di vita corrente dell'API. NOTA: questa proprietà non verrà serializzata. Può essere popolata solo dal server.
summary	Breve descrizione dell'API.
termsOfService	Condizioni per il servizio per l'API.
title	Titolo API.

Dettagli proprietà

contacts

Set di contatti

contacts?: Contact[]

Valore della proprietà

Contact[]

customProperties

Metadati personalizzati definiti per le entità del catalogo API.

customProperties?: Record<string, unknown>

Valore della proprietà

Record<string, unknown>

description

Descrizione dell'API.

description?: string

Valore della proprietà

string

externalDocumentation

Set di documentazione esterna

externalDocumentation?: ExternalDocumentation[]

Valore della proprietà

ExternalDocumentation[]

kind

Tipo di API. Ad esempio, REST o GraphQL.

kind: string

Valore della proprietà

string

license

Informazioni sulla licenza per l'API.

license?: License

Valore della proprietà

License

lifecycleStage

Fase del ciclo di vita corrente dell'API. NOTA: questa proprietà non verrà serializzata. Può essere popolata solo dal server.

lifecycleStage?: string

Valore della proprietà

string

summary

Breve descrizione dell'API.

summary?: string

Valore della proprietà

string

termsOfService

Condizioni per il servizio per l'API.

termsOfService?: TermsOfService

Valore della proprietà

TermsOfService

title

Titolo API.

title: string

Valore della proprietà

string