api_reference-added missing field in sippeer create request. Removed sippeer's response on POST, it doesn't have it only status code. (#746)

maksymmateiuk · web-flow · commit d7b152ca60d7 · 2022-09-28T16:43:23.000-04:00
diff --git a/site/specs-temp/numbers.json b/site/specs-temp/numbers.json
@@ -14968,15 +14968,26 @@
                         ]
                       }
                     }
+                  },
+                  "SsSendToCustomer": {
+                    "type": "string",
+                    "enum": [
+                      "NONE",
+                      "VERSTAT",
+                      "ENH_VERSTAT",
+                      "VERSTAT_AND_IDENTITY",
+                      "ENH_VERSTAT_AND_IDENTITY",
+                      "IDENTITY"
+                    ]
                   }
                 }
               },
               "examples": {
                 "With VoiceHosts": {
-                  "value": "<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"yes\"?>\n<SipPeer>\n   <PeerName>name</PeerName>\n   <Description>description</Description>\n   <IsDefaultPeer>false</IsDefaultPeer>\n   <FinalDestinationUri>uri</FinalDestinationUri>\n   <VoiceHosts>\n      <Host>\n         <HostName>10.10.10.1</HostName>\n      </Host>\n      <Host>\n         <HostName>10.10.10.2</HostName>\n      </Host>\n   </VoiceHosts>\n   <TerminationHosts>\n      <TerminationHost>\n         <HostName>2.1.1.9</HostName>\n         <Port>0</Port>\n         <CustomerTrafficAllowed>DOMESTIC</CustomerTrafficAllowed>\n      </TerminationHost>\n      <TerminationHost>\n         <HostName>2.1.1.96/30</HostName>\n         <Port>0</Port>\n         <CustomerTrafficAllowed>DOMESTIC</CustomerTrafficAllowed>\n      </TerminationHost>\n   </TerminationHosts>\n   <Address>\n      <HouseNumber>1600</HouseNumber>\n      <HouseSuffix />\n      <PreDirectional />\n      <StreetName>PENNSYLVANIA AVE NW</StreetName>\n      <StreetSuffix />\n      <PostDirectional />\n      <AddressLine2 />\n      <City>WASHINGTON</City>\n      <StateCode>DC</StateCode>\n      <Zip>20500</Zip>\n      <PlusFour />\n      <County />\n      <Country>United States</Country>\n      <AddressType>Service</AddressType>\n   </Address>\n   <PremiseTrunks>PremiseTrunks</PremiseTrunks>\n   <CallingName>\n      <Display>true</Display>\n      <Enforced>true</Enforced>\n   </CallingName>\n</SipPeer>"
+                  "value": "<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"yes\"?>\n<SipPeer>\n   <PeerName>name</PeerName>\n   <Description>description</Description>\n   <IsDefaultPeer>false</IsDefaultPeer>\n   <FinalDestinationUri>uri</FinalDestinationUri>\n   <VoiceHosts>\n      <Host>\n         <HostName>10.10.10.1</HostName>\n      </Host>\n      <Host>\n         <HostName>10.10.10.2</HostName>\n      </Host>\n   </VoiceHosts>\n   <TerminationHosts>\n      <TerminationHost>\n         <HostName>2.1.1.9</HostName>\n         <Port>0</Port>\n         <CustomerTrafficAllowed>DOMESTIC</CustomerTrafficAllowed>\n      </TerminationHost>\n      <TerminationHost>\n         <HostName>2.1.1.96/30</HostName>\n         <Port>0</Port>\n         <CustomerTrafficAllowed>DOMESTIC</CustomerTrafficAllowed>\n      </TerminationHost>\n   </TerminationHosts>\n   <Address>\n      <HouseNumber>1600</HouseNumber>\n      <HouseSuffix />\n      <PreDirectional />\n      <StreetName>PENNSYLVANIA AVE NW</StreetName>\n      <StreetSuffix />\n      <PostDirectional />\n      <AddressLine2 />\n      <City>WASHINGTON</City>\n      <StateCode>DC</StateCode>\n      <Zip>20500</Zip>\n      <PlusFour />\n      <County />\n      <Country>United States</Country>\n      <AddressType>Service</AddressType>\n   </Address>\n   <PremiseTrunks>PremiseTrunks</PremiseTrunks>\n   <CallingName>\n      <Display>true</Display>\n      <Enforced>true</Enforced>\n   </CallingName>\n   <SsSendToCustomer>NONE</SsSendToCustomer>\n</SipPeer>"
                 },
                 "With VoiceHostGroups": {
-                  "value": "<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"yes\"?>\n<SipPeer>\n   <PeerName>name</PeerName>\n   <Description>description</Description>\n   <IsDefaultPeer>false</IsDefaultPeer>\n   <FinalDestinationUri>uri</FinalDestinationUri>\n   <VoiceHostGroups>\n      <VoiceHostGroup>\n         <Host>\n            <HostName>10.10.10.1</HostName>\n         </Host>\n         <Host>\n            <HostName>10.10.10.2</HostName>\n         </Host>\n      </VoiceHostGroup>\n   </VoiceHostGroups>\n   <TerminationHosts>\n      <TerminationHost>\n         <HostName>2.1.1.9</HostName>\n         <Port>0</Port>\n         <CustomerTrafficAllowed>DOMESTIC</CustomerTrafficAllowed>\n      </TerminationHost>\n      <TerminationHost>\n         <HostName>2.1.1.96/30</HostName>\n         <Port>0</Port>\n         <CustomerTrafficAllowed>DOMESTIC</CustomerTrafficAllowed>\n      </TerminationHost>\n   </TerminationHosts>\n</SipPeer>"
+                  "value": "<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"yes\"?>\n<SipPeer>\n   <PeerName>name</PeerName>\n   <Description>description</Description>\n   <IsDefaultPeer>false</IsDefaultPeer>\n   <FinalDestinationUri>uri</FinalDestinationUri>\n   <VoiceHostGroups>\n      <VoiceHostGroup>\n         <Host>\n            <HostName>10.10.10.1</HostName>\n         </Host>\n         <Host>\n            <HostName>10.10.10.2</HostName>\n         </Host>\n      </VoiceHostGroup>\n   </VoiceHostGroups>\n   <TerminationHosts>\n      <TerminationHost>\n         <HostName>2.1.1.9</HostName>\n         <Port>0</Port>\n         <CustomerTrafficAllowed>DOMESTIC</CustomerTrafficAllowed>\n      </TerminationHost>\n      <TerminationHost>\n         <HostName>2.1.1.96/30</HostName>\n         <Port>0</Port>\n         <CustomerTrafficAllowed>DOMESTIC</CustomerTrafficAllowed>\n      </TerminationHost>\n   </TerminationHosts>\n   <SsSendToCustomer>NONE</SsSendToCustomer>\n</SipPeer>"
                 }
               }
             }
