New public preview API for confidential ledger code transparency 2025…

…-01-31-preview (#31896) * CTS new preview API version with updated endpoints to match the draft SCRAPI IETF spec requirements * Merge TypeSpec files into one * Adds CBOR errors * Changes transparency-configuration to respond in either CBOR or JSON adds CBOR errors to entries responses * Examples for to the new api version * Remove older preview api endpoints * change @nextlink to @TypeSpec.nextLink as otherwise .net sdk does not generate * use explicit accept header for the sdk geneartor to skip accept parameter * remove deprecated methods as recommended in the api review as this was never GA'd and is in preview * simplify the api to only the minimum of required endpoints * adds content types to examples * remove unused examples * use Azure.Core.Versions.v1_0_Preview_1 instead of v2 * add LroExtensionback to supressions
Azure · Mar 6, 2025 · 6103692 · 6103692
1 parent 4bb168b
commit 6103692
Show file tree

Hide file tree

Showing 33 changed files with 2,187 additions and 456 deletions.
diff --git a/specification/confidentialledger/Microsoft.CodeTransparency/entries.tsp b/specification/confidentialledger/Microsoft.CodeTransparency/entries.tsp
diff --git a/...4-01-11-preview/examples/CreateEntry.json → ...-01-11-preview/CreateEntryDeprecated.json b/...4-01-11-preview/examples/CreateEntry.json → ...-01-11-preview/CreateEntryDeprecated.json
@@ -1,6 +1,6 @@
 {
-  "title": "CreateEntry",
-  "operationId": "CreateEntry",
+  "title": "CreateEntryDeprecated",
+  "operationId": "CreateEntryDeprecated",
   "parameters": {
     "api-version": "2024-01-11-preview",
     "body": "{binary}",

diff --git a/...ger/Microsoft.CodeTransparency/examples/2024-01-11-preview/GetCodeTransparencyConfig.json b/...ger/Microsoft.CodeTransparency/examples/2024-01-11-preview/GetCodeTransparencyConfig.json
@@ -12,6 +12,22 @@
         },
         "service_identifier": "did:web:servicename.confidential-ledger.azure.com"
       }
+    },
+    "500": {
+      "body": {
+        "error": {
+          "code": "zdjbm",
+          "message": "wftvioyvxidsm"
+        }
+      }
+    },
+    "503": {
+      "body": {
+        "error": {
+          "code": "zdjbm",
+          "message": "wftvioyvxidsm"
+        }
+      }
     }
   }
 }
diff --git a/...er/Microsoft.CodeTransparency/examples/2024-01-11-preview/GetCodeTransparencyVersion.json b/...er/Microsoft.CodeTransparency/examples/2024-01-11-preview/GetCodeTransparencyVersion.json
@@ -9,6 +9,22 @@
       "body": {
         "scitt_version": "0.6.1"
       }
+    },
+    "500": {
+      "body": {
+        "error": {
+          "code": "zdjbm",
+          "message": "wftvioyvxidsm"
+        }
+      }
+    },
+    "503": {
+      "body": {
+        "error": {
+          "code": "zdjbm",
+          "message": "wftvioyvxidsm"
+        }
+      }
     }
   }
 }
