ben.carrasco/jambonz-api-server
1
0
Fork 0
mirror of https://github.com/jambonz/jambonz-api-server.git synced 2026-01-25 02:08:24 +00:00
Code Issues Packages Projects Releases Wiki Activity

update swagger doc

Browse Source
This commit is contained in:
Dave Horton
2019-12-10 10:46:46 -05:00
parent 4e81172c73
commit e186dc2eda
1 changed files with 32 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

33
lib/swagger/swagger.yaml
View File

@@ -371,8 +371,24 @@ paths:
name:
type: string
description: service provider name
example: fastcomms
description:
type: string
root_domain:
type: string
description: root domain for group of accounts that share a registration hook
example: example.com
registration_hook:
type: string
format: url
description: authentication webhook for registration
example: https://mycompany.com
hook_basic_auth_user:
type: string
description: username to use for http basic auth when calling hook
hook_basic_auth_password:
type: string
description: password to use for http basic auth when calling hook
required:
- name
responses:
@@ -510,6 +526,12 @@ paths:
type: string
format: uuid
example: 85f9c036-ba61-4f28-b2f5-617c23fa68ff
hook_basic_auth_user:
type: string
description: username to use for http basic auth when calling hook
hook_basic_auth_password:
type: string
description: password to use for http basic auth when calling hook
required:
- name
- service_provider_sid
@@ -1007,7 +1029,10 @@ components:
type: string
root_domain:
type: string
registration_hook:
hook_basic_auth_user:
type: string
format: url
hook_basic_auth_password:
type: string
format: url
required:
@@ -1042,6 +1067,12 @@ components:
service_provider_sid:
type: string
format: uuid
hook_basic_auth_user:
type: string
format: url
hook_basic_auth_password:
type: string
format: url
required:
- account_sid
- name