Renamed pager APIs per new guidelines (Azure#17677)

* Renamed pager APIs per new guidelines

Removed duplicated pager creation code.

* remove empty path param check

* fix doc comments

Author: jhendrixMSFT

sdk/keyvault/azcertificates/CHANGELOG.md

@@ -1,14 +1,16 @@
 # Release History
 
-## 0.3.1 (Unreleased)
-
-### Features Added
+## 0.4.0 (2022-04-21)
 
 ### Breaking Changes
-
-### Bugs Fixed
+* Renamed the following methods
+  * `Client.ListPropertiesOfCertificates` to `Client.NewListPropertiesOfCertificatesPager`
+  * `Client.ListPropertiesOfCertificateVersions` to `Client.NewListPropertiesOfCertificateVersionsPager`
+  * `Client.ListPropertiesOfIssuers` to `Client.NewListPropertiesOfIssuersPager`
+  * `Client.ListDeletedCertificates` to `Client.NewListDeletedCertificatesPager`
 
 ### Other Changes
+* Regenerated code with latest code generator (no visible changes).
 
 ## 0.3.0 (2022-04-06)
 

sdk/keyvault/azcertificates/autorest.md

@@ -10,11 +10,24 @@ input-file:
 license-header: MICROSOFT_MIT_NO_VERSION
 clear-output-folder: true
 output-folder: internal/generated
-module: azcertificates
 openapi-type: "data-plane"
 security: "AADToken"
 security-scopes:  "https://vault.azure.net/.default"
-use: "@autorest/go@4.0.0-preview.38"
-module-version: 0.3.0
+use: "@autorest/go@4.0.0-preview.40"
+module-version: 0.4.0
 export-clients: true
+
+# remove the empty certificateVersion path param check.  it's legal for KV but can't be described in OpenAPI
+directive:
+  - from: constants.go
+    where: $
+    transform: >-
+      return $.
+        replace(/moduleName\s+=\s+"generated"/, `ModuleName = "azcertificates"`).
+        replace(/moduleVersion\s+=/, `ModuleVersion =`);
+  - from: keyvault_client.go
+    where: $
+    transform: >-
+      return $.
+        replaceAll(/\sif certificateVersion == "" \{\s+return nil, errors\.New\("parameter certificateVersion cannot be empty"\)\s+\}\s/g, ``);
 ```

sdk/keyvault/azcertificates/build.go

@@ -0,0 +1,9 @@
+//go:build go1.18
+// +build go1.18
+
+//go:generate autorest ./autorest.md
+
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License. See License.txt in the project root for license information.
+
+package azcertificates

sdk/keyvault/azcertificates/client.go

@@ -632,38 +632,22 @@ func listCertsPageFromGenerated(i generated.KeyVaultClientGetCertificatesRespons
 	}
 }
 
-// ListPropertiesOfCertificates retrieves a list of the certificates in the Key Vault as JSON Web Key structures that contain the
+// NewListPropertiesOfCertificatesPager retrieves a list of the certificates in the Key Vault as JSON Web Key structures that contain the
 // public part of a stored certificate. The LIST operation is applicable to all certificate types, however only the
 // base certificate identifier, attributes, and tags are provided in the response. Individual versions of a
 // certificate are not listed in the response. This operation requires the certificates/list permission.
-func (c *Client) ListPropertiesOfCertificates(options *ListCertificatesOptions) *runtime.Pager[ListPropertiesOfCertificatesResponse] {
+func (c *Client) NewListPropertiesOfCertificatesPager(options *ListCertificatesOptions) *runtime.Pager[ListPropertiesOfCertificatesResponse] {
+	pager := c.genClient.NewGetCertificatesPager(c.vaultURL, nil)
 	return runtime.NewPager(runtime.PageProcessor[ListPropertiesOfCertificatesResponse]{
 		More: func(page ListPropertiesOfCertificatesResponse) bool {
-			return page.NextLink != nil && len(*page.NextLink) > 0
+			return pager.More()
 		},
-		Fetcher: func(ctx context.Context, page *ListPropertiesOfCertificatesResponse) (ListPropertiesOfCertificatesResponse, error) {
-			var req *policy.Request
-			var err error
-			if page == nil {
-				req, err = c.genClient.GetCertificatesCreateRequest(ctx, c.vaultURL, &generated.KeyVaultClientGetCertificatesOptions{})
-			} else {
-				req, err = runtime.NewRequest(ctx, http.MethodGet, *page.NextLink)
-			}
-			if err != nil {
-				return ListPropertiesOfCertificatesResponse{}, err
-			}
-			resp, err := c.genClient.Pl.Do(req)
-			if err != nil {
-				return ListPropertiesOfCertificatesResponse{}, err
-			}
-			if !runtime.HasStatusCode(resp, http.StatusOK) {
-				return ListPropertiesOfCertificatesResponse{}, runtime.NewResponseError(resp)
-			}
-			genResp, err := c.genClient.GetCertificatesHandleResponse(resp)
+		Fetcher: func(ctx context.Context, cur *ListPropertiesOfCertificatesResponse) (ListPropertiesOfCertificatesResponse, error) {
+			page, err := pager.NextPage(ctx)
 			if err != nil {
 				return ListPropertiesOfCertificatesResponse{}, err
 			}
-			return listCertsPageFromGenerated(genResp), nil
+			return listCertsPageFromGenerated(page), nil
 		},
 	})
 }
@@ -698,37 +682,21 @@ func listCertificateVersionsPageFromGenerated(i generated.KeyVaultClientGetCerti
 	}
 }
 
-// ListPropertiesOfCertificateVersions lists all versions of the specified certificate. The full certificate identifer and
+// NewListPropertiesOfCertificateVersionsPager lists all versions of the specified certificate. The full certificate identifer and
 // attributes are provided in the response. No values are returned for the certificates. This operation
 // requires the certificates/list permission.
-func (c *Client) ListPropertiesOfCertificateVersions(certificateName string, options *ListCertificateVersionsOptions) *runtime.Pager[ListPropertiesOfCertificateVersionsResponse] {
+func (c *Client) NewListPropertiesOfCertificateVersionsPager(certificateName string, options *ListCertificateVersionsOptions) *runtime.Pager[ListPropertiesOfCertificateVersionsResponse] {
+	pager := c.genClient.NewGetCertificateVersionsPager(c.vaultURL, certificateName, nil)
 	return runtime.NewPager(runtime.PageProcessor[ListPropertiesOfCertificateVersionsResponse]{
 		More: func(page ListPropertiesOfCertificateVersionsResponse) bool {
-			return page.NextLink != nil && len(*page.NextLink) > 0
+			return pager.More()
 		},
-		Fetcher: func(ctx context.Context, page *ListPropertiesOfCertificateVersionsResponse) (ListPropertiesOfCertificateVersionsResponse, error) {
-			var req *policy.Request
-			var err error
-			if page == nil {
-				req, err = c.genClient.GetCertificateVersionsCreateRequest(ctx, c.vaultURL, certificateName, &generated.KeyVaultClientGetCertificateVersionsOptions{})
-			} else {
-				req, err = runtime.NewRequest(ctx, http.MethodGet, *page.NextLink)
-			}
-			if err != nil {
-				return ListPropertiesOfCertificateVersionsResponse{}, err
-			}
-			resp, err := c.genClient.Pl.Do(req)
-			if err != nil {
-				return ListPropertiesOfCertificateVersionsResponse{}, err
-			}
-			if !runtime.HasStatusCode(resp, http.StatusOK) {
-				return ListPropertiesOfCertificateVersionsResponse{}, runtime.NewResponseError(resp)
-			}
-			genResp, err := c.genClient.GetCertificateVersionsHandleResponse(resp)
+		Fetcher: func(ctx context.Context, cur *ListPropertiesOfCertificateVersionsResponse) (ListPropertiesOfCertificateVersionsResponse, error) {
+			page, err := pager.NextPage(ctx)
 			if err != nil {
 				return ListPropertiesOfCertificateVersionsResponse{}, err
 			}
-			return listCertificateVersionsPageFromGenerated(genResp), nil
+			return listCertificateVersionsPageFromGenerated(page), nil
 		},
 	})
 }
@@ -916,36 +884,20 @@ func listIssuersPageFromGenerated(i generated.KeyVaultClientGetCertificateIssuer
 	return ListIssuersPropertiesOfIssuersResponse{Issuers: vals, NextLink: i.NextLink}
 }
 
-// ListPropertiesOfIssuers returns a pager that can be used to get the set of certificate issuer resources in the specified key vault. This operation
+// NewListPropertiesOfIssuersPager returns a pager that can be used to get the set of certificate issuer resources in the specified key vault. This operation
 // requires the certificates/manageissuers/getissuers permission.
-func (c *Client) ListPropertiesOfIssuers(options *ListPropertiesOfIssuersOptions) *runtime.Pager[ListIssuersPropertiesOfIssuersResponse] {
+func (c *Client) NewListPropertiesOfIssuersPager(options *ListPropertiesOfIssuersOptions) *runtime.Pager[ListIssuersPropertiesOfIssuersResponse] {
+	pager := c.genClient.NewGetCertificateIssuersPager(c.vaultURL, nil)
 	return runtime.NewPager(runtime.PageProcessor[ListIssuersPropertiesOfIssuersResponse]{
 		More: func(page ListIssuersPropertiesOfIssuersResponse) bool {
-			return page.NextLink != nil && len(*page.NextLink) > 0
+			return pager.More()
 		},
-		Fetcher: func(ctx context.Context, page *ListIssuersPropertiesOfIssuersResponse) (ListIssuersPropertiesOfIssuersResponse, error) {
-			var req *policy.Request
-			var err error
-			if page == nil {
-				req, err = c.genClient.GetCertificateIssuersCreateRequest(ctx, c.vaultURL, &generated.KeyVaultClientGetCertificateIssuersOptions{})
-			} else {
-				req, err = runtime.NewRequest(ctx, http.MethodGet, *page.NextLink)
-			}
-			if err != nil {
-				return ListIssuersPropertiesOfIssuersResponse{}, err
-			}
-			resp, err := c.genClient.Pl.Do(req)
-			if err != nil {
-				return ListIssuersPropertiesOfIssuersResponse{}, err
-			}
-			if !runtime.HasStatusCode(resp, http.StatusOK) {
-				return ListIssuersPropertiesOfIssuersResponse{}, runtime.NewResponseError(resp)
-			}
-			genResp, err := c.genClient.GetCertificateIssuersHandleResponse(resp)
+		Fetcher: func(ctx context.Context, cur *ListIssuersPropertiesOfIssuersResponse) (ListIssuersPropertiesOfIssuersResponse, error) {
+			page, err := pager.NextPage(ctx)
 			if err != nil {
 				return ListIssuersPropertiesOfIssuersResponse{}, err
 			}
-			return listIssuersPageFromGenerated(genResp), nil
+			return listIssuersPageFromGenerated(page), nil
 		},
 	})
 }
@@ -1577,37 +1529,21 @@ type ListDeletedCertificatesOptions struct {
 	// placeholder for future optional parameters
 }
 
-// ListDeletedCertificates retrieves the certificates in the current vault which are in a deleted state and ready for recovery or purging.
+// NewListDeletedCertificatesPager retrieves the certificates in the current vault which are in a deleted state and ready for recovery or purging.
 // This operation includes deletion-specific information. This operation requires the certificates/get/list permission. This operation can
 // only be enabled on soft-delete enabled vaults.
-func (c *Client) ListDeletedCertificates(options *ListDeletedCertificatesOptions) *runtime.Pager[ListDeletedCertificatesResponse] {
+func (c *Client) NewListDeletedCertificatesPager(options *ListDeletedCertificatesOptions) *runtime.Pager[ListDeletedCertificatesResponse] {
+	pager := c.genClient.NewGetDeletedCertificatesPager(c.vaultURL, nil)
 	return runtime.NewPager(runtime.PageProcessor[ListDeletedCertificatesResponse]{
 		More: func(page ListDeletedCertificatesResponse) bool {
-			return page.NextLink != nil && len(*page.NextLink) > 0
+			return pager.More()
 		},
-		Fetcher: func(ctx context.Context, page *ListDeletedCertificatesResponse) (ListDeletedCertificatesResponse, error) {
-			var req *policy.Request
-			var err error
-			if page == nil {
-				req, err = c.genClient.GetDeletedCertificatesCreateRequest(ctx, c.vaultURL, &generated.KeyVaultClientGetDeletedCertificatesOptions{})
-			} else {
-				req, err = runtime.NewRequest(ctx, http.MethodGet, *page.NextLink)
-			}
-			if err != nil {
-				return ListDeletedCertificatesResponse{}, err
-			}
-			resp, err := c.genClient.Pl.Do(req)
-			if err != nil {
-				return ListDeletedCertificatesResponse{}, err
-			}
-			if !runtime.HasStatusCode(resp, http.StatusOK) {
-				return ListDeletedCertificatesResponse{}, runtime.NewResponseError(resp)
-			}
-			genResp, err := c.genClient.GetDeletedCertificatesHandleResponse(resp)
+		Fetcher: func(ctx context.Context, cur *ListDeletedCertificatesResponse) (ListDeletedCertificatesResponse, error) {
+			page, err := pager.NextPage(ctx)
 			if err != nil {
 				return ListDeletedCertificatesResponse{}, err
 			}
-			return listDeletedCertsPageFromGenerated(genResp), nil
+			return listDeletedCertsPageFromGenerated(page), nil
 		},
 	})
 }

sdk/keyvault/azcertificates/client_test.go

@@ -275,7 +275,7 @@ func TestClient_ListCertificates(t *testing.T) {
 
 	time.Sleep(10 * delay())
 
-	pager := client.ListPropertiesOfCertificates(nil)
+	pager := client.NewListPropertiesOfCertificatesPager(nil)
 	for pager.More() {
 		page, err := pager.NextPage(context.Background())
 		require.NoError(t, err)
@@ -301,7 +301,7 @@ func TestClient_ListCertificateVersions(t *testing.T) {
 	time.Sleep(10 * delay())
 	defer cleanUp(t, client, name)
 
-	pager := client.ListPropertiesOfCertificateVersions(name, nil)
+	pager := client.NewListPropertiesOfCertificateVersionsPager(name, nil)
 	count := 0
 	for pager.More() {
 		resp, err := pager.NextPage(context.Background())
@@ -315,7 +315,7 @@ func TestClient_ListCertificateVersions(t *testing.T) {
 	createCert(t, client, name)
 	time.Sleep(10 * delay())
 
-	pager = client.ListPropertiesOfCertificateVersions(name, nil)
+	pager = client.NewListPropertiesOfCertificateVersionsPager(name, nil)
 	count = 0
 	for pager.More() {
 		resp, err := pager.NextPage(context.Background())
@@ -329,7 +329,7 @@ func TestClient_ListCertificateVersions(t *testing.T) {
 	createCert(t, client, name)
 	time.Sleep(10 * delay())
 
-	pager = client.ListPropertiesOfCertificateVersions(name, nil)
+	pager = client.NewListPropertiesOfCertificateVersionsPager(name, nil)
 	count = 0
 	for pager.More() {
 		resp, err := pager.NextPage(context.Background())
@@ -414,7 +414,7 @@ func TestClient_IssuerCRUD(t *testing.T) {
 	require.Equal(t, issuerName2, *createResp.Issuer.Name)
 
 	// List operation
-	pager := client.ListPropertiesOfIssuers(nil)
+	pager := client.NewListPropertiesOfIssuersPager(nil)
 	count := 0
 	for pager.More() {
 		page, err := pager.NextPage(context.Background())
@@ -886,7 +886,7 @@ func TestClient_ListDeletedCertificates(t *testing.T) {
 
 	time.Sleep(10 * delay())
 
-	pager := client.ListDeletedCertificates(nil)
+	pager := client.NewListDeletedCertificatesPager(nil)
 	deletedCount := 0
 	for pager.More() {
 		page, err := pager.NextPage(ctx)

sdk/keyvault/azcertificates/example_test.go

@@ -133,7 +133,7 @@ func ExampleClient_UpdateCertificateProperties() {
 	fmt.Println(resp.Properties.Tags)
 }
 
-func ExampleClient_ListPropertiesOfCertificates() {
+func ExampleClient_NewListPropertiesOfCertificatesPager() {
 	cred, err := azidentity.NewDefaultAzureCredential(nil)
 	if err != nil {
 		panic(err)
@@ -149,7 +149,7 @@ func ExampleClient_ListPropertiesOfCertificates() {
 		panic(err)
 	}
 
-	pager := client.ListPropertiesOfCertificates(nil)
+	pager := client.NewListPropertiesOfCertificatesPager(nil)
 	for pager.More() {
 		page, err := pager.NextPage(context.TODO())
 		if err != nil {