Skip to content

Commit

Permalink
Update CONVENTIONS.md (#232)
Browse files Browse the repository at this point in the history
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
  • Loading branch information
kolchfa-aws authored Apr 6, 2024
1 parent ea2ff78 commit eaf73b8
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions CONVENTIONS.md
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,9 @@ For example, [dashboards-observability/opensearch_dashboards.json](https://githu
### 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

0 comments on commit eaf73b8

Please sign in to comment.