The main point is to fix a non ASCII space character that wrecks the
markdown handling.
Signed-off-by: Akim Demaille <akim.demaille@docker.com>
... | ... |
@@ -10,7 +10,7 @@ It consists of various components in this repository: |
10 | 10 |
- `client/` The Go client used by the command-line client. It can also be used by third-party Go programs. |
11 | 11 |
- `daemon/` The daemon, which serves the API. |
12 | 12 |
|
13 |
-##Â Swagger definition |
|
13 |
+## Swagger definition |
|
14 | 14 |
|
15 | 15 |
The API is defined by the [Swagger](http://swagger.io/specification/) definition in `api/swagger.yaml`. This definition can be used to: |
16 | 16 |
|
... | ... |
@@ -20,7 +20,7 @@ The API is defined by the [Swagger](http://swagger.io/specification/) definition |
20 | 20 |
|
21 | 21 |
## Updating the API documentation |
22 | 22 |
|
23 |
-The API documentation is generated entirely from `api/swagger.yaml`. If you make updates to the API, you'll need to edit this file to represent the change in the documentation. |
|
23 |
+The API documentation is generated entirely from `api/swagger.yaml`. If you make updates to the API, edit this file to represent the change in the documentation. |
|
24 | 24 |
|
25 | 25 |
The file is split into two main sections: |
26 | 26 |
|
... | ... |
@@ -29,9 +29,9 @@ The file is split into two main sections: |
29 | 29 |
|
30 | 30 |
To make an edit, first look for the endpoint you want to edit under `paths`, then make the required edits. Endpoints may reference reusable objects with `$ref`, which can be found in the `definitions` section. |
31 | 31 |
|
32 |
-There is hopefully enough example material in the file for you to copy a similar pattern from elsewhere in the file (e.g. adding new fields or endpoints), but for the full reference, see the [Swagger specification](https://github.com/docker/docker/issues/27919) |
|
32 |
+There is hopefully enough example material in the file for you to copy a similar pattern from elsewhere in the file (e.g. adding new fields or endpoints), but for the full reference, see the [Swagger specification](https://github.com/docker/docker/issues/27919). |
|
33 | 33 |
|
34 |
-`swagger.yaml` is validated by `hack/validate/swagger` to ensure it is a valid Swagger definition. This is useful for when you are making edits to ensure you are doing the right thing. |
|
34 |
+`swagger.yaml` is validated by `hack/validate/swagger` to ensure it is a valid Swagger definition. This is useful when making edits to ensure you are doing the right thing. |
|
35 | 35 |
|
36 | 36 |
## Viewing the API documentation |
37 | 37 |
|