@@ -14986,16 +14997,6 @@
           "201": {
             "description": "Sip Peer created",
             "content": {
-              "application/xml": {
-                "examples": {
-                  "example": {
-                    "value": "<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"yes\"?>\n<SipPeerResponse>\n   <SipPeer>\n      <PeerId>304985</PeerId>\n      <PeerName>CNAM-TEST-778</PeerName>\n      <Description>description</Description>\n      <IsDefaultPeer>false</IsDefaultPeer>\n      <VoiceHosts />\n      <VoiceHostGroups />\n      <TerminationHosts />\n      <Address>\n         <HouseNumber>1600</HouseNumber>\n         <HouseSuffix />\n         <PreDirectional />\n         <StreetName>PENNSYLVANIA AVE NW</StreetName>\n         <StreetSuffix />\n         <PostDirectional />\n         <AddressLine2 />\n         <City>Washington</City>\n         <StateCode>DC</StateCode>\n         <Zip>20500</Zip>\n         <PlusFour />\n         <County />\n         <Country>United States</Country>\n         <AddressType>Service</AddressType>\n      </Address>\n      <CallingName>\n         <Display>false</Display>\n         <Enforced>false</Enforced>\n      </CallingName>\n   </SipPeer>\n</SipPeerResponse>"
-                  }
-                },
-                "schema": {
-                  "$ref": "#/components/schemas/SipPeerResponse"
-                }
-              }
             }
           },
           "400": {
@@ -29655,7 +29656,7 @@
       "SipPeerResponseBadRequest": {
         "type": "object",
         "properties": {
-          "ResponseStatus": {
+          "SipPeerResponse": {
             "$ref": "#/components/schemas/ResponseStatus"
           }
         }

Original file line number	Diff line number	Diff line change
`@@ -14968,15 +14968,26 @@`
`14968`	`14968`	`]`
`14969`	`14969`	`}`
`14970`	`14970`	`}`
	`14971`	`+ },`
	`14972`	`+ "SsSendToCustomer": {`
	`14973`	`+ "type": "string",`
	`14974`	`+ "enum": [`
	`14975`	`+ "NONE",`
	`14976`	`+ "VERSTAT",`
	`14977`	`+ "ENH_VERSTAT",`
	`14978`	`+ "VERSTAT_AND_IDENTITY",`
	`14979`	`+ "ENH_VERSTAT_AND_IDENTITY",`
	`14980`	`+ "IDENTITY"`
	`14981`	`+ ]`
`14971`	`14982`	`}`
`14972`	`14983`	`}`
`14973`	`14984`	`},`
`14974`	`14985`	`"examples": {`
`14975`	`14986`	`"With VoiceHosts": {`
`14976`		- "value": "<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"yes\"?>\n<SipPeer>\n <PeerName>name</PeerName>\n <Description>description</Description>\n <IsDefaultPeer>false</IsDefaultPeer>\n <FinalDestinationUri>uri</FinalDestinationUri>\n <VoiceHosts>\n <Host>\n <HostName>10.10.10.1</HostName>\n </Host>\n <Host>\n <HostName>10.10.10.2</HostName>\n </Host>\n </VoiceHosts>\n <TerminationHosts>\n <TerminationHost>\n <HostName>2.1.1.9</HostName>\n <Port>0</Port>\n <CustomerTrafficAllowed>DOMESTIC</CustomerTrafficAllowed>\n </TerminationHost>\n <TerminationHost>\n <HostName>2.1.1.96/30</HostName>\n <Port>0</Port>\n <CustomerTrafficAllowed>DOMESTIC</CustomerTrafficAllowed>\n </TerminationHost>\n </TerminationHosts>\n <Address>\n <HouseNumber>1600</HouseNumber>\n <HouseSuffix />\n <PreDirectional />\n <StreetName>PENNSYLVANIA AVE NW</StreetName>\n <StreetSuffix />\n <PostDirectional />\n <AddressLine2 />\n <City>WASHINGTON</City>\n <StateCode>DC</StateCode>\n <Zip>20500</Zip>\n <PlusFour />\n <County />\n <Country>United States</Country>\n <AddressType>Service</AddressType>\n </Address>\n <PremiseTrunks>PremiseTrunks</PremiseTrunks>\n <CallingName>\n <Display>true</Display>\n <Enforced>true</Enforced>\n </CallingName>\n</SipPeer>"
	`14987`	+ "value": "<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"yes\"?>\n<SipPeer>\n <PeerName>name</PeerName>\n <Description>description</Description>\n <IsDefaultPeer>false</IsDefaultPeer>\n <FinalDestinationUri>uri</FinalDestinationUri>\n <VoiceHosts>\n <Host>\n <HostName>10.10.10.1</HostName>\n </Host>\n <Host>\n <HostName>10.10.10.2</HostName>\n </Host>\n </VoiceHosts>\n <TerminationHosts>\n <TerminationHost>\n <HostName>2.1.1.9</HostName>\n <Port>0</Port>\n <CustomerTrafficAllowed>DOMESTIC</CustomerTrafficAllowed>\n </TerminationHost>\n <TerminationHost>\n <HostName>2.1.1.96/30</HostName>\n <Port>0</Port>\n <CustomerTrafficAllowed>DOMESTIC</CustomerTrafficAllowed>\n </TerminationHost>\n </TerminationHosts>\n <Address>\n <HouseNumber>1600</HouseNumber>\n <HouseSuffix />\n <PreDirectional />\n <StreetName>PENNSYLVANIA AVE NW</StreetName>\n <StreetSuffix />\n <PostDirectional />\n <AddressLine2 />\n <City>WASHINGTON</City>\n <StateCode>DC</StateCode>\n <Zip>20500</Zip>\n <PlusFour />\n <County />\n <Country>United States</Country>\n <AddressType>Service</AddressType>\n </Address>\n <PremiseTrunks>PremiseTrunks</PremiseTrunks>\n <CallingName>\n <Display>true</Display>\n <Enforced>true</Enforced>\n </CallingName>\n <SsSendToCustomer>NONE</SsSendToCustomer>\n</SipPeer>"
`14977`	`14988`	`},`
`14978`	`14989`	`"With VoiceHostGroups": {`
`14979`		- "value": "<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"yes\"?>\n<SipPeer>\n <PeerName>name</PeerName>\n <Description>description</Description>\n <IsDefaultPeer>false</IsDefaultPeer>\n <FinalDestinationUri>uri</FinalDestinationUri>\n <VoiceHostGroups>\n <VoiceHostGroup>\n <Host>\n <HostName>10.10.10.1</HostName>\n </Host>\n <Host>\n <HostName>10.10.10.2</HostName>\n </Host>\n </VoiceHostGroup>\n </VoiceHostGroups>\n <TerminationHosts>\n <TerminationHost>\n <HostName>2.1.1.9</HostName>\n <Port>0</Port>\n <CustomerTrafficAllowed>DOMESTIC</CustomerTrafficAllowed>\n </TerminationHost>\n <TerminationHost>\n <HostName>2.1.1.96/30</HostName>\n <Port>0</Port>\n <CustomerTrafficAllowed>DOMESTIC</CustomerTrafficAllowed>\n </TerminationHost>\n </TerminationHosts>\n</SipPeer>"
	`14990`	+ "value": "<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"yes\"?>\n<SipPeer>\n <PeerName>name</PeerName>\n <Description>description</Description>\n <IsDefaultPeer>false</IsDefaultPeer>\n <FinalDestinationUri>uri</FinalDestinationUri>\n <VoiceHostGroups>\n <VoiceHostGroup>\n <Host>\n <HostName>10.10.10.1</HostName>\n </Host>\n <Host>\n <HostName>10.10.10.2</HostName>\n </Host>\n </VoiceHostGroup>\n </VoiceHostGroups>\n <TerminationHosts>\n <TerminationHost>\n <HostName>2.1.1.9</HostName>\n <Port>0</Port>\n <CustomerTrafficAllowed>DOMESTIC</CustomerTrafficAllowed>\n </TerminationHost>\n <TerminationHost>\n <HostName>2.1.1.96/30</HostName>\n <Port>0</Port>\n <CustomerTrafficAllowed>DOMESTIC</CustomerTrafficAllowed>\n </TerminationHost>\n </TerminationHosts>\n <SsSendToCustomer>NONE</SsSendToCustomer>\n</SipPeer>"
`14980`	`14991`	`}`
`14981`	`14992`	`}`
`14982`	`14993`	`}`
`@@ -14986,16 +14997,6 @@`
`14986`	`14997`	`"201": {`
`14987`	`14998`	`"description": "Sip Peer created",`
`14988`	`14999`	`"content": {`
`14989`		`- "application/xml": {`
`14990`		`- "examples": {`
`14991`		`- "example": {`
`14992`		- "value": "<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"yes\"?>\n<SipPeerResponse>\n <SipPeer>\n <PeerId>304985</PeerId>\n <PeerName>CNAM-TEST-778</PeerName>\n <Description>description</Description>\n <IsDefaultPeer>false</IsDefaultPeer>\n <VoiceHosts />\n <VoiceHostGroups />\n <TerminationHosts />\n <Address>\n <HouseNumber>1600</HouseNumber>\n <HouseSuffix />\n <PreDirectional />\n <StreetName>PENNSYLVANIA AVE NW</StreetName>\n <StreetSuffix />\n <PostDirectional />\n <AddressLine2 />\n <City>Washington</City>\n <StateCode>DC</StateCode>\n <Zip>20500</Zip>\n <PlusFour />\n <County />\n <Country>United States</Country>\n <AddressType>Service</AddressType>\n </Address>\n <CallingName>\n <Display>false</Display>\n <Enforced>false</Enforced>\n </CallingName>\n </SipPeer>\n</SipPeerResponse>"
`14993`		`- }`
`14994`		`- },`
`14995`		`- "schema": {`
`14996`		`- "$ref": "#/components/schemas/SipPeerResponse"`
`14997`		`- }`
`14998`		`- }`
`14999`	`15000`	`}`
`15000`	`15001`	`},`
`15001`	`15002`	`"400": {`
`@@ -29655,7 +29656,7 @@`
`29655`	`29656`	`"SipPeerResponseBadRequest": {`
`29656`	`29657`	`"type": "object",`
`29657`	`29658`	`"properties": {`
`29658`		`- "ResponseStatus": {`
	`29659`	`+ "SipPeerResponse": {`
`29659`	`29660`	`"$ref": "#/components/schemas/ResponseStatus"`
`29660`	`29661`	`}`
`29661`	`29662`	`}`