Azure / Azure/azure-rest-api-specs
PostgreSQL Flexible Server Administrators API has wrong description fields
- Dominant language
- TypeSpec
- Stars
- 3.1k
- Forks
- 5.9k
- Avg merge
- 2d 22h
- Merged PRs (30d)
- 444
Description
The description field in the create and get operations of the PostgreSQL Flexible Server Administrators API talks about servers but actually the operation is about the administrators.
Example for get operation:
https://github.com/Azure/azure-rest-api-specs/blob/e812b54127fad6c9bc2407b33980b0fe385b7717/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2022-12-01/Administrators.json#L173
Contributor guide
Research direction
Open specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2022-12-01/Administrators.json at the linked get operation around line 173, then inspect the corresponding create operation. Update both descriptions so they refer to administrators rather than servers, and verify that only the intended description fields changed.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- openapi
- Domain
- api
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 76/100