11# Specification structure
22
33The [ ` /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
55the generated schema consistent and useful for language generators.
66
77## Rules
@@ -14,7 +14,7 @@ root of the [`/specification`](../specification) folder as well
1414as inside the namespaces when necessary.
1515
1616You 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.
1818A good rule of thumb is that if a type is widely used in the specification,
1919it should go in the top level ` _types ` , while if it's used only within
2020a 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.
3434For example, the request and response definition for ` indices.put_mapping `
3535should go in [ ` /specification/indices/put_mapping ` ] ( ../specification/indices/put_mapping ) .
3636There 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
4747The 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