Skip to content

Search: Proposed model and property renames #10860

@heaths

Description

@heaths

EDIT (bev): noting plural sub-client names should also be singularized with this

This is a list of proposed changes for models and properties. Some of these changes may have already been done in one or more languages, but I wanted to start an issue to track all of them and, when agreed, will replicate across the different language repos.

Not yet Done:

A few of these might not need any work, e.g. SearchIndexerError was already changed from the swagger re-gen, we just don't import it anywhere.

Model Property Proposal Notes
DataSource Credentials ConnectionString (string) See notes below for DataSourceCredentials
DataSourceCredentials remove Just uplift ConnectionString to SearchDataSource

Done

Model Property Proposal Notes
Analyzer LexicalAnalyzer
AnalyzerName LexicalAnalyzerName
AzureActiveDirectoryApplicationCredentials remove Just uplift ApplicationId and ApplicationSecret to SearchIndexEncryptionKey
DataContainer SearchIndexerDataContainer
DataSource SearchIndexerDataSource
DataSourceType SearchIndexerDataSourceType
DataType SearchFieldDataType
Field SearchField
Index SearchIndex
Indexer SearchIndexer
IndexerExecutionInfo SearchIndexerStatus Corresponds to SearchServiceClient.GetIndexerStatus
IndexerLimits SearchIndexerLimits
ItemError SearchIndexerError
ItemWarning SearchIndexerWarning
Skill SearchIndexerSkill
Skillset SearchIndexerSkillset
StandardAnalyzer LuceneStandardAnalyzer
StandardTokenizer LuceneStandardTokenizer
StandardTokenizerV2 LuceneStandardTokenizerV2
Tokenizer LexicalTokenizer
TokenizerName LexicalTokenizerName
TokenInfo AnalyzedTokenInfo
EncryptionKey SearchResourceEncryptionKey

As far as I know, the property renames were changed in the swagger regen without any extra work:

Model Property Proposal Notes
EncryptionKey KeyVaultUri VaultUri Corresponds with Key Vault naming.
EncryptionKey KeyVaultName KeyName Corresponds with Key Vault naming.
EncryptionKey KeyVaultVersion KeyVersion Corresponds with Key Vault naming.
LengthTokenFilter Max LengthTokenFilter.MaxLength
LengthTokenFilter Min LengthTokenFilter.MinLength
Method Model Return
SearchServiceClient.ListDataSources ListDataSourcesResult DataSource[]
SearchServiceClient.ListIndexers ListIndexersResult SearchIndexer[]
SearchServiceClient.ListIndexes ListIndexesResult SearchIndex[]
SearchServiceClient.ListSkillsets ListSkillsetsResult SearchSkillset[]
SearchServiceClient.ListSynonymMaps ListSynonymMapsResult SynonymMap[]

Metadata

Metadata

Labels

ClientThis issue points to a problem in the data-plane of the library.Searchblocking-releaseBlocks release

Type

No type

Projects

No projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions