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

Search: Proposed model and property renames #10860

Closed
heaths opened this issue Apr 15, 2020 · 5 comments · Fixed by #11342
Closed

Search: Proposed model and property renames #10860

heaths opened this issue Apr 15, 2020 · 5 comments · Fixed by #11342
Assignees
Labels
blocking-release Blocks release Client This issue points to a problem in the data-plane of the library. Search
Milestone

Comments

@heaths
Copy link
Member

heaths commented Apr 15, 2020

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[]
@heaths heaths added Client This issue points to a problem in the data-plane of the library. Search labels Apr 15, 2020
@heaths heaths added this to the [2020] May milestone Apr 15, 2020
@heaths
Copy link
Member Author

heaths commented May 1, 2020

Added StandardTokenizerV2 -> LuceneStandardTokenizerV2

@bryevdv
Copy link
Contributor

bryevdv commented May 6, 2020

@heaths is there a reason this was in a milestone and not an Epic like all the other issues? (That's why I did not see it until now)

@heaths
Copy link
Member Author

heaths commented May 6, 2020

It should've been. I used @AlexGhiondea's to to create issues in each repo where I just switch the epic and repo and hit the submit button. Alex, does the app err if it can't associate the epic i.e. not-standard GitHub fields?

@lmazuel lmazuel modified the milestones: [2020] May, [2020] June May 8, 2020
@heaths heaths linked a pull request May 11, 2020 that will close this issue
@bryevdv bryevdv reopened this May 20, 2020
@bryevdv
Copy link
Contributor

bryevdv commented May 20, 2020

@heaths @xiangyan99 I have edited the table in the OP

@xiangyan99
Copy link
Member

Fixed

@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
blocking-release Blocks release Client This issue points to a problem in the data-plane of the library. Search
Projects
None yet
Development

Successfully merging a pull request may close this issue.

6 participants