search

opensearch-project / opensearch-py

Python Client for OpenSearch
https://opensearch.org/docs/latest/clients/python/
Apache License 2.0
338 stars 170 forks source link

[draft] Use a git submodule to include the OpenSearch.openapi.json file #627

Closed jayaddison closed 5 months ago

jayaddison commented 9 months ago

Description

Instead of using an HTTP(S) request to retrieve the latest main OpenSearch.openapi.json spec from opensearch-api-specification.git, reference it as a git submodule and read the contents from file.

Issues Resolved

Resolves #626.

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license. For more information on following Developer Certificate of Origin and signing off your commits, please check here.

dblock commented 9 months ago

I like it! Let's document this in .md file(s), CHANGELOG, etc.

saimedhi commented 6 months ago

Hello @jayaddison, could you please address the failing tests and implement the requested changes? Let's work towards getting this PR merged.

jayaddison commented 6 months ago

Thanks for the ping @saimedhi. I'd paused here because I'm not certain that my git submodule proposal (#626) is gaining traction. Even so, it seems reasonable to keep up-to-date, and I see that there are changes going on related to API-change-detection.

Should I merge main and resolve conflicts too?

dblock commented 6 months ago

@Xtansia had some opinions about this direction, what do you recommend we do with this PR?

Xtansia commented 6 months ago

@Xtansia had some opinions about this direction, what do you recommend we do with this PR?

@dblock @jayaddison Since we don't yet have a versioning & release process in place for the specs, I'm not completely against this approach for now as it's easy to change in the future. It's important to keep in mind the current proposal to swap the spec repo away from Smithy and at the same time a decent chance the final one-file "complete" spec will not be checked into Git and instead be released in some other manner.

dblock commented 6 months ago

I think @Xtansia is saying that we won't have a submodule reference if/when we switch to OpenAPI. Let's see what happens with https://github.com/opensearch-project/opensearch-api-specification/issues/189 before we decide on this?

saimedhi commented 5 months ago

I think @Xtansia is saying that we won't have a submodule reference if/when we switch to OpenAPI. Let's see what happens with opensearch-project/opensearch-api-specification#189 before we decide on this?

@dblock, @Xtansia: Now that opensearch-project/opensearch-api-specification#189 has been resolved, could you please share your thoughts on this PR?

dblock commented 5 months ago

The spec is no longer committed to git but published as a release, so let's close it.