ApiOperationPropertiesDefinition interface

Pakiet:

@azure/arm-logic

Właściwości operacji interfejsu API

Właściwości

annotation	Adnotacja operacji interfejsu API.
api	Dokumentacja interfejsu API.
description	Opis operacji interfejsu API.
inputsDefinition	Schemat definicji danych wejściowych operacji.
isNotification	Wskazuje, czy operacja interfejsu API jest powiadomieniem, czy nie.
isWebhook	Wskazuje, czy operacja interfejsu API jest elementem webhook, czy nie.
pageable	Wskazuje, czy operacja interfejsu API jest stronicowalna.
responsesDefinition	Schematy definicji odpowiedzi operacji.
summary	Podsumowanie operacji interfejsu API.
trigger	Typ wyzwalacza operacji interfejsu API.
triggerHint	Wskazówka wyzwalacza dla operacji interfejsu API.
visibility	Widoczność operacji interfejsu API.

Szczegóły właściwości

annotation

Adnotacja operacji interfejsu API.

annotation?: ApiOperationAnnotation

Wartość właściwości

ApiOperationAnnotation

api

Dokumentacja interfejsu API.

api?: ApiReference

Wartość właściwości

ApiReference

description

Opis operacji interfejsu API.

description?: string

Wartość właściwości

string

inputsDefinition

Schemat definicji danych wejściowych operacji.

inputsDefinition?: SwaggerSchema

Wartość właściwości

SwaggerSchema

isNotification

Wskazuje, czy operacja interfejsu API jest powiadomieniem, czy nie.

isNotification?: boolean

Wartość właściwości

boolean

isWebhook

Wskazuje, czy operacja interfejsu API jest elementem webhook, czy nie.

isWebhook?: boolean

Wartość właściwości

boolean

pageable

Wskazuje, czy operacja interfejsu API jest stronicowalna.

pageable?: boolean

Wartość właściwości

boolean

responsesDefinition

Schematy definicji odpowiedzi operacji.

responsesDefinition?: {[propertyName: string]: SwaggerSchema}

Wartość właściwości

{[propertyName: string]: SwaggerSchema}

summary

Podsumowanie operacji interfejsu API.

summary?: string

Wartość właściwości

string

trigger

Typ wyzwalacza operacji interfejsu API.

trigger?: string

Wartość właściwości

string

triggerHint

Wskazówka wyzwalacza dla operacji interfejsu API.

triggerHint?: string

Wartość właściwości

string

visibility

Widoczność operacji interfejsu API.

visibility?: string

Wartość właściwości

string