ApiProperties interface

Paket:

@azure/arm-apicenter

API-Eigenschaften.

Eigenschaften

contacts	Die Gruppe von Kontakten
customProperties	Die benutzerdefinierten Metadaten, die für API-Katalogentitäten definiert sind.
description	Beschreibung der API.
externalDocumentation	Die Gruppe der externen Dokumentation
kind	Art der API. Beispielsweise REST oder GraphQL.
license	Die Lizenzinformationen für die API.
lifecycleStage	Aktuelle Lebenszyklusstufe der API. HINWEIS: Diese Eigenschaft wird nicht serialisiert. Er kann nur vom Server aufgefüllt werden.
summary	Kurze Beschreibung der API.
termsOfService	Nutzungsbedingungen für die API.
title	API-Titel.

Details zur Eigenschaft

contacts

Die Gruppe von Kontakten

contacts?: Contact[]

Eigenschaftswert

Contact[]

customProperties

Die benutzerdefinierten Metadaten, die für API-Katalogentitäten definiert sind.

customProperties?: Record<string, unknown>

Eigenschaftswert

Record<string, unknown>

description

Beschreibung der API.

description?: string

Eigenschaftswert

string

externalDocumentation

Die Gruppe der externen Dokumentation

externalDocumentation?: ExternalDocumentation[]

Eigenschaftswert

ExternalDocumentation[]

kind

Art der API. Beispielsweise REST oder GraphQL.

kind: string

Eigenschaftswert

string

license

Die Lizenzinformationen für die API.

license?: License

Eigenschaftswert

License

lifecycleStage

Aktuelle Lebenszyklusstufe der API. HINWEIS: Diese Eigenschaft wird nicht serialisiert. Er kann nur vom Server aufgefüllt werden.

lifecycleStage?: string

Eigenschaftswert

string

summary

Kurze Beschreibung der API.

summary?: string

Eigenschaftswert

string

termsOfService

Nutzungsbedingungen für die API.

termsOfService?: TermsOfService

Eigenschaftswert

TermsOfService

title

API-Titel.

title: string

Eigenschaftswert

string