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 tsp #31123

Draft
wants to merge 55 commits into
base: main
Choose a base branch
from
Draft

Search tsp #31123

wants to merge 55 commits into from

Conversation

xiangyan99
Copy link
Member

Choose a PR Template

Switch to "Preview" on this description then select one of the choices below.

Click here to open a PR for a Data Plane API.

Click here to open a PR for a Control Plane (ARM) API.

Copy link

openapi-pipeline-app bot commented Oct 21, 2024

Next Steps to Merge

Next steps that must be taken to merge this PR:
  • ❌ This is the public specs repo main branch which is not intended for iterative development.
    You must acknowledge that you understand that after this PR is merged, you won't be able to stop your changes from being published to Azure customers.
    If this is what you intend, add PublishToCustomers label to your PR.
    Otherwise, retarget this PR onto a feature branch, i.e. with prefix release- (see aka.ms/azsdk/api-versions#release--branches).
  • ❌ The required check named Swagger SpellCheck has failed. Refer to the check in the PR's 'Checks' tab for details on how to fix it and consult the aka.ms/ci-fix guide

Copy link
Member

@catalinaperalta catalinaperalta left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Got through models-index...will continue again tomorrow

specification/search/Azure.Search/client.tsp Show resolved Hide resolved
specification/search/Azure.Search/main.tsp Outdated Show resolved Hide resolved
specification/search/Azure.Search/main.tsp Outdated Show resolved Hide resolved
specification/search/Azure.Search/main.tsp Outdated Show resolved Hide resolved
specification/search/Azure.Search/main.tsp Show resolved Hide resolved
specification/search/Azure.Search/models-index.tsp Outdated Show resolved Hide resolved
specification/search/Azure.Search/models-index.tsp Outdated Show resolved Hide resolved
xiangyan99 and others added 3 commits October 24, 2024 08:09
Co-authored-by: catalinaperalta <catalinaperaltah@hotmail.com>
Co-authored-by: catalinaperalta <catalinaperaltah@hotmail.com>
Co-authored-by: catalinaperalta <catalinaperaltah@hotmail.com>
@catalinaperalta
Copy link
Member

@xiangyan99 the typespec validation and typespec apiview steps need to be passing as well

Copy link
Member

@catalinaperalta catalinaperalta left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for cleaning up the spec, it's looking good. We do need to get the CI checks resolved. This page could help figure out any issues: aka.ms/ci-fix

/** The discriminator for derived types. */
#suppress "@azure-tools/typespec-azure-core/no-string-discriminator" "Existing"
@encodedName("application/json", "@odata.type")
odataType: string;
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this have a visibility read on it then?

Comment on lines 5649 to 5650
model SearchIndexerKnowledgeStoreObjectProjectionSelector
extends SearchIndexerKnowledgeStoreBlobProjectionSelector {}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm wondering if this will cause issues when generating in certain languages. If the SearchIndexerKnowledgeStoreBlobProjectionSelector model is the same as the base model then what's the benefit of having is?

Could this have just been a mistake in the handwritten swagger?

Comment on lines 5744 to 5746
* The format of the synonym map. Only the 'solr' format is currently supported.
*/
format: "solr";
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since the description says "currently" do we think there will be other values in the future? Should this be an enum instead?

* Response from a List Indexes request. If successful, it includes the full
* definitions of all indexes.
*/
@pagedResult
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There's no nextLink property for this model?

specification/search/Azure.Search/models-shared.tsp Outdated Show resolved Hide resolved
* The list of field names to use for hit highlights. Only searchable fields can
* be used for hit highlighting.
*/
@query(#{
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why is there a # here?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It was hinted by the compiler.

Deprecated: Using a model as a value is deprecated. Use an object value instead(with #{}).

specification/search/Azure.Search/routes-index.tsp Outdated Show resolved Hide resolved
specification/search/Azure.Search/routes-service.tsp Outdated Show resolved Hide resolved
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks like these openapi specs should be checked in under the existing Azure.Search directory?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

When I ran tsp compile, these files were auto generated. Could you tell me where is the right place to put them?

xiangyan99 and others added 6 commits November 5, 2024 09:19
Co-authored-by: catalinaperalta <catalinaperaltah@hotmail.com>
Co-authored-by: catalinaperalta <catalinaperaltah@hotmail.com>
@azure-sdk
Copy link
Collaborator

API change check

APIView has identified API level changes in this PR and created following API reviews.

stable

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

Successfully merging this pull request may close these issues.

5 participants