Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Reference doc bug bash (look for both content issues and rendering issues) for Key Vault #15110

Closed
AlexGhiondea opened this issue Nov 8, 2020 · 2 comments
Assignees
Labels
Client This issue points to a problem in the data-plane of the library. KeyVault
Milestone

Comments

@AlexGhiondea
Copy link
Contributor

No description provided.

@AlexGhiondea AlexGhiondea added the Client This issue points to a problem in the data-plane of the library. label Nov 8, 2020
@AlexGhiondea AlexGhiondea added this to the MQ-2020 milestone Nov 8, 2020
@lmazuel lmazuel assigned mccoyp and unassigned yunhaoling Nov 9, 2020
@lmazuel
Copy link
Member

lmazuel commented Nov 30, 2020

Duplicate of #15121

@lmazuel lmazuel marked this as a duplicate of #15121 Nov 30, 2020
@lmazuel lmazuel closed this as completed Nov 30, 2020
@mccoyp
Copy link
Member

mccoyp commented Dec 14, 2020

Below are the rendering issues found in the reference docs -- some are rendering/linking related, while some are content-related but need further investigation before fixing in source code.

Bug type Description Source
Docs content General KV overview page mentions that 4.x is recommended under "Libraries for data access", but there should also be a note about this under "Version 1.x.x" link
Rendering Management library overview page is empty on docs, despite there being non-empty (even if sparse) READMEs on GitHub. We'll need to follow up with Scott to see why this is link
Linking Clicking the "Reference" link for azure-keyvault from KV overview page brings up the preview KV overview instead of the legacy overview link
Docs content README that's linked to from the azure-keyvault "GitHub" link in reference docs is in a tag (but not a branch) in the repo. The link to the reference docs from the README is outdated, but I'm not sure how to update it to the legacy docs page since there's no branch with the legacy README content link
Linking Link for Python in the "Reference" TOC node in the KV service overview page directs to the management package reference, when it should probably link to the general KV overview link
Content/rendering begin_create_certificate shows "HttpResponseError" under "Exceptions" twice, and lists all possible parameters as "Required" when some are optional keyword-only arguments. These issues exist for all methods that have required parameters (denoted by :param x x: in their docstring) as well as keyword arguments specified in their docstring (denoted by :keyword x x:). Methods that have only keyword arguments denoted by :keyword x x: don't render with duplicate exceptions in the reference docs, but their parameters are still listed as "Required". Keyword arguments that are denoted by :param x x: in docstrings don't show up as "Required" (see JsonWebKey), but these can't coexist with required parameters link
Content/rendering KeyVaultKey has code block examples in its docstring, such that they render in the package class list and aren't put in an "Examples" section like we do for other classes. Should this be changed? Can multiple examples be put in a single docstring using the Example: literalinclude:: pattern? link

