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

Improve Tables doc comments based on what is available in the OpenAPI spec #5464

Open
ahsonkhan opened this issue Mar 21, 2024 · 0 comments
Open
Assignees
Labels

Comments

@ahsonkhan
Copy link
Member

ahsonkhan commented Mar 21, 2024

Here's the rest API spec for it, which has some good descriptions for doc comments, that we can use:
https://github.com/Azure/azure-rest-api-specs/blob/main/specification/cosmos-db/data-plane/Microsoft.Tables/preview/2019-02-02/table.json

For example, we have this description for the response of GetEntity:
https://github.com/Azure/azure-rest-api-specs/blob/1aebb2dbe4fe12a555f8bf67ae89435c036ef387/specification/cosmos-db/data-plane/Microsoft.Tables/preview/2019-02-02/table.json#L411-L484

https://github.com/Azure/azure-sdk-for-go/blob/b7816620792994eafbc880bed20ef334e4ac73c3/sdk/data/aztables/client.go#L210-L213
https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/data/aztables#GetEntityResponse

The C++ Tables SDK has the following doc comments for it:

/**
* @brief Get one table entity.
*
* @param partitionKey The partition key of the entity.
* @param rowKey The row key of the entity.
* @param context for canceling long running operations.
* @return Table entity.
*/
Response<Models::TableEntity> GetEntity(
const std::string& partitionKey,
const std::string& rowKey,
Core::Context const& context = {});

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants