[Confidential Ledger] Post Board Review Changes (#19752)

* beginning updates

* updating stable version

* post -> create

* fixing next link setup

* prettier fix

* Update specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/stable/2022-05-13/confidentialledger.json

Co-authored-by: Mike Kistler <[email protected]>

* collection array revert

* update list collections example

* identity service update

* add x-ms-pageable to consortium

* revert resource manager changes

* add pagination to collections

* lyndon edits

* laurent fix

Co-authored-by: Mike Kistler <[email protected]>

Author: deer-prudence

specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/stable/2022-05-13/confidentialledger.json

@@ -6,12 +6,12 @@
     "description": "The ConfidentialLedgerClient writes and retrieves ledger entries against the Confidential Ledger service."
   },
   "x-ms-parameterized-host": {
-    "hostTemplate": "{ledgerUri}",
+    "hostTemplate": "{ledgerEndpoint}",
     "useSchemePrefix": false,
     "positionInOperation": "first",
     "parameters": [
       {
-        "name": "ledgerUri",
+        "name": "ledgerEndpoint",
         "description": "The Confidential Ledger URL, for example https://contoso.confidentialledger.azure.com",
         "required": true,
         "type": "string",
@@ -62,13 +62,17 @@
     },
     "/app/governance/members": {
       "get": {
-        "operationId": "GetConsortiumMembers",
+        "operationId": "ListConsortiumMembers",
         "x-ms-examples": {
-          "GetConsortiumMembers": {
-            "$ref": "./examples/ledger/GetConsortiumMembers.json"
+          "ListConsortiumMembers": {
+            "$ref": "./examples/ledger/ListConsortiumMembers.json"
           }
         },
-        "summary": "Gets the consortium members.",
+        "x-ms-pageable": {
+          "itemName": "members",
+          "nextLinkName": "nextLink"
+        },
+        "summary": "Lists the consortium members.",
         "description": "Consortium members can manage the Confidential Ledger.",
         "parameters": [
           {
@@ -130,6 +134,10 @@
             "$ref": "./examples/ledger/ListCollections.json"
           }
         },
+        "x-ms-pageable": {
+          "itemName": "collections",
+          "nextLinkName": "nextLink"
+        },
         "summary": "Retrieves a list of collection ids present in the Confidential Ledger",
         "description": "Collection ids are user-created collections of ledger entries",
         "parameters": [
@@ -141,7 +149,7 @@
           "200": {
             "description": "List of collections",
             "schema": {
-              "$ref": "#/definitions/CollectionArray"
+              "$ref": "#/definitions/PagedCollections"
             }
           },
           "default": {
@@ -157,7 +165,7 @@
       "get": {
         "operationId": "ListLedgerEntries",
         "x-ms-examples": {
-          "GetLedgerEntries": {
+          "ListLedgerEntries": {
             "$ref": "./examples/ledger/ListLedgerEntries.json"
           }
         },
@@ -197,10 +205,10 @@
         }
       },
       "post": {
-        "operationId": "PostLedgerEntry",
+        "operationId": "CreateLedgerEntry",
         "x-ms-examples": {
-          "PostLedgerEntry": {
-            "$ref": "./examples/ledger/PostLedgerEntry.json"
+          "CreateLedgerEntry": {
+            "$ref": "./examples/ledger/CreateLedgerEntry.json"
           }
         },
         "summary": "Writes a ledger entry.",
@@ -510,6 +518,10 @@
           "items": {
             "$ref": "#/definitions/ConsortiumMember"
           }
+        },
+        "nextLink": {
+          "description": "Path from which to retrieve the next page of results.",
+          "type": "string"
         }
       },
       "type": "object"
@@ -826,12 +838,24 @@
       },
       "type": "object"
     },
-    "CollectionArray": {
-      "description": "A list of identifiers for ledger collections.",
-      "items": {
-        "$ref": "#/definitions/Collection"
-      },
-      "type": "array"
+    "PagedCollections": {
+      "description": "Paginated collections returned in response to a query.",
+      "type": "object",
+      "required": [
+        "collections"
+      ],
+      "properties": {
+        "collections": {
+          "items": {
+            "$ref": "#/definitions/Collection"
+          },
+          "type": "array"
+        },
+        "nextLink": {
+          "description": "Path from which to retrieve the next page of results.",
+          "type": "string"
+        }
+      }
     },
     "TransactionId": {
       "description": "A unique identifier for the state of the ledger. If returned as part of a LedgerEntry, it indicates the state from which the entry was read.",

specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/stable/2022-05-13/examples/identity/GetLedgerIdentity.json

@@ -2,7 +2,7 @@
   "parameters": {
     "api-version": "2022-05-13",
     "ledgerId": "contoso-ledger-12345",
-    "identityServiceUri": "identity.accledger.azure.com"
+    "certificateClientEndpoint": "identity.confidential-ledger.core.azure.com"
   },
   "responses": {
     "200": {

specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/stable/2022-05-13/examples/ledger/PostLedgerEntry.json renamed to specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/stable/2022-05-13/examples/ledger/CreateLedgerEntry.json

@@ -5,14 +5,17 @@
   },
   "responses": {
     "200": {
-      "body": [
-        {
-          "collectionId": "first"
-        },
-        {
-          "collectionId": "second"
-        }
-      ]
+      "body": {
+        "collections": [
+          {
+            "collectionId": "first"
+          },
+          {
+            "collectionId": "second"
+          }
+        ]
+      },
+      "nextLink": "<link>"
     }
   }
 }

specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/stable/2022-05-13/examples/ledger/ListCollections.json

@@ -11,7 +11,8 @@
             "certificate": "<PEM certificate>",
             "id": "0"
           }
-        ]
+        ],
+        "nextLink": "<link>"
       }
     }
   }

specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/stable/2022-05-13/examples/ledger/GetConsortiumMembers.json renamed to specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/stable/2022-05-13/examples/ledger/ListConsortiumMembers.json

@@ -2,17 +2,17 @@
   "swagger": "2.0",
   "info": {
     "version": "2022-05-13",
-    "title": "ConfidentialLedgerIdentityServiceClient",
-    "description": "The ConfidentialLedgerIdentityServiceClient is used to retrieve the TLS certificate required for connecting to a Confidential Ledger."
+    "title": "ConfidentialLedgerCertificateClient",
+    "description": "The ConfidentialLedgerCertificateClient is used to retrieve the TLS certificate required for connecting to a Confidential Ledger."
   },
   "x-ms-parameterized-host": {
-    "hostTemplate": "{identityServiceUri}",
+    "hostTemplate": "{certificateClientEndpoint}",
     "useSchemePrefix": false,
     "positionInOperation": "first",
     "parameters": [
       {
-        "name": "identityServiceUri",
-        "description": "The Identity Service URL, for example https://identity.accledger.azure.com",
+        "name": "certificateClientEndpoint",
+        "description": "The certificate client endpoint, for example https://identity.confidential-ledger.core.azure.com",
         "required": true,
         "type": "string",
         "in": "path",