ApiProperties interface

Pakiet:

@azure/arm-apicenter

Właściwości interfejsu API.

Właściwości

contacts	Zestaw kontaktów
customProperties	Niestandardowe metadane zdefiniowane dla jednostek wykazu interfejsów API.
description	Opis interfejsu API.
externalDocumentation	Zestaw dokumentacji zewnętrznej
kind	Rodzaj interfejsu API. Na przykład REST lub GraphQL.
license	Informacje o licencji interfejsu API.
lifecycleStage	Bieżący etap cyklu życia interfejsu API. UWAGA: Ta właściwość nie zostanie serializowana. Można go wypełnić tylko przez serwer.
summary	Krótki opis interfejsu API.
termsOfService	Warunki użytkowania interfejsu API.
title	Tytuł interfejsu API.

Szczegóły właściwości

contacts

Zestaw kontaktów

contacts?: Contact[]

Wartość właściwości

Contact[]

customProperties

Niestandardowe metadane zdefiniowane dla jednostek wykazu interfejsów API.

customProperties?: Record<string, unknown>

Wartość właściwości

Record<string, unknown>

description

Opis interfejsu API.

description?: string

Wartość właściwości

string

externalDocumentation

Zestaw dokumentacji zewnętrznej

externalDocumentation?: ExternalDocumentation[]

Wartość właściwości

ExternalDocumentation[]

kind

Rodzaj interfejsu API. Na przykład REST lub GraphQL.

kind: string

Wartość właściwości

string

license

Informacje o licencji interfejsu API.

license?: License

Wartość właściwości

License

lifecycleStage

Bieżący etap cyklu życia interfejsu API. UWAGA: Ta właściwość nie zostanie serializowana. Można go wypełnić tylko przez serwer.

lifecycleStage?: string

Wartość właściwości

string

summary

Krótki opis interfejsu API.

summary?: string

Wartość właściwości

string

termsOfService

Warunki użytkowania interfejsu API.

termsOfService?: TermsOfService

Wartość właściwości

TermsOfService

title

Tytuł interfejsu API.

title: string

Wartość właściwości

string