From 5bdc0dc9e8e3d0e8caf37cf2ec36568c2315e45f Mon Sep 17 00:00:00 2001 From: DX-Bandwidth Date: Thu, 12 Oct 2023 15:52:49 +0000 Subject: [PATCH] Add Code Snippets to Spec Files --- site/specs/ai-bridge.yml | 42 ++++++++++++++++++++++++++++++---------- 1 file changed, 32 insertions(+), 10 deletions(-) diff --git a/site/specs/ai-bridge.yml b/site/specs/ai-bridge.yml index c2e06f3fc..fb944f09e 100644 --- a/site/specs/ai-bridge.yml +++ b/site/specs/ai-bridge.yml @@ -11,8 +11,10 @@ info: termsOfService: https://www.bandwidth.com/legal/terms-of-use-bandwidthcom-web-sites/ version: 1.0.0 servers: - - url: TODO - description: Production + - url: https://eng.dashboard.bandwidth.com/portal/report/aibridge + description: Development and test server. + - url: https://dashboard.bandwidth.com/portal/report/aibridge + description: Production server. paths: /accounts/{accountId}/aibridge/providers: get: @@ -544,7 +546,7 @@ components: links: type: array items: - $ref: '#/components/schemas/link' + $ref: '#/components/schemas/links' nullable: true data: oneOf: @@ -569,7 +571,7 @@ components: links: type: array items: - $ref: '#/components/schemas/link' + $ref: '#/components/schemas/links' nullable: true data: $ref: '#/components/schemas/botResponseData' @@ -590,7 +592,7 @@ components: links: type: array items: - $ref: '#/components/schemas/link' + $ref: '#/components/schemas/links' nullable: true data: oneOf: @@ -615,7 +617,7 @@ components: links: type: array items: - $ref: '#/components/schemas/link' + $ref: '#/components/schemas/links' nullable: true data: $ref: '#/components/schemas/botResponseData' @@ -636,7 +638,7 @@ components: links: type: array items: - $ref: '#/components/schemas/link' + $ref: '#/components/schemas/links' nullable: true data: properties: @@ -668,7 +670,7 @@ components: links: type: array items: - $ref: '#/components/schemas/link' + $ref: '#/components/schemas/links' nullable: true data: properties: @@ -1678,8 +1680,8 @@ components: message: type: string example: An optional metadata field - link: - title: Link + links: + title: Links type: object properties: href: @@ -1694,6 +1696,8 @@ components: type: string description: HTTP method to be used. example: GET + example: + $ref: '#/components/examples/linksExample' requestBodies: providerPostRequest: content: @@ -2578,6 +2582,24 @@ components: Unexpected internal server error. Contact Bandwidth Customer Support if this problem persists. errorCode: 500 + linksExample: + summary: An example of a links object in the aibridge reponse + value: + - href: /providers/b64b5e72-a850-4f38-98d4-5022cacd3f0f + rel: self + method: GET + - href: /providers + rel: create + method: POST + - href: /providers/b64b5e72-a850-4f38-98d4-5022cacd3f0f + rel: replace + method: PUT + - href: /providers/b64b5e72-a850-4f38-98d4-5022cacd3f0f + rel: update + method: PATCH + - href: /providers/b64b5e72-a850-4f38-98d4-5022cacd3f0f + rel: delete + method: DELETE securitySchemes: Basic: type: http