Skip to content

Commit 4323817

Browse files
authored
Add note to CONTRIBUTING.md about REST URLs (#52999)
1 parent 3571f1d commit 4323817

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

CONTRIBUTING.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -166,6 +166,22 @@ Some tests related to locale testing also require the flag
166166
IntelliJ or Eclipse like describe above to use
167167
`-Djava.locale.providers=SPI,COMPAT`.
168168

169+
### REST Endpoint Conventions
170+
171+
Elasticsearch typically uses singular nouns rather than plurals in URLs.
172+
For example:
173+
174+
/_ingest/pipline
175+
/_ingest/pipline/{id}
176+
177+
but not:
178+
179+
/_ingest/piplines
180+
/_ingest/piplines/{id}
181+
182+
You may find counterexamples, but new endpoints should use the singular
183+
form.
184+
169185
### Java Language Formatting Guidelines
170186

171187
Java files in the Elasticsearch codebase are formatted with the Eclipse JDT

0 commit comments

Comments
 (0)