markups

Azure · Dec 15, 2023 · 4e09c02 · 4e09c02
1 parent 8e8f84a
commit 4e09c02
Show file tree

Hide file tree

Showing 19 changed files with 327 additions and 112 deletions.
diff --git a/specification/programmableconnectivity/Azure.ProgrammableConnectivity/apis/common.tsp b/specification/programmableconnectivity/Azure.ProgrammableConnectivity/apis/common.tsp
@@ -1,6 +1,5 @@
 import "@typespec/rest";
 import "@typespec/versioning";
-import "@azure-tools/typespec-autorest";
 import "@azure-tools/typespec-azure-core";
 
 using TypeSpec.Http;
@@ -54,7 +53,7 @@ model PhoneNumberModel {
 model ApcErrorResponse {
   @doc("The numerical error status eg 500, 404")
   status: int32;
-  
+
   @doc("The error code")
   code: string;
 
@@ -64,3 +63,30 @@ model ApcErrorResponse {
   @doc("The consent URL in case of a consent failure")
   consentUrl?: url;
 }
+
+@doc("IPv4 device indicator")
+model Ipv4Address {
+  /** IPv4 address may be specified in form <address/mask> as:
+          - address - an IPv4 number in dotted-quad form 1.2.3.4. Only this exact IP number will match the flow control rule.
+          - address/mask - an IP number as above with a mask width of the form 1.2.3.4/24.
+            In this case, all IP numbers from 1.2.3.0 to 1.2.3.255 will match. The bit width MUST be valid for the IP version. */
+  ipv4: string;
+
+  @doc("User equipment port.")
+  port: int32;
+}
+
+@doc("IPv6 device indicator")
+model Ipv6Address {
+  /** IPv6 address, following IETF 5952 format, may be specified in form <address/mask> as:
+          - address - The /128 subnet is optional for single addresses:
+            - 2001:db8:85a3:8d3:1319:8a2e:370:7344
+            - 2001:db8:85a3:8d3:1319:8a2e:370:7344/128
+          - address/mask - an IP v6 number with a mask:
+            - 2001:db8:85a3:8d3::0/64
+            - 2001:db8:85a3:8d3::/64 */
+  ipv6: string;
+
+  @doc("User equipment port.")
+  port: int32;
+}
diff --git a/specification/programmableconnectivity/Azure.ProgrammableConnectivity/apis/location.tsp b/specification/programmableconnectivity/Azure.ProgrammableConnectivity/apis/location.tsp
@@ -20,13 +20,21 @@ interface LocationInterface {
 
 /// Endpoints
 
-@resource("Apis")
-@doc("Static endpoint to access Location API")
+@resource("DeviceLocation")
+@doc("Static endpoint to access the Device Location API family.")
 model LocationEndpoint {
   @key
   @doc("Static endpoint")
   @visibility("read")
-  location: "Location";
+  location: LocationEnum;
+}
+
+/* Needed to add this enum because typespec was creating an x-ms-enum without a name
+   which was causing a failure during linting. */
+@doc("Location static endpoint enum")
+enum LocationEnum {
+  @doc("Static endpoint")
+  location: "Location",
 }
 
 /// Request models
@@ -59,8 +67,8 @@ model LocationVerifyRequest {
 
 @doc("Response verifying location")
 model LocationVerifyResponse {
-  @doc("True if the location is verified, False otherwise")
-  verified: boolean;
+  @doc("True if the location is in the specified area, False otherwise")
+  verificationResult: boolean;
 }
 
 /// Common models
@@ -77,30 +85,3 @@ model LocationDevice {
   @doc("IPv6 address and port of the device")
   ipv6Address?: Ipv6Address;
 }
-
-@doc("IPv4 device indicator")
-model Ipv4Address {
-  /** IPv4 address may be specified in form <address/mask> as:
-          - address - an IPv4 number in dotted-quad form 1.2.3.4. Only this exact IP number will match the flow control rule.
-          - address/mask - an IP number as above with a mask width of the form 1.2.3.4/24.
-            In this case, all IP numbers from 1.2.3.0 to 1.2.3.255 will match. The bit width MUST be valid for the IP version. */
-  ipv4: string;
-
-  @doc("User equipment port.")
-  port: int32;
-}
-
-@doc("IPv6 device indicator")
-model Ipv6Address {
-  /** IPv6 address, following IETF 5952 format, may be specified in form <address/mask> as:
-          - address - The /128 subnet is optional for single addresses:
-            - 2001:db8:85a3:8d3:1319:8a2e:370:7344
-            - 2001:db8:85a3:8d3:1319:8a2e:370:7344/128
-          - address/mask - an IP v6 number with a mask:
-            - 2001:db8:85a3:8d3::0/64
-            - 2001:db8:85a3:8d3::/64 */
-  ipv6: string;
-
-  @doc("User equipment port.")
-  port: int32;
-}
diff --git a/specification/programmableconnectivity/Azure.ProgrammableConnectivity/apis/network.tsp b/specification/programmableconnectivity/Azure.ProgrammableConnectivity/apis/network.tsp
@@ -21,13 +21,21 @@ interface Networks {
 
 /// Endpoints
 
-@resource("Apis")
-@doc("Static endpoint to access Network API")
+@resource("DeviceNetwork")
+@doc("Static endpoint to access the Device Network API family.")
 model NetworkRetrieveEndpoint {
   @key
   @doc("Static endpoint")
   @visibility("read")
-  network: "Network";
+  network: NetworkEnum;
+}
+
+/* Needed to add this enum because typespec was creating an x-ms-enum without a name
+   which was causing a failure during linting. */
+@doc("Network static endpoint enum")
+enum NetworkEnum {
+  @doc("Static endpoint")
+  network: "Network",
 }
 
 /// Common models

diff --git a/specification/programmableconnectivity/Azure.ProgrammableConnectivity/apis/number.tsp b/specification/programmableconnectivity/Azure.ProgrammableConnectivity/apis/number.tsp
@@ -40,13 +40,21 @@ interface NumberInterface {
 
 /// Endpoints
 
-@resource("Apis")
-@doc("Static endpoint to access Number API")
+@resource("NumberVerification")
+@doc("Static endpoint to access Number Verification API family")
 model NumberEndpoint {
   @key
   @doc("Static endpoint")
   @visibility("read")
-  number: "Number";
+  number: NumberEnum;
+}
+
+/* Needed to add this enum because typespec was creating an x-ms-enum without a name
+   which was causing a failure during linting. */
+@doc("Number static endpoint enum")
+enum NumberEnum {
+  @doc("Static endpoint")
+  number: "Number",
 }
 
 /// Request models
@@ -63,8 +71,8 @@ model NumberVerifyRequest {
 
 @doc("Response verifying number of device")
 model NumberVerifyResponse {
-  @doc("True if number is verified, False otherwise")
-  verified: boolean;
+  @doc("True if number if the phone number matches the device, False otherwise")
+  verificationResult: boolean;
 }
 
 @doc("Response with number of device")

diff --git a/specification/programmableconnectivity/Azure.ProgrammableConnectivity/apis/simswap.tsp b/specification/programmableconnectivity/Azure.ProgrammableConnectivity/apis/simswap.tsp
@@ -28,13 +28,21 @@ interface SimSwapInterface {
 
 /// Endpoints
 
-@resource("device")
-@doc("Static endpoint to access Location API")
+@resource("SimSwap")
+@doc("Static endpoint to access the Sim Swap API family")
 model SimSwapEndpoint {
   @key
   @doc("Static endpoint")
   @visibility("read")
-  simSwap: "SimSwap";
+  simSwap: SimSwapEnum;
+}
+
+/* Needed to add this enum because typespec was creating an x-ms-enum without a name
+   which was causing a failure during linting. */
+@doc("Number static endpoint enum")
+enum SimSwapEnum {
+  @doc("Static endpoint")
+  simSwap: "SimSwap",
 }
 
 /// Request models
@@ -69,7 +77,7 @@ model SimSwapRetrieveResponse {
 @doc("Response verifying SimSwap in period")
 model SimSwapVerifyResponse {
   @doc("True if the SIM has swapped in the specified period, False otherwise")
-  verified: boolean;
+  verificationResult: boolean;
 }
 
 /// Common models

diff --git a/...vity/Azure.ProgrammableConnectivity/examples/LocationInterface_Verify_MaximumSet_Gen.json b/...vity/Azure.ProgrammableConnectivity/examples/LocationInterface_Verify_MaximumSet_Gen.json
@@ -3,6 +3,7 @@
   "operationId": "LocationInterface_Verify",
   "parameters": {
     "api-version": "2023-11-14-preview",
+    "location": "Location",
     "x-ms-client-request-id": "123e4567-e89b-12d3-a456-426614174000",
     "apc-gateway-id": "zdgrzzaxlodrvewbksn",
     "body": {
@@ -30,7 +31,7 @@
   "responses": {
     "200": {
       "body": {
-        "verified": true
+        "verificationResult": true
       }
     }
   }

diff --git a/...onnectivity/Azure.ProgrammableConnectivity/examples/Networks_Retrieve_MaximumSet_Gen.json b/...onnectivity/Azure.ProgrammableConnectivity/examples/Networks_Retrieve_MaximumSet_Gen.json
@@ -3,6 +3,7 @@
   "operationId": "Networks_Retrieve",
   "parameters": {
     "api-version": "2023-11-14-preview",
+    "network": "Network",
     "x-ms-client-request-id": "123e4567-e89b-12d3-a456-426614174000",
     "apc-gateway-id": "zdgrzzaxlodrvewbksn",
     "body": {

diff --git a/...vity/Azure.ProgrammableConnectivity/examples/NumberInterface_Retrieve_MaximumSet_Gen.json b/...vity/Azure.ProgrammableConnectivity/examples/NumberInterface_Retrieve_MaximumSet_Gen.json
@@ -3,6 +3,7 @@
   "operationId": "NumberInterface_Retrieve",
   "parameters": {
     "api-version": "2023-11-14-preview",
+    "number": "Number",
     "x-ms-client-request-id": "123e4567-e89b-12d3-a456-426614174000",
     "apc-gateway-id": "zdgrzzaxlodrvewbksn",
     "body": {

diff --git a/...tivity/Azure.ProgrammableConnectivity/examples/NumberInterface_Verify_MaximumSet_Gen.json b/...tivity/Azure.ProgrammableConnectivity/examples/NumberInterface_Verify_MaximumSet_Gen.json
@@ -3,6 +3,7 @@
   "operationId": "NumberInterface_Verify",
   "parameters": {
     "api-version": "2023-11-14-preview",
+    "number": "Number",
     "x-ms-client-request-id": "123e4567-e89b-12d3-a456-426614174000",
     "apc-gateway-id": "zdgrzzaxlodrvewbksn",
     "body": {
@@ -17,7 +18,7 @@
   "responses": {
     "200": {
       "body": {
-        "verified": true
+        "verificationResult": true
       }
     }
   }

diff --git a/...ity/Azure.ProgrammableConnectivity/examples/SimSwapInterface_Retrieve_MaximumSet_Gen.json b/...ity/Azure.ProgrammableConnectivity/examples/SimSwapInterface_Retrieve_MaximumSet_Gen.json
@@ -3,6 +3,7 @@
   "operationId": "SimSwapInterface_Retrieve",
   "parameters": {
     "api-version": "2023-11-14-preview",
+    "simSwap": "SimSwap",
     "x-ms-client-request-id": "123e4567-e89b-12d3-a456-426614174000",
     "apc-gateway-id": "zdgrzzaxlodrvewbksn",
     "body": {

diff --git a/...ivity/Azure.ProgrammableConnectivity/examples/SimSwapInterface_Verify_MaximumSet_Gen.json b/...ivity/Azure.ProgrammableConnectivity/examples/SimSwapInterface_Verify_MaximumSet_Gen.json
@@ -3,6 +3,7 @@
   "operationId": "SimSwapInterface_Verify",
   "parameters": {
     "api-version": "2023-11-14-preview",
+    "simSwap": "SimSwap",
     "x-ms-client-request-id": "123e4567-e89b-12d3-a456-426614174000",
     "apc-gateway-id": "zdgrzzaxlodrvewbksn",
     "body": {
@@ -16,7 +17,7 @@
   "responses": {
     "200": {
       "body": {
-        "verified": true
+        "verificationResult": true
       }
     }
   }

diff --git a/specification/programmableconnectivity/Azure.ProgrammableConnectivity/main.tsp b/specification/programmableconnectivity/Azure.ProgrammableConnectivity/main.tsp
@@ -7,8 +7,6 @@ using TypeSpec.Http;
 using TypeSpec.Versioning;
 using Azure.Core;
 
-// TODO - how do we implement errors properly?
-// TODO - understand if this is the right way to set up auth
 @useAuth(
   [
     OAuth2Auth<[

diff --git a/...ectivity/preview/2023-11-14-preview/examples/LocationInterface_Verify_MaximumSet_Gen.json b/...ectivity/preview/2023-11-14-preview/examples/LocationInterface_Verify_MaximumSet_Gen.json
@@ -3,6 +3,7 @@
   "operationId": "LocationInterface_Verify",
   "parameters": {
     "api-version": "2023-11-14-preview",
+    "location": "Location",
     "x-ms-client-request-id": "123e4567-e89b-12d3-a456-426614174000",
     "apc-gateway-id": "zdgrzzaxlodrvewbksn",
     "body": {
@@ -30,7 +31,7 @@
   "responses": {
     "200": {
       "body": {
-        "verified": true
+        "verificationResult": true
       }
     }
   }

diff --git a/...bleConnectivity/preview/2023-11-14-preview/examples/Networks_Retrieve_MaximumSet_Gen.json b/...bleConnectivity/preview/2023-11-14-preview/examples/Networks_Retrieve_MaximumSet_Gen.json
@@ -3,6 +3,7 @@
   "operationId": "Networks_Retrieve",
   "parameters": {
     "api-version": "2023-11-14-preview",
+    "network": "Network",
     "x-ms-client-request-id": "123e4567-e89b-12d3-a456-426614174000",
     "apc-gateway-id": "zdgrzzaxlodrvewbksn",
     "body": {

diff --git a/...ectivity/preview/2023-11-14-preview/examples/NumberInterface_Retrieve_MaximumSet_Gen.json b/...ectivity/preview/2023-11-14-preview/examples/NumberInterface_Retrieve_MaximumSet_Gen.json
@@ -3,6 +3,7 @@
   "operationId": "NumberInterface_Retrieve",
   "parameters": {
     "api-version": "2023-11-14-preview",
+    "number": "Number",
     "x-ms-client-request-id": "123e4567-e89b-12d3-a456-426614174000",
     "apc-gateway-id": "zdgrzzaxlodrvewbksn",
     "body": {

diff --git a/...nnectivity/preview/2023-11-14-preview/examples/NumberInterface_Verify_MaximumSet_Gen.json b/...nnectivity/preview/2023-11-14-preview/examples/NumberInterface_Verify_MaximumSet_Gen.json
@@ -3,6 +3,7 @@
   "operationId": "NumberInterface_Verify",
   "parameters": {
     "api-version": "2023-11-14-preview",
+    "number": "Number",
     "x-ms-client-request-id": "123e4567-e89b-12d3-a456-426614174000",
     "apc-gateway-id": "zdgrzzaxlodrvewbksn",
     "body": {
@@ -17,7 +18,7 @@
   "responses": {
     "200": {
       "body": {
-        "verified": true
+        "verificationResult": true
       }
     }
   }

diff --git a/...ctivity/preview/2023-11-14-preview/examples/SimSwapInterface_Retrieve_MaximumSet_Gen.json b/...ctivity/preview/2023-11-14-preview/examples/SimSwapInterface_Retrieve_MaximumSet_Gen.json
@@ -3,6 +3,7 @@
   "operationId": "SimSwapInterface_Retrieve",
   "parameters": {
     "api-version": "2023-11-14-preview",
+    "simSwap": "SimSwap",
     "x-ms-client-request-id": "123e4567-e89b-12d3-a456-426614174000",
     "apc-gateway-id": "zdgrzzaxlodrvewbksn",
     "body": {

diff --git a/...nectivity/preview/2023-11-14-preview/examples/SimSwapInterface_Verify_MaximumSet_Gen.json b/...nectivity/preview/2023-11-14-preview/examples/SimSwapInterface_Verify_MaximumSet_Gen.json
@@ -3,6 +3,7 @@
   "operationId": "SimSwapInterface_Verify",
   "parameters": {
     "api-version": "2023-11-14-preview",
+    "simSwap": "SimSwap",
     "x-ms-client-request-id": "123e4567-e89b-12d3-a456-426614174000",
     "apc-gateway-id": "zdgrzzaxlodrvewbksn",
     "body": {
@@ -16,7 +17,7 @@
   "responses": {
     "200": {
       "body": {
-        "verified": true
+        "verificationResult": true
       }
     }
   }