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.

Sign up for GitHub

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

Update conventions to include API parameter and field naming #232

Merged
merged 1 commit into from
Apr 6, 2024
Merged

Update conventions to include API parameter and field naming #232

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions CONVENTIONS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,6 +107,9 @@ For example, [dashboards-notebooks/opensearch_dashboards.json](https://github.co
### APIs

- Use `_` as prefix for APIs, e.g. `_plugins/_anomaly_detection/*`.
- Use snake case when naming API request/response fields and parameters (for example, `use_case`), separating individual words with an underscore.
- Replace hyphens with underscores (for example, for retrieval-augmented generation, use `retrieval_augmented_generation`).
- When creating a new type of a component, take note of how other components of this type are named. For example, search processors are named omitting the word `processor` at the end (the collapse processor is called `collapse`).

### Indices

Expand Down
Loading