@mccoyp mccoyp reopened this Dec 14, 2020
openapi-sdkautomation bot pushed a commit to AzureSDKAutomation/azure-sdk-for-python that referenced this issue Aug 26, 2021
Mitryakh/network march (Azure#15709)

* Adds base for updating Microsoft.Network from version stable/2021-02-01 to version 2021-03-01

* Updates readme

* Updates API version in new specs and examples

* Add new parameter to enable/disable BGP route translation for NAT VirtualWan VpnGateway (Azure#14462)

* Adding Bastion Host Configuration Features (Azure#14442)

Co-authored-by: Abhishek Shah <[email protected]>

* Add PL ASG (Azure#14620)

* Add PL ASG

* Prettier

* [Private Link] Private Endpoint Ipconfigurations swagger for 2021-03-01 (Azure#14662)

* Ipconfigurations swagger

* Ran prettier check

* fixing conflicting files

* fixing lint

* Fixing linter diff

* Lint diff

* resolving comments

* fixing conflict

* Fioxing

* running prettier

* Fixing linter comment

Co-authored-by: Shane Baden <[email protected]>

* Add missing properties of ServiceEndpointPolicy (Azure#14948)

* Add missing 'type' and 'serviceAlias' for ServiceEndpointPolicy related API response

* Add missing 'contextualServiceEndpointPolicies'

* fix bug

* fix type

* Add missing properties to ServiceEndpointPolicy

* Revert "fix type"

This reverts commit 3a49beb66d9bbb288fa0d3baaeaf5aaf2bbc6ee9.

* Revert "fix bug"

This reverts commit a4fff4ae925b01ed0cfb07b1594fb95e2c6649c7.

* Revert "Add missing 'contextualServiceEndpointPolicies'"

This reverts commit ccf19167abc61b90bce6b5204dc3b2a64fdf4ca4.

* Revert "Add missing 'type' and 'serviceAlias' for ServiceEndpointPolicy related API response"

This reverts commit e532cc1118241a74902e4362c32c25c11a764933.

Co-authored-by: Xu Wang <[email protected]>

* add new service tag details api (Azure#14958)

* add new service tag details api

* prettier check fixes

* fixing lint issue, additional properties issue

* Add Load distribution policy and global configuration to AppGW (Azure#14790)

* add Load distribution policy and global configuration to Application Gateway resource

* prettify

* remove provisioning state

* add public ssh key to network virtual appliance (Azure#14988)

* Changes needed for BgpEndpoint (Azure#14800)

* changes needed for BgpEndpoint

* prettier check

* model validation fix

* fix description

* update again

* Multi QoS support for DSCP configuration (Azure#15120)

* Updating the DSCP jsons to reflect the  multi-qos support

* Adding support to multi-qos

* adding the type object to NrpQos

* fixing the prettier
removing my update to the settings

* fixing the missing type object error. seeing if this also fixes the additional attributes exception

* fixing the prettier exception

* almost forgot this, it was refactor from NrpQos to QosDefinition. NRPQos is already being used in Networking repo

* copying what I did with my other objects

* names didn't match with what I have in NRP's src

* forgot to update the examples with the updates in the specification. updating it

* fixing the merge exceptions

* Add SQL Setting to Firewall Policy (Azure#15110)

* Add SQL Setting to Firewall Policy

* fix lint check except for object type

* resolve linter error

* network: fix newly added targets field to an array and missing sub-resource properties in applicationGateways.json (Azure#15318)

* fix: change target to an array and add subresource properties

* fix target examples

* Support to update tags for BastionHost resource (Azure#15446)

* Initial commit

* Validation fixes

* Update bastionHost.json

Co-authored-by: Abhishek Shah <[email protected]>

* Azure FW - Explicit Proxy feature swagger change (Azure#15017)

* explicit proxy swagger change

* prettier check fix

* lint check

* prettier fix

* revert unnecessary file change

* Add kind to virtual hub (Azure#15562)

* Adding customnetworkinterfacename attribute to Private Endpoint (Azure#15574)

Co-authored-by: Shane Baden <[email protected]>

* Added 3 new properties to InboundNatRule resource (Azure#15611)

* Added the missins properties to fix the change breaking update (Azure#15732)

Co-authored-by: Nilambari <[email protected]>
Co-authored-by: Abhishek Shah <[email protected]>
Co-authored-by: Abhishek Shah <[email protected]>
Co-authored-by: Yang Shi <[email protected]>
Co-authored-by: Shane Baden <[email protected]>
Co-authored-by: Shane Baden <[email protected]>
Co-authored-by: Xu Wang <[email protected]>
Co-authored-by: Xu Wang <[email protected]>
Co-authored-by: guptas14 <[email protected]>
Co-authored-by: Akshay Gupta <[email protected]>
Co-authored-by: litchiyangMSFT <[email protected]>
Co-authored-by: Ritvika Reddy Nagula <[email protected]>
Co-authored-by: David Velasco <[email protected]>
Co-authored-by: Jiejiong Wu <[email protected]>
Co-authored-by: tinawu6 <[email protected]>
Co-authored-by: irrogozh <[email protected]>
@github-actions github-actions bot locked and limited conversation to collaborators Apr 12, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Client This issue points to a problem in the data-plane of the library. KeyVault
Projects
None yet
Development

No branches or pull requests

5 participants