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

Consider suggesting a file-naming convention for overlay documents #81

Open
earth2marsh opened this issue Oct 16, 2024 · 0 comments
Open
Milestone

Comments

@earth2marsh
Copy link
Member

I wonder if it might be worth suggesting a convention for naming Overlay documents. It could help improve discoverability and consistency, especially in scenarios where the main OpenAPI document (e.g., openapi.yaml) is present.

Currently, an Overlay that augments an OpenAPI document (such as a translation or service-level agreement) might be named in ways that don’t immediately suggest its connection to the OpenAPI document. For example, you might see fr.yaml or it.yaml for translations, or sla.yaml for a service-level agreement. Looking at the files in a directory, you might spot an openapi.yaml document (a common name for an OpenAPI file) and not realize there are related Overlay documents!

One pattern to consider is prepending any overlay document with "overlay," such as:

  • overlay.fr.yaml
  • overlay.it.yaml
  • overlay.sla.yaml

This approach would group overlays visually when listed in alphabetical order. Since it begins with ov, it would likely appear near openapi.yaml, making the connection between the main document and its overlays more obvious.

Recommending a convention like this would make it clearer that a document is an OpenAPI Overlay when viewing a list of files.

@ralfhandl ralfhandl added this to the Release 2.0 milestone Nov 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants