This is an automated email from the ASF dual-hosted git repository.
mitchell852 pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-trafficcontrol.git
commit bff608578d14b07aa70da43545cfba488c46ef5b
Author: Dewayne Richardson <dewr...@apache.org>
AuthorDate: Tue Apr 17 12:13:55 2018 -0600
updated the README
---
traffic_ops/traffic_ops_golang/swaggerdocs/v13/README.md | 10 +++-------
1 file changed, 3 insertions(+), 7 deletions(-)
diff --git a/traffic_ops/traffic_ops_golang/swaggerdocs/v13/README.md
b/traffic_ops/traffic_ops_golang/swaggerdocs/v13/README.md
index f92bbbd..392e4e2 100644
--- a/traffic_ops/traffic_ops_golang/swaggerdocs/v13/README.md
+++ b/traffic_ops/traffic_ops_golang/swaggerdocs/v13/README.md
@@ -29,9 +29,9 @@ This directory contains the Go structs that glue together the
Swagger 2.0 metada
* Install Docker Compose for your platform:
[https://docs.docker.com/compose/install](https://docs.docker.com/compose/install)
-### Running
+### Running the web services
-The docker-compose.yml will start 2 services a custom http service for hosting
the `swaggerspec/swagger.json` and the Swagger UI.
+The `docker-compose.yml` will start 2 services a custom http service for
hosting the `swaggerspec/swagger.json` and the Swagger UI.
To start the Swagger UI services just run:
@@ -43,8 +43,4 @@ Once started navigate your browser to
[http://localhost:8080](http://localhost:8
The **gen_swaggerspec.sh** script will scan all the Go files in the
swaggerdocs directory and extract out all of the swagger meta tags that are
embedded as comments. The output of the **gen_swaggerspec.sh** script will be
the **swaggerspec/swagger.json** spec file.
-While the Docker services are running, just re-run **gen_swaggerspec.sh** and
hit refresh on the page to see the Swagger doc updates in real time.
-
-### Verifying your Documentation
-
-Once the **swagger.json** spec file has been generated it needs to to be
served over http so that you can validate it using the Swagger Editor.
+While the Docker services are running, just re-run **gen_swaggerspec.sh** and
hit refresh on the page to see the Swagger doc updates in real time.
\ No newline at end of file
--
To stop receiving notification emails like this one, please contact
mitchell...@apache.org.
