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.

Sign up for GitHub

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

Updated QnAMaker Runtime API headers descriptions #6559

Merged
merged 7 commits into from
Jul 25, 2019
Merged

Updated QnAMaker Runtime API headers descriptions #6559

Changes from 2 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
691d031
Updated QnAMaker Runtime API headers descriptions
rokulka Jul 5, 2019
7771bfe
Update swagger title
rokulka Jul 8, 2019
5708716
removed content-type header
rokulka Jul 8, 2019
89c6409
Common tag and title for Runtime
rokulka Jul 16, 2019
a2a4140
Update title
rokulka Jul 16, 2019
1533fcb
update readme
rokulka Jul 16, 2019
70d1ba4
update readme
rokulka Jul 23, 2019
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
46 changes: 30 additions & 16 deletions specification/cognitiveservices/data-plane/QnAMaker/stable/v4.0/QnAMakerRuntime.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,21 +2,9 @@
"swagger": "2.0",
"info": {
"version": "4.0",
"title": "QnAMaker Client",
"title": "QnAMaker Runtime Client",
"description": "An API for QnAMaker runtime"
},
"securityDefinitions": {
"auth_key": {
"type": "apiKey",
"name": "Authorization",
"in": "header"
}
},
"security": [
{
"auth_key": []
}
],
"x-ms-parameterized-host": {
"hostTemplate": "{RuntimeEndpoint}/qnamaker",
"useSchemePrefix": false,
Expand All @@ -40,6 +28,12 @@
},
{
"$ref": "#/parameters/GenerateAnswerPayload"
},
{
"$ref": "#/parameters/EndpointKeyHeader"
},
{
"$ref": "#/parameters/ContentTypeHeader"
}
],
"consumes": [
Expand Down Expand Up @@ -82,6 +76,12 @@
},
{
"$ref": "#/parameters/TrainPayload"
},
{
"$ref": "#/parameters/EndpointKeyHeader"
},
{
"$ref": "#/parameters/ContentTypeHeader"
}
],
"consumes": [
Expand Down Expand Up @@ -390,7 +390,7 @@
"type": "array",
"description": "Represents Search Result list.",
"items": {
"$ref": "#/definitions/QnASearchResult"
"$ref": "#/definitions/QnASearchResult"
}
}
}
Expand Down Expand Up @@ -428,8 +428,8 @@
"type": "array",
"description": "List of metadata.",
"items": {
"$ref": "#/definitions/MetadataDTO"
}
"$ref": "#/definitions/MetadataDTO"
}
},
"context": {
"type": "object",
Expand Down Expand Up @@ -519,6 +519,20 @@
"x-nullable": true,
"description": "Post body of the request.",
"x-ms-parameter-location": "method"
},
"EndpointKeyHeader": {
"name": "Authorization",
"in": "header",
"description": "Authorization header with Primary/Secondary Endpoint Key of Runtime (for example: EndpointKey 8739caf6-8d95-4395-a020-904ae576f7c4)",
"required": true,
"type": "string"
},
"ContentTypeHeader": {
"name": "Content-Type",
rokulka marked this conversation as resolved.
Show resolved Hide resolved
"in": "header",
"description": "application/json",
"required": true,
"type": "string"
}
}
}