ApiProperties interface

Paket:

@azure/arm-apicenter

API özellikleri.

Özellikler

contacts	Kişi kümesi
customProperties	API kataloğu varlıkları için tanımlanan özel meta veriler.
description	API'nin açıklaması.
externalDocumentation	Dış belge kümesi
kind	API türü. Örneğin REST veya GraphQL.
license	API'nin lisans bilgileri.
lifecycleStage	API'nin geçerli yaşam döngüsü aşaması. NOT: Bu özellik serileştirilmeyecek. Yalnızca sunucu tarafından doldurulabilir.
summary	API'nin kısa açıklaması.
termsOfService	API için hizmet koşulları.
title	API başlığı.

Özellik Ayrıntıları

contacts

Kişi kümesi

contacts?: Contact[]

Özellik Değeri

Contact[]

customProperties

API kataloğu varlıkları için tanımlanan özel meta veriler.

customProperties?: Record<string, unknown>

Özellik Değeri

Record<string, unknown>

description

API'nin açıklaması.

description?: string

Özellik Değeri

string

externalDocumentation

Dış belge kümesi

externalDocumentation?: ExternalDocumentation[]

Özellik Değeri

ExternalDocumentation[]

kind

API türü. Örneğin REST veya GraphQL.

kind: string

Özellik Değeri

string

license

API'nin lisans bilgileri.

license?: License

Özellik Değeri

License

lifecycleStage

API'nin geçerli yaşam döngüsü aşaması. NOT: Bu özellik serileştirilmeyecek. Yalnızca sunucu tarafından doldurulabilir.

lifecycleStage?: string

Özellik Değeri

string

summary

API'nin kısa açıklaması.

summary?: string

Özellik Değeri

string

termsOfService

API için hizmet koşulları.

termsOfService?: TermsOfService

Özellik Değeri

TermsOfService

title

API başlığı.

title: string

Özellik Değeri

string