Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adding missing docs for existing routes for QnA Maker APIM #6140

Merged
merged 9 commits into from
Jun 3, 2019
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,73 @@
]
},
"paths": {
"/endpointsettings": {
"get": {
"summary": "Gets endpoint settings for an endpoint.",
"operationId": "EndpointSettings_GetSettings",
"parameters": [],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "Response with endpoint settings info in it.",
"schema": {
"$ref": "#/definitions/EndpointSettingsDTO"
},
"x-nullable": true
},
"default": {
"description": "Error response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Successful query": {
"$ref": "./examples/SuccessfulGetEpSettings.json"
}
}
},
"patch": {
"tags": [
"EndpointKeys"
],
"summary": "Updates endpoint settings for an endpoint.",
"operationId": "EndpointSettings_UpdateSettings",
"parameters": [
{
"$ref": "#/parameters/EndpointSettingsPayload"
}
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "Response with endpointSettings update status."
},
"default": {
"description": "Error response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Successful query": {
"$ref": "./examples/SuccessfulSetEpSettings.json"
}
}
}
},
"/endpointkeys": {
"get": {
"summary": "Gets endpoint keys for an endpoint",
Expand Down Expand Up @@ -1183,6 +1250,32 @@
}
}
},
"EndpointSettingsDTO": {
"type": "object",
"description": "Endpoint settings.",
"additionalProperties": false,
"properties": {
"activeLearning": {
"description": "Active Learning settings of the endpoint.",
"allOf": [
{
"$ref": "#/definitions/ActiveLearningSettingsDTO"
}
]
}
}
},
"ActiveLearningSettingsDTO": {
"type": "object",
"description": "Active Learning settings of the endpoint.",
"additionalProperties": false,
"properties": {
"enable": {
"type": "string",
"description": "True/False string providing Active Learning"
}
}
},
"WordAlterationsDTO": {
"type": "object",
"description": "Collection of word alterations.",
Expand Down Expand Up @@ -1344,6 +1437,17 @@
"type": "string",
"in": "path",
"x-ms-skip-url-encoding": true
},
"EndpointSettingsPayload": {
"name": "endpointSettingsPayload",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/EndpointSettingsDTO"
},
"x-nullable": true,
"description": "Post body of the request.",
"x-ms-parameter-location": "method"
}
}
}
}
Loading