OperationUpdateContract interface
Détails du contrat de mise à jour de l’opération d’API.
Propriétés
description | Description de l’opération. Peut comporter des balises de mise en forme. |
display |
Nom de l’opération. |
method | Méthode d’opération HTTP valide. Méthodes Http classiques telles que GET, PUT, POST, mais pas limitées par elles uniquement. |
policies | Stratégies d’opération |
request | Entité qui contient les détails de la demande. |
responses | Tableau de réponses d’opération. |
template |
Collection de paramètres de modèle d’URL. |
url |
Modèle d’URL relative identifiant la ressource cible de cette opération. Peut comporter des paramètres. Exemple : /customers/{cid}/orders/{oid}/?date={date} |
Détails de la propriété
description
Description de l’opération. Peut comporter des balises de mise en forme.
description?: string
Valeur de propriété
string
displayName
Nom de l’opération.
displayName?: string
Valeur de propriété
string
method
Méthode d’opération HTTP valide. Méthodes Http classiques telles que GET, PUT, POST, mais pas limitées par elles uniquement.
method?: string
Valeur de propriété
string
policies
Stratégies d’opération
policies?: string
Valeur de propriété
string
request
Entité qui contient les détails de la demande.
request?: RequestContract
Valeur de propriété
responses
Tableau de réponses d’opération.
responses?: ResponseContract[]
Valeur de propriété
templateParameters
Collection de paramètres de modèle d’URL.
templateParameters?: ParameterContract[]
Valeur de propriété
urlTemplate
Modèle d’URL relative identifiant la ressource cible de cette opération. Peut comporter des paramètres. Exemple : /customers/{cid}/orders/{oid}/?date={date}
urlTemplate?: string
Valeur de propriété
string