From 33de10de3d6a87a2a020c32ee20d5dc834237505 Mon Sep 17 00:00:00 2001 From: akharin Date: Thu, 8 Sep 2022 16:27:09 +0300 Subject: [PATCH] Made updates to /portins response schema field descriptions (#703) * Made updates to /portins response schema field descriptions * /portins Added dots to description Fixed "$ref" usage * /portins Added dots to description Co-authored-by: akharin --- site/specs-temp/numbers.json | 120 +++++++++++++++++++++++++++++++---- 1 file changed, 108 insertions(+), 12 deletions(-) diff --git a/site/specs-temp/numbers.json b/site/specs-temp/numbers.json index 054ade8e6..d42921767 100644 --- a/site/specs-temp/numbers.json +++ b/site/specs-temp/numbers.json @@ -11345,7 +11345,7 @@ } }, "schema": { - "$ref": "#/components/schemas/Quantity" + "$ref": "#/components/schemas/PortinsTotal" } } } @@ -20061,6 +20061,7 @@ "type": "object", "properties": { "TelephoneNumber": { + "description": "Simple Telephone Number.", "type": "string" } } @@ -20839,30 +20840,39 @@ "type": "object", "properties": { "HousePrefix": { + "description": "The HousePrefix is the non-numeric address number prefix of the ServiceAddress. This element is optional when not needed to fully specify the ServiceAddress.", "type": "string" }, "HouseNumber": { + "description": "The HouseNumber is the street address number of the ServiceAddress. HouseNumber is mandatory for port-in orders in which the ServiceAddress is mandatory.", "type": "string" }, "HouseSuffix": { + "description": "The HouseSuffix is the non-numeric address number suffix of the ServiceAddress. This element is optional when not needed to fully specify the ServiceAddress.", "type": "string" }, "PreDirectional": { + "description":"The PreDirectional is the non-numeric street name prefix of the ServiceAddress. This element is optional when not needed to fully specify the ServiceAddress.", "type": "string" }, "StreetName": { + "description": "The StreetName is mandatory in cases where the ServiceAddress is mandatory.", "type": "string" }, "StreetSuffix": { + "description": "The StreetSuffix is the street suffix of the ServiceAddress. This element is optional when not needed to fully specify the ServiceAddress.", "type": "string" }, "PostDirectional": { + "description": "The PostDirectional is the street name post directional of the ServiceAddress. This element is optional when not needed to fully specify the ServiceAddress.", "type": "string" }, "AddressLine2": { + "description": "AddressLine2 is used to specify Unit, Suite, Floor, etc. in the Service Address. AddressLine2 is optional when not needed to fully specify the ServiceAddress.", "type": "string" }, "City": { + "description": "City is mandatory in cases where the ServiceAddress is mandatory.", "type": "string" }, "RegionId": { @@ -20871,18 +20881,23 @@ "deprecated": true }, "StateCode": { + "description": "StateCode is the 2-letter abbreviation of the state of the ServiceAddress. StateCode is mandatory in cases where the ServiceAddress is mandatory.", "type": "string" }, "Zip": { + "description": "Zip is the Zip Code of the ServiceAddress. Zip is mandatory in cases where the ServiceAddress is mandatory.", "type": "string" }, "PlusFour": { + "description": "PlusFour is the 4 digits that are sometimes suffixed to the Zip Code.", "type": "string" }, "County": { + "description": "The county where the subscriber or business is located.", "type": "string" }, "Country": { + "description": "Country is the country of the ServiceAddress. This value will be derived from the StateCode, so it should generally be omitted.", "type": "string" }, "LegacyAddressId": { @@ -21252,6 +21267,7 @@ }, "TnAttribute": { "type": "object", + "description": "The TnAttributes field specifies line attributes that will apply to the ported in telephone numbers. If present, TnAttributes may have a value of PROTECTED. This element is not applicable for off-net and toll free port-types", "properties": { "TnAttribute": { "type": "string" @@ -21262,6 +21278,7 @@ "type": "object", "properties": { "SubscriberType": { + "description": "The SubscriberType is mandatory for all non-toll free port-in orders. The SubscriberType field may have values: BUSINESS or RESIDENTIAL.", "type": "string", "enum": [ "business", @@ -21270,24 +21287,31 @@ ] }, "BusinessName": { + "description": "The BusinessName is mandatory for non-toll free port-ins for which the SubscriberType is set to BUSINESS. The BusinessName may be up to 25 characters in length. This element is not applicable for toll free port-ins.", "type": "string" }, "FirstName": { + "description": "The FirstName value is applicable to non-toll free port-in orders in which the SubscriberType is set to RESIDENTIAL. The FirstName is always optional. The FirstName may be up to 25 characters in length.", "type": "string" }, "MiddleInitial": { + "description": "The MiddleInitial value is applicable to non-toll free port-in orders in which the SubscriberType is set to RESIDENTIAL. The MiddleInitial is always optional. The MiddleInitial is 1 character in length.", "type": "string" }, "LastName": { + "description": "The LastName value is mandatory for non-toll free port-in orders in which the SubscriberType is set to RESIDENTIAL. The LastName may be up to 25 characters in length.", "type": "string" }, "Name": { + "description": "If the subscriber type is business, the subscriber name is the name of the business responsible for the numbers being ported. If the subscriber type is residential, the subscriber name is the name of the person responsible for the numbers being ported.", "type": "string" }, "AccountNumber": { + "description": "The WirelessInfo.AccountNumber is sometimes required to authorize the port-out from the losing carrier. This is most common for telephone numbers that were formerly wireless. This element is not applicable for toll free port-ins.", "type": "string" }, "PinNumber": { + "description": "Element of WirelessInfo. Not applicable to toll free port-ins. Cannot be SUPPed for Automated off-net port-ins. If you want to SUPP WirelessInfo, you must include both AccountNumber and PinNumber in the payload, even if you are not changing both.", "type": "string" }, "ServiceAddress": { @@ -21494,15 +21518,19 @@ "type": "object", "properties": { "Id": { + "description": "This is the Order Note identifier that is automatically generated by system.", "type": "string" }, "UserId": { + "description": "The UserId is authenticated for access to the network via a username string.", "type": "string" }, "Description": { + "description": "This is the Order Note description.", "type": "string" }, "LastDateModifier": { + "description": "This is the date when Order Note was last modified.", "type": "string" } } @@ -23409,18 +23437,23 @@ "type": "object", "properties": { "OrderDate": { + "description": "This is the date/time when the order history entry was created.", "type": "string" }, "Note": { + "description": "This is the order note that accompanied the order history entry.", "type": "string" }, "Author": { + "description": "This is the user that initiated the event that caused the order history to be updated.", "type": "string" }, "Difference": { + "description": "SUPP changes difference.", "type": "string" }, "Status": { + "description": "This is the state that the order was in when the order history event occurred.", "type": "string" } } @@ -23432,10 +23465,7 @@ "type": "object", "properties": { "OrderHistory": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OrderHistory" - } + "$ref": "#/components/schemas/OrderHistory" } } } @@ -23445,9 +23475,11 @@ "type": "object", "properties": { "DocumentName": { + "description": "Name of particular document.", "type": "string" }, "DocumentType": { + "description": "Enum of possible file type.", "type": "string", "enum": [ "LOA", @@ -23484,6 +23516,7 @@ "type": "object", "properties": { "PhoneNumber": { + "description": "Simple Telephone Number.", "type": "string" } } @@ -23718,9 +23751,11 @@ "type": "object", "properties": { "AccountNumber": { + "description": "The WirelessInfo.AccountNumber is sometimes required to authorize the port-out from the losing carrier. This is most common for telephone numbers that were formerly wireless. This element is not applicable for toll free port-ins.", "type": "string" }, "PinNumber": { + "description": "The WirelessInfo.PinNumber is sometimes required to authorize the port-out from the losing carrier. This is most common for telephone numbers that were formerly wireless. This element is not applicable for toll free port-ins.", "type": "string" } } @@ -24156,10 +24191,12 @@ "type": "object", "properties": { "AutoActivationDate": { + "description": "The date when auto activation is requested. It can be a date/time in the past, if immediate activation is desired.", "type": "string", "format": "date-time" }, "ActivatedTelephoneNumbersList": { + "description": "This is the list of TNs that have been activated for the port-in order.", "type": "array", "items": { "$ref": "#/components/schemas/TelephoneNumber" @@ -24167,6 +24204,7 @@ }, "NotYetActivatedTelephoneNumbersList": { "type": "array", + "description": "This is the list of TNs that have not yet been activated for the port-in order.", "items": { "$ref": "#/components/schemas/TelephoneNumber" } @@ -24436,9 +24474,11 @@ "type": "object", "properties": { "ErrorCode": { + "description": "Numeric designation of corresponding Error", "type": "integer" }, "Description": { + "description": "Detailed explanation about error ", "type": "string" } } @@ -26649,12 +26689,15 @@ "type": "object", "properties": { "fileName": { + "description": "The (optional) name that was associated with the file when it was uploaded.", "type": "integer" }, "resultCode": { + "description": "Result code of fetching the list of files from AWS.", "type": "integer" }, "resultMessage": { + "description":"Results of the attempt to fetch the list of files.", "type": "string" } } @@ -28987,18 +29030,22 @@ "type": "object", "properties": { "fileCount": { + "description": "Total count of files in response.", "type": "integer" }, "fileData": { + "description": "Optional metadata associated with the file that was uploaded.", "type": "object", "properties": { "FileName": { + "description": "The name that was associated with the file when it was uploaded.", "type": "string" }, "FileMetaData": { "type": "object", "properties": { "DocumentType": { + "description": "Enum of possible file type.", "type": "string", "enum": [ "LOA", @@ -29012,9 +29059,11 @@ } }, "resultCode": { + "description": "Result code of fetching the list of files from AWS.", "type": "integer" }, "resultMessage": { + "description": "Results of the attempt to fetch the list of files.", "type": "string" } } @@ -29351,9 +29400,11 @@ "type": "object", "properties": { "Count": { + "description": "Total count of telephone numbers associated with the specified port-in number.", "type": "integer" }, "TelephoneNumber": { + "description": "ListOfPhoneNumbers is an array of PhoneNumber. At least one PhoneNumber must be provided for all port-types.", "type": "array", "items": { "$ref": "#/components/schemas/TelephoneNumber" @@ -30262,10 +30313,7 @@ "$ref": "#/components/schemas/Links" }, "lnpPortInfoForGivenStatus": { - "type": "array", - "items": { - "$ref": "#/components/schemas/lnpPortInfoForGivenStatus" - } + "$ref": "#/components/schemas/lnpPortInfoForGivenStatus" } } } @@ -30275,54 +30323,68 @@ "type": "object", "properties": { "accountId": { + "description": "This is the account that the searched-for order will be contributing to. Specifying this parameter will restrict the search to portin orders within the specified account.", "type": "integer" }, "CountOfTNs": { + "description": "Total count of telephone numbers in order.", "type": "integer" }, "userId": { + "description": "Bandwidth user ID.", "type": "string" }, "lastModifiedDate": { + "description": "This is the date when Port-in Order was last modified.", "type": "string" }, "OrderDate": { "type": "string" }, "OrderId": { + "description": "This is Bandwidth Oder ID.", "type": "string" }, "OrderType": { "type": "string" }, "ActualFOCDate": { + "description": "This is the FOC (Final Order Commit) Date assigned to the Port-in Order by the losing carrier or their agent.", "type": "string" }, "BillingTelephoneNumber": { + "description": "The BillingTelephoneNumber is the primary telephone number associated with the invoice that the subscriber gets from the losing carrier.", "type": "string" }, "CompanyName": { + "description": "Name associated with the Bandwidth Dashboard account.", "type": "string" }, "LNPLosingCarrierId": { + "description": "Internal use only", "type": "string" }, "LNPLosingCarrierName": { + "description": "The carrier that the telephone numbers are being ported away from.", "type": "string" }, "ProcessingStatus": { + "description": "The processing status of this order. Values may be: PROCESSING, COMPLETED, FAILED. PROCESSING means that the system is still processing the order. COMPLETED means that the order has been successfully completed. FAILED means that errors occurred while processing the order, and that the order did not make any changes to the system.", "type": "string" }, "RequestedFOCDate": { + "description": "This is the FOC (Final Order Commit) Date requested by the person (or machine) creating the Port-in Order.", "type": "string" }, "VendorId": { + "description": "Internal use only.", "type": "string" }, "VendorName": { "type": "string" }, "PON": { + "description": "A PON (Port Order Number) is a system generated order number assigned to port orders to easily identify individual requests.", "type": "string" } } @@ -30335,7 +30397,7 @@ "properties": { "OrderId": { "type": "string", - "description": "Unique orderId that is used to manage the order" + "description": "Unique orderId that is used to manage the order." }, "Status": { "type": "object", @@ -30352,20 +30414,24 @@ "type": "object", "properties": { "Code": { + "description": "Numeric designation of corresponding Error.", "type": "integer" }, "Description": { + "description": "Detailed explanation about error.", "type": "string" } } }, "ProcessingStatus": { + "description": "The processing status of this order. Values may be: PROCESSING, COMPLETED, FAILED. PROCESSING means that the system is still processing the order. COMPLETED means that the order has been successfully completed. FAILED means that errors occurred while processing the order, and that the order did not make any changes to the system.", "type": "string", "enum": [ "PENDING_DOCUMENTS" ] }, "LoaAuthorizingPerson": { + "description": "The LoaAuthorizingPerson is mandatory for all port-types. This is the first and last names of the person that has authorized the port. The LoaAuthorizingPerson value may be up to 15 characters in length.", "type": "string" }, "Subscriber": { @@ -30381,24 +30447,30 @@ } }, "BillingTelephoneNumber": { + "description": "The BillingTelephoneNumber is the primary telephone number associated with the invoice that the subscriber gets from the losing carrier.", "type": "string" }, "NewBillingTelephoneNumber": { + "description": "This field is used to specify a new billing telephone number on the losing carrier account.", "type": "string" }, "SiteId": { + "description": "The numeric designation for the Site ID that applied to the Port-in Order. The SiteId is used to provide a home within the account for the TN(s) that were ported in by the Port-in Order", "type": "string" }, "PeerId": { + "description": "The numeric designation for the Location or SIP PEER ID that applied to the Port-in Order. The SIP Peer ID is used to provide a home within the location for the TN(s) that were ported in by the Port-in Order", "type": "string" }, "ListOfPhoneNumbers": { "type": "array", + "description": "ListOfPhoneNumbers is an array of PhoneNumber. At least one PhoneNumber must be provided for all port-types.", "items": { "$ref": "#/components/schemas/PhoneNumber" } }, "Triggered": { + "description": "The Triggered field must be set to true if you want an activation time other than the 11:30 AM ET default. The desired activation time can then be specified in the time portion of the RequestedFocDate. Triggered activation is not yet supported for toll free port-in orders.", "type": "string" } } @@ -30426,21 +30498,26 @@ } }, "ProcessingStatus": { + "description": "The processing status of this order. Values may be: PROCESSING, COMPLETED, FAILED. PROCESSING means that the system is still processing the order. COMPLETED means that the order has been successfully completed. FAILED means that errors occurred while processing the order, and that the order did not make any changes to the system.", "type": "string", "enum": [ "REQUESTED_SUPP" ] }, "RequestedFocDate": { + "description": "This is the FOC (Final Order Commit) Date requested by the person (or machine) creating the Port-in Order.", "type": "string" }, "BillingTelephoneNumber": { - "type": "string" + "type": "string", + "description": "The BillingTelephoneNumber is the primary telephone number associated with the invoice that the subscriber gets from the losing carrier." }, "NewBillingTelephoneNumber": { - "type": "string" + "type": "string", + "description": "This field is used to specify a new billing telephone number on the losing carrier account." }, "Triggered": { + "description":"The Triggered field must be set to true if you want an activation time other than the 11:30 AM ET default. The desired activation time can then be specified in the time portion of the RequestedFocDate. Triggered activation is not yet supported for toll free port-in orders.", "type": "string" } } @@ -30468,9 +30545,11 @@ "type": "object", "properties": { "AreaCode": { + "description": "The first 3 digits of a 10-digit North American Numbering Plan telephone number.", "type": "integer" }, "Count": { + "description": "Total number of area codes associated with the specified port-in number.", "type": "integer" } } @@ -30486,9 +30565,11 @@ "type": "object", "properties": { "NPA-NXX": { + "description": "The first 6 digits of a 10-digit North American Numbering Plan telephone number.", "type": "integer" }, "Count": { + "description": "Total number of NPA-NXX codes associated with the specified port-in number", "type": "integer" } } @@ -30502,6 +30583,21 @@ "type": "object", "properties": { "Count": { + "description": "Total count of telephone numbers associated with the specified port-in number.", + "type": "integer" + } + } + } + } + }, + "PortinsTotal": { + "type": "object", + "properties": { + "Quantity": { + "type": "object", + "properties": { + "Count": { + "description": "Total count of port-ins.", "type": "integer" } }