ApiProperties interface
Vlastnosti rozhraní API.
Vlastnosti
contacts | Sada kontaktů |
custom |
Vlastní metadata definovaná pro entity katalogu rozhraní API. |
description | Popis rozhraní API |
external |
Sada externí dokumentace |
kind | Druh rozhraní API. Například REST nebo GraphQL. |
license | Informace o licenci pro rozhraní API. |
lifecycle |
Aktuální fáze životního cyklu rozhraní API POZNÁMKA: Tato vlastnost nebude serializována. Server ho může naplnit pouze. |
summary | Krátký popis rozhraní API |
terms |
Podmínky služby pro rozhraní API |
title | Název rozhraní API. |
Podrobnosti vlastnosti
contacts
customProperties
Vlastní metadata definovaná pro entity katalogu rozhraní API.
customProperties?: Record<string, unknown>
Hodnota vlastnosti
Record<string, unknown>
description
Popis rozhraní API
description?: string
Hodnota vlastnosti
string
externalDocumentation
Sada externí dokumentace
externalDocumentation?: ExternalDocumentation[]
Hodnota vlastnosti
kind
Druh rozhraní API. Například REST nebo GraphQL.
kind: string
Hodnota vlastnosti
string
license
lifecycleStage
Aktuální fáze životního cyklu rozhraní API POZNÁMKA: Tato vlastnost nebude serializována. Server ho může naplnit pouze.
lifecycleStage?: string
Hodnota vlastnosti
string
summary
Krátký popis rozhraní API
summary?: string
Hodnota vlastnosti
string
termsOfService
title
Název rozhraní API.
title: string
Hodnota vlastnosti
string