Skip to content

Commit 8f8b517

Browse files
committed
added update instructions
Signed-off-by: fenn-cs <[email protected]>
1 parent ce1349b commit 8f8b517

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ OpenAPI Documentation for [phpList/rest-api](github.com/phpList/rest-api) ove Sw
33

44
# Updating
55

6-
We use`swagger-ui-dist` which is the compiled version of swagger UI for server side projects. It's simply a copy of the `dist` directory from the[Swagger UI Repo](https://github.com/swagger-api/swagger-ui)) stored.
6+
We use`swagger-ui-dist` which is the compiled version of swagger UI for server side projects. It's simply a copy of the `dist` directory from the [Swagger UI Repo](https://github.com/swagger-api/swagger-ui)) stored.
77

88
So if there are updates in the UI we would like to have, the fastest way to update our copy of swagger UI would be to clone the entire swagger UI [repository](https://github.com/swagger-api/swagger-ui) and copy the contents of `dist` to `public/docs` and make the required changes in `index.html`. That includes making sure the assets (javascript and css) are pointing to the right place (`/restapi-docs/`) and that `SwaggerUIBundle` is referencing `/restapi-docs/restapi.json` correctly as shown bellow;
99

0 commit comments

Comments
 (0)