You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The fact that we have two periods in the file name of the API spec (OpenSearch.latest.yaml) is, at the very least, unusual.
What is the developer experience going to be?
Rename the file. Some options:
OpenSearch.yml
opensearch.yml
OpenSearch-API.yml
opensearch-api.yml
something else?
Are there any breaking changes to the API
Yes, now is the right time to potentially rename this file because we're switching to OpenAPI (#208) and changing the build and release process in #211.
What is the user experience going to be?
A file name that makes more sense.
Are there breaking changes to the User Experience?
The file name will change.
Any remaining open questions?
Is there some kind of naming convention in other products?
The text was updated successfully, but these errors were encountered:
There's some chance that we will be including other/separate OpenAPI specs in this repo (e.g. for plugins), so I think we should preserve "OpenSearch" in the name. The core repo is also called OpenSearch, but the spec includes plugins. Maybe we should match the lowercase of the distribution https://artifacts.opensearch.org/releases/bundle/opensearch/2.12.0/opensearch-2.12.0-linux-x64.tar.gz? When we release a versioned spec it should probably be called opensearch-openapi-2.12.0.yaml.
All this said, I think my current preference is opensearch-openapi.yaml.
What/Why
What are you proposing?
Rename OpenSearch.latest.yaml.
What problems are you trying to solve?
The fact that we have two periods in the file name of the API spec (
OpenSearch.latest.yaml
) is, at the very least, unusual.What is the developer experience going to be?
Rename the file. Some options:
Are there any breaking changes to the API
Yes, now is the right time to potentially rename this file because we're switching to OpenAPI (#208) and changing the build and release process in #211.
What is the user experience going to be?
A file name that makes more sense.
Are there breaking changes to the User Experience?
The file name will change.
Any remaining open questions?
Is there some kind of naming convention in other products?
The text was updated successfully, but these errors were encountered: