Partager via


ApiProperties interface

Propriétés de l’API.

Propriétés

contacts

Ensemble de contacts

customProperties

Métadonnées personnalisées définies pour les entités du catalogue d’API.

description

Description de l’API.

externalDocumentation

Ensemble de documentation externe

kind

Type d’API. Par exemple, REST ou GraphQL.

license

Informations de licence pour l’API.

lifecycleStage

Étape de cycle de vie actuelle de l’API. REMARQUE : cette propriété ne sera pas sérialisée. Elle ne peut être remplie que par le serveur.

summary

Brève description de l’API.

termsOfService

Conditions d’utilisation de l’API.

title

Titre de l’API.

Détails de la propriété

contacts

Ensemble de contacts

contacts?: Contact[]

Valeur de propriété

customProperties

Métadonnées personnalisées définies pour les entités du catalogue d’API.

customProperties?: Record<string, unknown>

Valeur de propriété

Record<string, unknown>

description

Description de l’API.

description?: string

Valeur de propriété

string

externalDocumentation

Ensemble de documentation externe

externalDocumentation?: ExternalDocumentation[]

Valeur de propriété

kind

Type d’API. Par exemple, REST ou GraphQL.

kind: string

Valeur de propriété

string

license

Informations de licence pour l’API.

license?: License

Valeur de propriété

lifecycleStage

Étape de cycle de vie actuelle de l’API. REMARQUE : cette propriété ne sera pas sérialisée. Elle ne peut être remplie que par le serveur.

lifecycleStage?: string

Valeur de propriété

string

summary

Brève description de l’API.

summary?: string

Valeur de propriété

string

termsOfService

Conditions d’utilisation de l’API.

termsOfService?: TermsOfService

Valeur de propriété

title

Titre de l’API.

title: string

Valeur de propriété

string