Merge branch 'main' into in-app-update

Bandwidth · Aug 21, 2023 · f9d0426 · f9d0426
2 parents 5dcae95 + d47eb9d
commit f9d0426
Showing 1 changed file with 51 additions and 26 deletions.
diff --git a/site/specs/global.yml b/site/specs/global.yml
@@ -6603,14 +6603,30 @@ components:
           items:
             $ref: '#/components/schemas/portinEventStatusEnum'
         notificationChannel:
+          description: >
+            NOTE: When a request without the `Authorization` header is made to a
+            callback url that supports basic authentication, then the expected
+            behavior is:
+
+            1. Response code is `401` or `407`. 
+
+            2. Response headers should contain `WWW-Authenticate` or
+            `Proxy-Authenticate` specifying basic authentication as a scheme.
+            For example `WWW-Authenticate":"Basic realm="Bandwidth API"`.
           type: array
           items:
             $ref: '#/components/schemas/notificationChannel'
+          example:
+            - callback: test-callback
+              url: https://test-callback.xyz.com/callback
+              callbackCredentials:
+                basicAuthentication:
+                  username: myusername
+                  password: mypassword
       required:
         - product
         - notificationChannel
       example:
-        exampleSubscriptionObject: null
         product: PORTING
         eventType: PORTIN_ORDER_STATUS
         entityId: unique_entity_id
@@ -6621,10 +6637,10 @@ components:
         notifyStates:
           - ACCEPTED_BY_CARRIER
         notificationChannel:
-          callback: null
-          url: some-url
-          callbackCredentials:
-            - basicAuthentication:
+          - callback: test-callback
+            url: some-url
+            callbackCredentials:
+              basicAuthentication:
                 username: username
                 password: password
     modifySubscription:
@@ -6659,7 +6675,16 @@ components:
           items:
             $ref: '#/components/schemas/portinEventStatusEnum'
         notificationChannel:
-          $ref: '#/components/schemas/notificationChannel'
+          type: array
+          items:
+            $ref: '#/components/schemas/notificationChannel'
+          example:
+            - callback: test-callback
+              url: https://test-callback.xyz.com/callback
+              callbackCredentials:
+                basicAuthentication:
+                  username: myusername
+                  password: mypassword
       example:
         exampleModifySubscription: null
         eventType: PORTIN_ORDER_STATUS
@@ -6926,10 +6951,10 @@ components:
                         - DRAFT
                         - COMPLETED
                       notificationChannel:
-                        callback: null
-                        url: some-url
-                        callbackCredentials:
-                          - basicAuthentication:
+                        - callback: test-callback
+                          url: some-url
+                          callbackCredentials:
+                            basicAuthentication:
                               username: username
                               password: password
                 errors: null
@@ -6972,10 +6997,10 @@ components:
                     - COMPLETED
                     - DRAFT
                   notificationChannel:
-                    callback: null
-                    url: some-url
-                    callbackCredentials:
-                      - basicAuthentication:
+                    - callback: test-callback
+                      url: some-url
+                      callbackCredentials:
+                        basicAuthentication:
                           username: username
                           password: password
                 errors: null
@@ -7152,10 +7177,10 @@ components:
                 notifyStates:
                   - DRAFT
                 notificationChannel:
-                  callback: null
-                  url: some-url
-                  callbackCredentials:
-                    - basicAuthentication:
+                  - callback: test-callback
+                    url: some-url
+                    callbackCredentials:
+                      basicAuthentication:
                         username: username
                         password: password
     modifySubscription:
@@ -7178,10 +7203,10 @@ components:
                   - DRAFT
                   - COMPLETED
                 notificationChannel:
-                  callback: null
-                  url: some-url
-                  callbackCredentials:
-                    - basicAuthentication:
+                  - callback: test-callback
+                    url: some-url
+                    callbackCredentials:
+                      basicAuthentication:
                         username: username
                         password: password
     updateSubscription:
@@ -7204,10 +7229,10 @@ components:
                   - DRAFT
                   - COMPLETED
                 notificationChannel:
-                  callback: null
-                  url: some-url
-                  callbackCredentials:
-                    - basicAuthentication:
+                  - callback: test-callback
+                    url: some-url
+                    callbackCredentials:
+                      basicAuthentication:
                         username: username
                         password: password
   parameters: