Updated docstr and typehints to reflect apiview.dev requirements (Azure#18818)

* Updated docstr and typehints to reflect apiview.dev requirements

Author: LarryOsterman

sdk/attestation/azure-security-attestation/azure/security/attestation/_administration_client.py

@@ -44,9 +44,11 @@
 class AttestationAdministrationClient(object):
     """Provides administrative APIs for managing an instance of the Attestation Service.
 
-    :param str instance_url: base url of the service
+    :param instance_url: base url of the service
+    :type instance_url: str
     :param credential: Credentials for the caller used to interact with the service.
-    :type credential: azure.core.credentials.TokenCredential
+    :type credential: :class:`~azure.core.credentials.TokenCredential`
+
     :keyword Pipeline pipeline: If omitted, the standard pipeline is used.
     :keyword HttpTransport transport: If omitted, the standard pipeline is used.
     :keyword list[HTTPPolicy] policies: If omitted, the standard pipeline is used.
@@ -68,12 +70,17 @@ def __init__(
 
     @distributed_trace
     def get_policy(self, attestation_type, **kwargs): 
-        #type(AttestationType, **Any) -> AttestationResult[str]:
+        #type(AttestationType, **Any) -> AttestationResponse[str]:
         """ Retrieves the attestation policy for a specified attestation type.
 
-        :param azure.security.attestation.AttestationType attestation_type: :class:`azure.security.attestation.AttestationType` for 
+        :param attestation_type: :class:`azure.security.attestation.AttestationType` for 
             which to retrieve the policy.
-        :return azure.security.attestation.AttestationResponse[str]: Attestation service response encapsulating a string attestation policy.
+        
+        :type attestation_type: azure.security.attestation.AttestationType 
+
+        :return: Attestation service response encapsulating a string attestation policy.
+
+        :rtype: azure.security.attestation.AttestationResponse[str]
 
         :raises azure.security.attestation.AttestationTokenValidationException: Raised when an attestation token is invalid.
 
@@ -97,12 +104,20 @@ def set_policy(self, attestation_type, attestation_policy, signing_key=None, **k
         #type:(AttestationType, str, Optional[AttestationSigningKey], **Any) -> AttestationResponse[PolicyResult]
         """ Sets the attestation policy for the specified attestation type.
 
-        :param azure.security.attestation.AttestationType attestation_type: :class:`azure.security.attestation.AttestationType` for 
+        :param attestation_type: :class:`azure.security.attestation.AttestationType` for 
             which to set the policy.
-        :param str attestation_policy: Attestation policy to be set.
-        :keyword azure.security.attestation.AttestationSigningKey signing_key: Signing key to be
-            used to sign the policy before sending it to the service.
-        :return azure.security.attestation.AttestationResponse[azure.security.attestation.PolicyResult]: Attestation service response encapsulating a :class:`PolicyResult`.
+        :type attestation_type: azure.security.attestation.AttestationType
+        :param attestation_policy: Attestation policy to be set.
+        :type attestation_policy: str
+        :param signing_key: Signing key to be used to sign the policy
+            before sending it to the service.
+
+        :type signing_key: azure.security.attestation.AttestationSigningKey 
+
+        :return: Attestation service response encapsulating a :class:`PolicyResult`.
+
+        :rtype: azure.security.attestation.AttestationResponse[azure.security.attestation.PolicyResult]
+
         :raises azure.security.attestation.AttestationTokenValidationException: Raised when an attestation token is invalid.
 
         .. note::
@@ -133,12 +148,20 @@ def reset_policy(self, attestation_type, signing_key=None, **kwargs):
         #type:(AttestationType, Optional[AttestationSigningKey], **dict[str, Any]) -> AttestationResponse[PolicyResult]
         """ Resets the attestation policy for the specified attestation type to the default value.
 
-        :param azure.security.attestation.AttestationType attestation_type: :class:`azure.security.attestation.AttestationType` for 
+        :param attestation_type: :class:`azure.security.attestation.AttestationType` for 
             which to set the policy.
-        :param str attestation_policy: Attestation policy to be reset.
-        :keyword azure.security.attestation.AttestationSigningKey signing_key: Signing key to be
+        :type attestation_type: azure.security.attestation.AttestationType
+        :param attestation_policy: Attestation policy to be reset.
+        :type attestation_policy: str
+        :param signing_key: Signing key to be
             used to sign the policy before sending it to the service.
-        :return azure.security.attestation.AttestationResponse[azure.security.attestation.PolicyResult]: Attestation service response encapsulating a :class:`PolicyResult`.
+
+        :type signing_key: azure.security.attestation.AttestationSigningKey
+
+        :return: Attestation service response encapsulating a :class:`PolicyResult`.
+        
+        :rtype: azure.security.attestation.AttestationResponse[azure.security.attestation.PolicyResult]
+
         :raises azure.security.attestation.AttestationTokenValidationException: Raised when an attestation token is invalid.
 
         .. note::
@@ -170,8 +193,9 @@ def get_policy_management_certificates(self, **kwargs):
         The list of policy management certificates will only be non-empty if the
         attestation service instance is in Isolated mode.
 
-        :return azure.security.attestation.AttestationResponse[list[list[bytes]]: Attestation service response 
+        :return: Attestation service response 
             encapsulating a list of DER encoded X.509 certificate chains.
+        :rtype: azure.security.attestation.AttestationResponse[list[list[bytes]]]
         """
 
         cert_response = self._client.policy_certificates.get(**kwargs)
@@ -192,16 +216,20 @@ def get_policy_management_certificates(self, **kwargs):
 
     @distributed_trace
     def add_policy_management_certificate(self, certificate_to_add, signing_key, **kwargs):
-        #type:(bytes, AttestationSigningKey, **Any)-> AttestationResponse[PolicyCertificatesModificationResult]
+        #type:(bytes, AttestationSigningKey, **Any) -> AttestationResponse[PolicyCertificatesModificationResult]
         """ Adds a new policy management certificate to the set of policy management certificates for the instance.
 
         :param bytes certificate_to_add: DER encoded X.509 certificate to add to 
             the list of attestation policy management certificates.
-        :param azure.security.attestation.AttestationSigningKey signing_key: Signing Key representing one of 
+        :param signing_key: Signing Key representing one of 
             the *existing* attestation signing certificates.
-        :return azure.security.attestation.AttestationResponse[azure.security.attestation.PolicyCertificatesModificationResult]: Attestation service response 
+        :type signing_key: azure.security.attestation.AttestationSigningKey 
+
+        :return: Attestation service response 
             encapsulating the status of the add request.
 
+        :rtype: azure.security.attestation.AttestationResponse[azure.security.attestation.PolicyCertificatesModificationResult]
+
         The :class:`PolicyCertificatesModificationResult` response to the 
         :meth:`add_policy_management_certificate` API contains two attributes
         of interest. 
@@ -233,15 +261,17 @@ def add_policy_management_certificate(self, certificate_to_add, signing_key, **k
 
     @distributed_trace
     def remove_policy_management_certificate(self, certificate_to_add, signing_key, **kwargs):
-        #type:(bytes, AttestationSigningKey, **Any)-> AttestationResponse[PolicyCertificatesModificationResult]
+        #type:(bytes, AttestationSigningKey, **Any) -> AttestationResponse[PolicyCertificatesModificationResult]
         """ Removes a new policy management certificate to the set of policy management certificates for the instance.
 
         :param bytes certificate_to_add: DER encoded X.509 certificate to add to 
             the list of attestation policy management certificates.
-        :param azure.security.attestation.AttestationSigningKey signing_key: Signing Key representing one of 
+        :param signing_key: Signing Key representing one of 
             the *existing* attestation signing certificates.
-        :return azure.security.attestation.AttestationResponse[azure.security.attestation.PolicyCertificatesModificationResult]: Attestation service response 
+        :type signing_key: azure.security.attestation.AttestationSigningKey
+        :return: Attestation service response 
             encapsulating a list of DER encoded X.509 certificate chains.
+        :rtype: azure.security.attestation.AttestationResponse[azure.security.attestation.PolicyCertificatesModificationResult]
 
         The :class:`PolicyCertificatesModificationResult` response to the 
         :meth:`remove_policy_management_certificate` API contains two attributes

sdk/attestation/azure-security-attestation/azure/security/attestation/_client.py

@@ -41,12 +41,15 @@ class AttestationClient(object):
     """An AttestationClient object enables access to the Attestation family of APIs provided
       by the attestation service.
 
-    :param str base_url: base url of the service
+    :param str instance_url: base url of the service
     :param credential: Credentials for the caller used to interact with the service.
-    :type credential: ~azure.core.credentials.TokenCredentials
-    :keyword Pipeline pipeline: If omitted, the standard pipeline is used.
+    :type credential: :class:`~azure.core.credentials.TokenCredential`
+    :keyword pipeline: If omitted, the standard pipeline is used.
+    :paramtype pipeline: Pipeline
+    :keyword policies: If omitted, the standard pipeline is used.
+    :paramtype policies: list[HTTPPolicy]
     :keyword HttpTransport transport: If omitted, the standard pipeline is used.
-    :keyword list[HTTPPolicy] policies: If omitted, the standard pipeline is used.
+    :paramtype transport: HttpTransport
 
     For additional client creation configuration options, please see https://aka.ms/azsdk/python/options.
 
@@ -59,6 +62,7 @@ def __init__(
         **kwargs  # type: Any
     ):
         # type: (TokenCredential, str, Any) -> None
+
         if not credential:
             raise ValueError("Missing credential.")
         self._config = AttestationClientConfiguration(credential, instance_url, **kwargs)
@@ -67,18 +71,23 @@ def __init__(
         self._signing_certificates = None
 
     @distributed_trace
-    def get_openidmetadata(self):
-        #type:()->Any
+    def get_openidmetadata(self, **kwargs):
+        #type:(Dict[str, Any]) -> Any
         """ Retrieves the OpenID metadata configuration document for this attestation instance.
+
+        :return: OpenID metadata configuration
+        :rtype: Any
         """
-        return self._client.metadata_configuration.get()
+        return self._client.metadata_configuration.get(**kwargs)
 
     @distributed_trace
     def get_signing_certificates(self, **kwargs): 
-        # type: (Any) ->list[AttestationSigner]
+        # type: (Any) -> list[AttestationSigner]
         """ Returns the set of signing certificates used to sign attestation tokens.
 
-        :return list[azure.security.attestation.AttestationSigner]: A list of :class:`azure.security.attestation.AttestationSigner` objects.
+        :return: A list of :class:`azure.security.attestation.AttestationSigner` objects.
+
+        :rtype: list[azure.security.attestation.AttestationSigner]
 
         For additional request configuration options, please see `Python Request Options <https://aka.ms/azsdk/python/options>`_.
 
@@ -96,15 +105,21 @@ def attest_sgx_enclave(self, quote, inittime_data=None, runtime_data=None, **kwa
         """ Attests the validity of an SGX quote.
 
         :param bytes quote: An SGX quote generated from an Intel(tm) SGX enclave
-        :keyword azure.security.attestation.AttestationData inittime_data: Data presented at the time that the SGX enclave was initialized.
-        :keyword azure.security.attestation.AttestationData runtime_data: Data presented at the time that the SGX quote was created.
-        :keyword str draft_policy: "draft" or "experimental" policy to be used with
+        :param inittime_data: Data presented at the time that the SGX enclave was initialized.
+        :type inittime_data: azure.security.attestation.AttestationData 
+        :param runtime_data: Data presented at the time that the SGX quote was created.
+        :type runtime_data: azure.security.attestation.AttestationData
+        :keyword draft_policy: "draft" or "experimental" policy to be used with
             this attestation request. If this parameter is provided, then this 
             policy document will be used for the attestation request.
             This allows a caller to test various policy documents against actual data
             before applying the policy document via the set_policy API
 
-        :return azure.security.attestation.AttestationResponse[azure.security.attestation.AttestationResult]: Attestation service response encapsulating an :class:`AttestationResult`.
+        :paramtype draft_policy: str
+
+        :return: Attestation service response encapsulating an :class:`AttestationResult`.
+        
+        :rtype: azure.security.attestation.AttestationResponse[azure.security.attestation.AttestationResult]
 
         .. note::
             Note that if the `draft_policy` parameter is provided, the resulting attestation token will be an unsecured attestation token.
@@ -147,14 +162,21 @@ def attest_open_enclave(self, report, inittime_data=None, runtime_data=None, **k
         """ Attests the validity of an Open Enclave report.
 
         :param bytes report: An open_enclave report generated from an Intel(tm) SGX enclave
-        :keyword azure.security.attestation.AttestationData inittime_data: Data presented at the time that the SGX enclave was initialized.
-        :keyword azure.security.attestation.AttestationData runtime_data: Data presented at the time that the open_enclave report was created.
-        :keyword str draft_policy: "draft" or "experimental" policy to be used with
+        :param inittime_data: Data presented at the time that the SGX enclave was initialized.
+        :type inittime_data: azure.security.attestation.AttestationData 
+        :param runtime_data: Data presented at the time that the open_enclave report was created.
+        :type runtime_data: azure.security.attestation.AttestationData 
+        :keyword draft_policy: "draft" or "experimental" policy to be used with
             this attestation request. If this parameter is provided, then this 
             policy document will be used for the attestation request.
             This allows a caller to test various policy documents against actual data
             before applying the policy document via the set_policy API.
-        :return azure.security.attestation.AttestationResponse[azure.security.attestation.AttestationResult]: Attestation service response encapsulating an :class:`AttestationResult`.
+
+        :paramtype draft_policy: str
+
+        :return: Attestation service response encapsulating an :class:`AttestationResult`.
+
+        :rtype: azure.security.attestation.AttestationResponse[azure.security.attestation.AttestationResult]
 
         .. admonition:: Example: Simple OpenEnclave attestation.
 
@@ -208,9 +230,10 @@ def attest_tpm(self, request, **kwargs):
 
         See the `TPM Attestation Protocol Reference <https://docs.microsoft.com/en-us/azure/attestation/virtualization-based-security-protocol>`_ for more information.
 
-        :param azure.security.attestation.TpmAttestationRequest request: Incoming request to send to the TPM attestation service.
-        :returns azure.security.attestation.TpmAttestationResponse: A structure containing the response from the TPM attestation.
-
+        :param request: Incoming request to send to the TPM attestation service.
+        :type request: azure.security.attestation.TpmAttestationRequest
+        :returns: A structure containing the response from the TPM attestation.
+        :rtype: azure.security.attestation.TpmAttestationResponse
         """
         response = self._client.attestation.attest_tpm(request.data, **kwargs)
         return TpmAttestationResponse(response.data)