ApiProperties interface

Csomag:

@azure/arm-apicenter

API-tulajdonságok.

Tulajdonságok

contacts	A névjegyek készlete
customProperties	Az API-katalógus entitásaihoz definiált egyéni metaadatok.
description	Az API leírása.
externalDocumentation	A külső dokumentáció készlete
kind	Az API típusa. Például REST vagy GraphQL.
license	Az API licencadatai.
lifecycleStage	Az API jelenlegi életciklus-szakasza. MEGJEGYZÉS: Ez a tulajdonság nem lesz szerializálva. Csak a kiszolgáló tudja feltölteni.
summary	Az API rövid leírása.
termsOfService	Az API szolgáltatási feltételei.
title	API-cím.

Tulajdonság adatai

contacts

A névjegyek készlete

contacts?: Contact[]

Tulajdonság értéke

Contact[]

customProperties

Az API-katalógus entitásaihoz definiált egyéni metaadatok.

customProperties?: Record<string, unknown>

Tulajdonság értéke

Record<string, unknown>

description

Az API leírása.

description?: string

Tulajdonság értéke

string

externalDocumentation

A külső dokumentáció készlete

externalDocumentation?: ExternalDocumentation[]

Tulajdonság értéke

ExternalDocumentation[]

kind

Az API típusa. Például REST vagy GraphQL.

kind: string

Tulajdonság értéke

string

license

Az API licencadatai.

license?: License

Tulajdonság értéke

License

lifecycleStage

Az API jelenlegi életciklus-szakasza. MEGJEGYZÉS: Ez a tulajdonság nem lesz szerializálva. Csak a kiszolgáló tudja feltölteni.

lifecycleStage?: string

Tulajdonság értéke

string

summary

Az API rövid leírása.

summary?: string

Tulajdonság értéke

string

termsOfService

Az API szolgáltatási feltételei.

termsOfService?: TermsOfService

Tulajdonság értéke

TermsOfService

title

API-cím.

title: string

Tulajdonság értéke

string