Skip to content

Commit 72303ef

Browse files
committed
Typo
1 parent fc3090c commit 72303ef

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

docs/specification-structure.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Specification structure
22

33
The [`/specification`](../specification) folders follows a set of rules to
4-
keep the defintion easy to access and contribute, while maintaing
4+
keep the definition easy to access and contribute, while maintaining
55
the generated schema consistent and useful for language generators.
66

77
## Rules
@@ -14,7 +14,7 @@ root of the [`/specification`](../specification) folder as well
1414
as inside the namespaces when necessary.
1515

1616
You should decide if a type should go inside the top-level `_types`
17-
folder or inside a namespace (eg: `indices/_types`) on a case by case basis.
17+
folder or inside a namespace (e.g.: `indices/_types`) on a case by case basis.
1818
A good rule of thumb is that if a type is widely used in the specification,
1919
it should go in the top level `_types`, while if it's used only within
2020
a namespace or a few times in other namespaces, it could go inside the
@@ -29,8 +29,8 @@ end with `Request` or `Response`.
2929

3030
### Request and Response definitions
3131

32-
Request and Reponse definitions should be placed by structly following
33-
the rest-api-spec structure.
32+
Request and Response definitions should be placed by strictly following
33+
the `rest-api-spec` structure.
3434
For example, the request and response definition for `indices.put_mapping`
3535
should go in [`/specification/indices/put_mapping`](../specification/indices/put_mapping).
3636
There are no requirements on the file name, but the type should be
@@ -45,4 +45,4 @@ For example: [`/specification/_global/search`](../specification/_global/search).
4545
### Specification helpers
4646

4747
The specification has a set of custom types used to define complex structures
48-
or behaviors. Those types must be placed in [`/specification/_spec_utils`](../specification/_spec_utils).
48+
or behaviors. Those types must be placed in [`/specification/_spec_utils`](../specification/_spec_utils).

0 commit comments

Comments
 (0)