|
37 | 37 | } |
38 | 38 | }, |
39 | 39 | "paths": { |
40 | | - "/subscriptions/{subscriptionId}/providers/Microsoft.HealthBot/checkNameAvailability": { |
41 | | - "post": { |
42 | | - "description": "Check whether a bot name is available.", |
43 | | - "operationId": "Bots_CheckNameAvailability", |
44 | | - "x-ms-examples": { |
45 | | - "check Name Availability": { |
46 | | - "$ref": "./examples/CheckNameAvailability.json" |
47 | | - } |
48 | | - }, |
49 | | - "parameters": [ |
50 | | - { |
51 | | - "name": "parameters", |
52 | | - "in": "body", |
53 | | - "required": true, |
54 | | - "schema": { |
55 | | - "$ref": "#/definitions/CheckNameAvailabilityRequestBody" |
56 | | - }, |
57 | | - "description": "The request body parameters to provide for the check name availability request" |
58 | | - }, |
59 | | - { |
60 | | - "$ref": "#/parameters/subscriptionIdParameter" |
61 | | - }, |
62 | | - { |
63 | | - "$ref": "#/parameters/apiVersionParameter" |
64 | | - } |
65 | | - ], |
66 | | - "responses": { |
67 | | - "200": { |
68 | | - "description": "The resource provider should return 200 (OK) to indicate that the operation completed successfully. For other errors (e.g. internal errors) use the appropriate HTTP error code.", |
69 | | - "schema": { |
70 | | - "$ref": "#/definitions/CheckNameAvailabilityResponseBody" |
71 | | - } |
72 | | - }, |
73 | | - "default": { |
74 | | - "description": "Error response describing why the operation failed", |
75 | | - "schema": { |
76 | | - "$ref": "#/definitions/Error" |
77 | | - } |
78 | | - } |
79 | | - } |
80 | | - } |
81 | | - }, |
82 | 40 | "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthBot/healthBots/{botName}": { |
83 | 41 | "put": { |
84 | 42 | "operationId": "Bots_Create", |
|
87 | 45 | "$ref": "./examples/ResourceCreationPut.json" |
88 | 46 | } |
89 | 47 | }, |
90 | | - "description": "Create a new Healthcare Bot.", |
| 48 | + "description": "Create a new HealthBot.", |
91 | 49 | "parameters": [ |
92 | 50 | { |
93 | 51 | "$ref": "#/parameters/subscriptionIdParameter" |
|
143 | 101 | "$ref": "./examples/ResourceInfoGet.json" |
144 | 102 | } |
145 | 103 | }, |
146 | | - "description": "Get a Healthcare Bot.", |
| 104 | + "description": "Get a HealthBot.", |
147 | 105 | "parameters": [ |
148 | 106 | { |
149 | 107 | "$ref": "#/parameters/subscriptionIdParameter" |
|
180 | 138 | "$ref": "./examples/ResourceUpdatePatch.json" |
181 | 139 | } |
182 | 140 | }, |
183 | | - "description": "Patch a Healthcare Bot.", |
| 141 | + "description": "Patch a HealthBot.", |
184 | 142 | "parameters": [ |
185 | 143 | { |
186 | 144 | "$ref": "#/parameters/subscriptionIdParameter" |
|
232 | 190 | "$ref": "./examples/ResourceDeletionDelete.json" |
233 | 191 | } |
234 | 192 | }, |
235 | | - "description": "Delete a Healthcare Bot.", |
| 193 | + "description": "Delete a HealthBot.", |
236 | 194 | "parameters": [ |
237 | 195 | { |
238 | 196 | "$ref": "#/parameters/subscriptionIdParameter" |
|
395 | 353 | "name": "SkuName", |
396 | 354 | "modelAsString": false |
397 | 355 | } |
398 | | - }, |
399 | | - "tier": { |
400 | | - "type": "string", |
401 | | - "enum": [ |
402 | | - "Free", |
403 | | - "Standard" |
404 | | - ], |
405 | | - "x-ms-enum": { |
406 | | - "name": "SkuTier", |
407 | | - "modelAsString": false |
408 | | - }, |
409 | | - "description": "This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT." |
410 | | - }, |
411 | | - "size": { |
412 | | - "type": "string", |
413 | | - "description": "The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. " |
414 | | - }, |
415 | | - "family": { |
416 | | - "type": "string", |
417 | | - "description": "If the service has different generations of hardware, for the same SKU, then that can be captured here." |
418 | | - }, |
419 | | - "capacity": { |
420 | | - "type": "integer", |
421 | | - "format": "int32", |
422 | | - "description": "If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted." |
423 | 356 | } |
424 | 357 | }, |
425 | 358 | "required": [ |
426 | 359 | "name" |
427 | 360 | ] |
428 | 361 | }, |
429 | | - "CheckNameAvailabilityRequestBody": { |
430 | | - "description": "The request body for a request to to check availability of a bot name.", |
431 | | - "type": "object", |
432 | | - "properties": { |
433 | | - "name": { |
434 | | - "description": "the name of the bot for which availability needs to be checked.", |
435 | | - "type": "string" |
436 | | - }, |
437 | | - "type": { |
438 | | - "description": "the type of the bot for which availability needs to be checked", |
439 | | - "type": "string" |
440 | | - } |
441 | | - }, |
442 | | - "required": [ |
443 | | - "name", |
444 | | - "type" |
445 | | - ] |
446 | | - }, |
447 | | - "CheckNameAvailabilityResponseBody": { |
448 | | - "description": "The response body returned for a request to check availability of a bot name.", |
449 | | - "type": "object", |
450 | | - "properties": { |
451 | | - "nameAvailable": { |
452 | | - "description": "indicates if the bot name is valid and available.", |
453 | | - "type": "boolean" |
454 | | - }, |
455 | | - "reason": { |
456 | | - "description": "Reason for the result", |
457 | | - "type": "string" |
458 | | - }, |
459 | | - "message": { |
460 | | - "description": "additional message from server", |
461 | | - "type": "string" |
462 | | - } |
463 | | - } |
464 | | - }, |
465 | 362 | "Resource": { |
466 | 363 | "description": "The resource model definition for a ARM tracked top level resource", |
467 | 364 | "x-ms-azure-resource": true, |
|
536 | 433 | }, |
537 | 434 | "properties": { |
538 | 435 | "$ref": "#/definitions/HealthBotProperties", |
539 | | - "description": "The set of properties specific to healthcare bot resource." |
| 436 | + "description": "The set of properties specific to Healthbot resource." |
540 | 437 | } |
541 | | - } |
| 438 | + }, |
| 439 | + "required": [ |
| 440 | + "sku" |
| 441 | + ] |
542 | 442 | }, |
543 | 443 | "HealthBotProperties": { |
544 | 444 | "title": "HealthBotProperties", |
545 | 445 | "description": "The properties of a HealthBot. The Health Bot Service is a cloud platform that empowers developers in Healthcare organizations to build and deploy their compliant, AI-powered virtual health assistants and health bots, that help them improve processes and reduce costs.", |
546 | 446 | "properties": { |
547 | 447 | "provisioningState": { |
548 | 448 | "type": "string", |
549 | | - "description": "The provisioning state of the Healthcare bot resource.", |
| 449 | + "description": "The provisioning state of the Healthbot resource.", |
550 | 450 | "readOnly": true |
551 | 451 | }, |
552 | 452 | "botManagementPortalLink": { |
|
771 | 671 | "items": { |
772 | 672 | "$ref": "#/definitions/HealthBot" |
773 | 673 | }, |
774 | | - "description": "Gets the list of healthcare bot results and their properties." |
| 674 | + "description": "Gets the list of Healthbot results and their properties." |
775 | 675 | } |
776 | 676 | }, |
777 | | - "description": "The list of healthcare bot operation response." |
| 677 | + "description": "The list of Healthbot operation response." |
778 | 678 | } |
779 | 679 | }, |
780 | 680 | "parameters": { |
|
0 commit comments