From 3b32fdd67a39c8deb35e5988140f99c03975963f Mon Sep 17 00:00:00 2001 From: DX-Bandwidth Date: Wed, 19 Apr 2023 16:51:26 +0000 Subject: [PATCH 1/5] Add Code Snippets to Spec Files --- site/specs/numbers.yml | 110 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 110 insertions(+) diff --git a/site/specs/numbers.yml b/site/specs/numbers.yml index 833ca10a1..65733ffea 100644 --- a/site/specs/numbers.yml +++ b/site/specs/numbers.yml @@ -9947,6 +9947,38 @@ components: type: integer type: object type: object + RestrictionSearchResult: + properties: + CountryCodeA3: + type: string + RestrictionCategory: + type: string + RestrictionDescription: + type: string + RestrictionType: + $ref: '#/components/schemas/RestrictionType' + type: object + RestrictionSearchResults: + properties: + CityResponse: + properties: + Restrictions: + items: + $ref: '#/components/schemas/RestrictionSearchResult' + type: array + type: object + type: object + RestrictionType: + enum: + - LEGAL + - PURCHASE + - SERVICE + - NRA + - PORTING_PRICE + example: GEOGRAPHIC + type: string + xml: + name: RestrictionType RogerTerminationSettings: properties: SubnetAddressingAllowed: @@ -40945,6 +40977,83 @@ paths: summary: List Rate Centers tags: - Rate Centers + /restrictions: + get: + description: >- + Information about how services work in various countries and which + restrictions and rules apply. Please consult this information before + buying and configuring your numbers. + operationId: ListRestrictions + parameters: + - description: >- +

Country code of the country in its ISO 3166-1 alpha-3 format. + Note that only one country code (i.e. USA, CAN, GBR etc.) is allowed + when configured by the user.


The system defaults country code + to search for restrictions in all countries we have coverage.
+ example: BEL + in: query + name: countryCodeA3 + required: false + schema: + type: string + responses: + '200': + content: + application/xml: + examples: + example: + value: |- + + + + + BEL + LEGAL + Number portability + ADAMS + + + BEL + PURCHASE + Address or identification requirements + ADAMS + + + BEL + SERVICE + Compatibility issues + ADAMS + + + BEL + LEGAL + DOUGLAS + ADAMS + + + BEL + NRA + Reachability limitations + ADAMS + + + BEL + PORTING_PRICE + Mobile numbers + ADAMS + + + + schema: + $ref: '#/components/schemas/RestrictionSearchResults' + description: >- + This response returns the list of cities, along with the Rate + Centers that serve those Restrictions. If 'available' is specified + then the number of TNs available in that city / RC combination is + also included. + summary: List Restrictions + tags: + - Compliance /tns: get: description: >- @@ -42101,6 +42210,7 @@ tags: name: Bulk Port-In - name: Callbacks - name: Cities + - name: Compliance - description: >- DLDA = Directory Listing and Directory Assistance. A DLDA resource associates a TN with a Street Address. This gets updated in a Network From 10890817ea1f782d8ac75f73a89897ce0362775c Mon Sep 17 00:00:00 2001 From: DX-Bandwidth Date: Fri, 21 Apr 2023 21:11:21 +0000 Subject: [PATCH 2/5] Add Code Snippets to Spec Files --- site/specs/numbers.yml | 24 +++--------------------- 1 file changed, 3 insertions(+), 21 deletions(-) diff --git a/site/specs/numbers.yml b/site/specs/numbers.yml index 65733ffea..d8ba6d10a 100644 --- a/site/specs/numbers.yml +++ b/site/specs/numbers.yml @@ -41010,37 +41010,19 @@ paths: BEL LEGAL Number portability - ADAMS + Lorem ipsum BEL PURCHASE Address or identification requirements - ADAMS + Lorem ipsum BEL SERVICE Compatibility issues - ADAMS - - - BEL - LEGAL - DOUGLAS - ADAMS - - - BEL - NRA - Reachability limitations - ADAMS - - - BEL - PORTING_PRICE - Mobile numbers - ADAMS + Lorem ipsum From 8aec66c0a241889b22817255284ea3f9eb4e8188 Mon Sep 17 00:00:00 2001 From: DX-Bandwidth Date: Fri, 21 Apr 2023 21:55:31 +0000 Subject: [PATCH 3/5] Add Code Snippets to Spec Files --- site/specs/numbers.yml | 12 +++++------- 1 file changed, 5 insertions(+), 7 deletions(-) diff --git a/site/specs/numbers.yml b/site/specs/numbers.yml index d8ba6d10a..4c2dc2c79 100644 --- a/site/specs/numbers.yml +++ b/site/specs/numbers.yml @@ -9947,7 +9947,7 @@ components: type: integer type: object type: object - RestrictionSearchResult: + Restriction: properties: CountryCodeA3: type: string @@ -9958,13 +9958,13 @@ components: RestrictionType: $ref: '#/components/schemas/RestrictionType' type: object - RestrictionSearchResults: + RestrictionResponse: properties: - CityResponse: + RestrictionResponse: properties: Restrictions: items: - $ref: '#/components/schemas/RestrictionSearchResult' + $ref: '#/components/schemas/Restriction' type: array type: object type: object @@ -9977,8 +9977,6 @@ components: - PORTING_PRICE example: GEOGRAPHIC type: string - xml: - name: RestrictionType RogerTerminationSettings: properties: SubnetAddressingAllowed: @@ -41027,7 +41025,7 @@ paths: schema: - $ref: '#/components/schemas/RestrictionSearchResults' + $ref: '#/components/schemas/RestrictionResponse' description: >- This response returns the list of cities, along with the Rate Centers that serve those Restrictions. If 'available' is specified From 749a301a82052d9aec2e8e67fc18822c9ed07145 Mon Sep 17 00:00:00 2001 From: DX-Bandwidth Date: Fri, 28 Apr 2023 20:54:45 +0000 Subject: [PATCH 4/5] Add Code Snippets to Spec Files --- site/specs/numbers.yml | 26 ++++++++++++++------------ 1 file changed, 14 insertions(+), 12 deletions(-) diff --git a/site/specs/numbers.yml b/site/specs/numbers.yml index 4c2dc2c79..6dd485cdf 100644 --- a/site/specs/numbers.yml +++ b/site/specs/numbers.yml @@ -748,6 +748,18 @@ components: required: true schema: type: string + CountryCodeA3QueryParam: + description: >- + Country code of the country in its ISO 3166-1 alpha-3 format. Note that + only one country code (i.e. USA, CAN, GBR etc.) is allowed when + configured by the user.