diff --git a/...2024-01-11-preview/examples/GetEntry.json → ...024-01-11-preview/GetEntryDeprecated.json b/...2024-01-11-preview/examples/GetEntry.json → ...024-01-11-preview/GetEntryDeprecated.json
@@ -1,6 +1,6 @@
 {
-  "title": "GetEntry",
-  "operationId": "GetEntry",
+  "title": "GetEntryDeprecated",
+  "operationId": "GetEntryDeprecated",
   "parameters": {
     "api-version": "2024-01-11-preview",
     "entryId": "2.131"

diff --git a/...examples/2024-01-11-preview/GetEntry.json → ...11-preview/GetEntryReceiptDeprecated.json b/...examples/2024-01-11-preview/GetEntry.json → ...11-preview/GetEntryReceiptDeprecated.json
@@ -1,6 +1,6 @@
 {
-  "title": "GetEntry",
-  "operationId": "GetEntry",
+  "title": "GetEntryReceiptDeprecated",
+  "operationId": "GetEntryReceiptDeprecated",
   "parameters": {
     "api-version": "2024-01-11-preview",
     "entryId": "2.131"

diff --git a/...nfidentialledger/Microsoft.CodeTransparency/examples/2024-01-11-preview/ListEntryIds.json b/...nfidentialledger/Microsoft.CodeTransparency/examples/2024-01-11-preview/ListEntryIds.json
@@ -13,6 +13,14 @@
         "nextLink": "/entries/txIds?from=20&to=40"
       }
     },
+    "500": {
+      "body": {
+        "error": {
+          "code": "zdjbm",
+          "message": "wftvioyvxidsm"
+        }
+      }
+    },
     "503": {
       "body": {
         "error": {

diff --git a/...onfidentialledger/Microsoft.CodeTransparency/examples/2025-01-31-preview/CreateEntry.json b/...onfidentialledger/Microsoft.CodeTransparency/examples/2025-01-31-preview/CreateEntry.json
@@ -0,0 +1,54 @@
+{
+  "title": "CreateEntry",
+  "operationId": "CreateEntry",
+  "parameters": {
+    "api-version": "2025-01-31-preview",
+    "body": "{binary}",
+    "Content-Type": "application/cose",
+    "accept": "application/cose; application/cbor"
+  },
+  "responses": {
+    "201": {
+      "headers": {
+        "Content-Type": "application/cose"
+      },
+      "body": "{binary}"
+    },
+    "202": {
+      "headers": {
+        "Content-Type": "application/cbor"
+      },
+      "body": "{binary}"
+    },
+    "400": {
+      "headers": {
+        "Content-Type": "application/concise-problem-details+cbor"
+      },
+      "body": "{binary}"
+    },
+    "404": {
+      "headers": {
+        "Content-Type": "application/concise-problem-details+cbor"
+      },
+      "body": "{binary}"
+    },
+    "429": {
+      "headers": {
+        "Content-Type": "application/concise-problem-details+cbor"
+      },
+      "body": "{binary}"
+    },
+    "500": {
+      "headers": {
+        "Content-Type": "application/concise-problem-details+cbor"
+      },
+      "body": "{binary}"
+    },
+    "503": {
+      "headers": {
+        "Content-Type": "application/concise-problem-details+cbor"
+      },
+      "body": "{binary}"
+    }
+  }
+}
diff --git a/...n/confidentialledger/Microsoft.CodeTransparency/examples/2025-01-31-preview/GetEntry.json b/...n/confidentialledger/Microsoft.CodeTransparency/examples/2025-01-31-preview/GetEntry.json
@@ -0,0 +1,47 @@
+{
+  "title": "GetEntry",
+  "operationId": "GetEntry",
+  "parameters": {
+    "api-version": "2025-01-31-preview",
+    "accept": "application/cose",
+    "entryId": "2.131"
+  },
+  "responses": {
+    "200": {
+      "headers": {
+        "Content-Type": "application/cose"
+      },
+      "body": "{binary}"
+    },
+    "400": {
+      "headers": {
+        "Content-Type": "application/concise-problem-details+cbor"
+      },
+      "body": "{binary}"
+    },
+    "404": {
+      "headers": {
+        "Content-Type": "application/concise-problem-details+cbor"
+      },
+      "body": "{binary}"
+    },
+    "429": {
+      "headers": {
+        "Content-Type": "application/concise-problem-details+cbor"
+      },
+      "body": "{binary}"
+    },
+    "500": {
+      "headers": {
+        "Content-Type": "application/concise-problem-details+cbor"
+      },
+      "body": "{binary}"
+    },
+    "503": {
+      "headers": {
+        "Content-Type": "application/concise-problem-details+cbor"
+      },
+      "body": "{binary}"
+    }
+  }
+}
diff --git a/...ntialledger/Microsoft.CodeTransparency/examples/2025-01-31-preview/GetEntryStatement.json b/...ntialledger/Microsoft.CodeTransparency/examples/2025-01-31-preview/GetEntryStatement.json
@@ -0,0 +1,47 @@
+{
+  "title": "GetEntryStatement",
+  "operationId": "GetEntryStatement",
+  "parameters": {
+    "api-version": "2025-01-31-preview",
+    "entryId": "2.131",
+    "accept": "application/cose"
+  },
+  "responses": {
+    "200": {
+      "headers": {
+        "Content-Type": "application/cose"
+      },
+      "body": "{binary}"
+    },
+    "400": {
+      "headers": {
+        "Content-Type": "application/concise-problem-details+cbor"
+      },
+      "body": "{binary}"
+    },
+    "404": {
+      "headers": {
+        "Content-Type": "application/concise-problem-details+cbor"
+      },
+      "body": "{binary}"
+    },
+    "429": {
+      "headers": {
+        "Content-Type": "application/concise-problem-details+cbor"
+      },
+      "body": "{binary}"
+    },
+    "500": {
+      "headers": {
+        "Content-Type": "application/concise-problem-details+cbor"
+      },
+      "body": "{binary}"
+    },
+    "503": {
+      "headers": {
+        "Content-Type": "application/concise-problem-details+cbor"
+      },
+      "body": "{binary}"
+    }
+  }
+}
diff --git a/...nfidentialledger/Microsoft.CodeTransparency/examples/2025-01-31-preview/GetOperation.json b/...nfidentialledger/Microsoft.CodeTransparency/examples/2025-01-31-preview/GetOperation.json
@@ -0,0 +1,48 @@
+{
+  "title": "GetOperation",
+  "operationId": "GetOperation",
+  "parameters": {
+    "api-version": "2025-01-31-preview",
+    "accept": "application/cbor",
+    "operationId": "2.131"
+  },
+  "responses": {
+    "200": {
+      "headers": {
+        "Content-Type": "application/cbor"
+      },
+      "body": "{binary}"
+    },
+    "202": {},
+    "400": {
+      "headers": {
+        "Content-Type": "application/concise-problem-details+cbor"
+      },
+      "body": "{binary}"
+    },
+    "404": {
+      "headers": {
+        "Content-Type": "application/concise-problem-details+cbor"
+      },
+      "body": "{binary}"
+    },
+    "429": {
+      "headers": {
+        "Content-Type": "application/concise-problem-details+cbor"
+      },
+      "body": "{binary}"
+    },
+    "500": {
+      "headers": {
+        "Content-Type": "application/concise-problem-details+cbor"
+      },
+      "body": "{binary}"
+    },
+    "503": {
+      "headers": {
+        "Content-Type": "application/concise-problem-details+cbor"
+      },
+      "body": "{binary}"
+    }
+  }
+}