Azure / Azure/azure-rest-api-specs
Document "<unchanged>" and "<redacted>" values for DataSourceCredentials.connectionString
- Dominant language
- TypeSpec
- Stars
- 3.1k
- Forks
- 5.9k
- Avg merge
- 3d 2h
- Merged PRs (30d)
- 424
Description
The `DataSource` model requires `DataSourceCredentials`, but the latter model is not returned from data source APIs. Since it's required, we cannot send back null (at least, the .NET generator does not support this since it's not `"x-nullable": true` and is, again, authored as required) and if we send an empty value (`connectionString` is not required), it would either err on the server or, worse, wipe out the existing credentials stored for the data source.
Instead, I'm told, the `connectionString` should be set to either "\" or "\" to avoid wiping out the credentials. These should be documented in swagger so that callers know what to pass to update a data source.
Contributor guide
Research direction
Locate the DataSource and DataSourceCredentials definitions in the repository's Azure REST API specifications and read how connectionString is currently described. Document the "" and "" values in the relevant OpenAPI definition, then verify that the generated specification clearly tells callers when to use each value.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- openapi
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100