The system defaults country code to + search for restrictions in all countries we have coverage. + example: BEL + in: query + name: countryCodeA3 + required: false + schema: + type: string CreatedDateFromQueryParam: description: >- Checks the order's creation date against this value. Orders that have a @@ -9975,7 +9987,7 @@ components: - SERVICE - NRA - PORTING_PRICE - example: GEOGRAPHIC + example: LEGAL type: string RogerTerminationSettings: properties: @@ -40983,17 +40995,7 @@ paths: buying and configuring your numbers. operationId: ListRestrictions parameters: - - description: >- -

Country code of the country in its ISO 3166-1 alpha-3 format. - Note that only one country code (i.e. USA, CAN, GBR etc.) is allowed - when configured by the user.


The system defaults country code - to search for restrictions in all countries we have coverage.
- example: BEL - in: query - name: countryCodeA3 - required: false - schema: - type: string + - $ref: '#/components/parameters/CountryCodeA3QueryParam' responses: '200': content: From 771d0b99851efd4a6eae60a11d87716fc081b929 Mon Sep 17 00:00:00 2001 From: DX-Bandwidth Date: Sun, 30 Apr 2023 21:33:58 +0000 Subject: [PATCH 5/5] Add Code Snippets to Spec Files --- site/specs/numbers.yml | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/site/specs/numbers.yml b/site/specs/numbers.yml index 6dd485cdf..37ea261f0 100644 --- a/site/specs/numbers.yml +++ b/site/specs/numbers.yml @@ -752,8 +752,8 @@ components: description: >- Country code of the country in its ISO 3166-1 alpha-3 format. Note that only one country code (i.e. USA, CAN, GBR etc.) is allowed when - configured by the user.


The system defaults country code to - search for restrictions in all countries we have coverage. + configured by the user. The system defaults country code to search for + restrictions in all countries we have coverage. example: BEL in: query name: countryCodeA3 @@ -9986,7 +9986,6 @@ components: - PURCHASE - SERVICE - NRA - - PORTING_PRICE example: LEGAL type: string RogerTerminationSettings: