Adds swagger ui instructions (quay#1267)

Co-authored-by: Steven Smith <[email protected]>

Author: stevsmit

api/master.adoc

@@ -47,6 +47,7 @@ include::modules/creating-v2-oauth-access-token.adoc[leveloffset=+2]
 include::modules/enabling-using-the-api.adoc[leveloffset=+1]
 include::modules/configuring-api-calls.adoc[leveloffset=+2]
 include::modules/using-the-api.adoc[leveloffset=+2]
+include::modules/accessing-swagger-ui.adoc[leveloffset=+2]
 include::modules/automating-quay-using-the-api.adoc[leveloffset=+2]
 
 

modules/accessing-swagger-ui.adoc

@@ -0,0 +1,38 @@
+:_content-type: REFERENCE
+[id="accessing-swagger-ui"]
+= Accessing {productname} Swagger UI
+
+{productname} administrators and users can interacting with the API by using the Swagger UI-an interactive web interface that compiles executable commands. The Swagger UI can be launched as a container that points to your {productname} instance's API discovery endpoint (`/api/v1/discovery`). After deploying the container, you can access the Swagger UI, which loads the OpenAPI specification for {productname} from the specified URL. {productname} administrators and users can explore the available endpoints and their structure.
+
+Use the following procedure to access the {productname} Swagger UI.
+
+.Procedure
+
+. Enter the following command to deploy the Swagger UI container, pointing the URL to your {productname}'s API discovery endpoint. For example:
++
+[source,terminal]
+----
+$ podman run -p 8080:8080 -e SWAGGER_JSON_URL=<quay-server.example.com> docker.swagger.io/swaggerapi/swagger-ui
+----
++
+.Example output
++
+[source,terminal]
+----
+---
+/docker-entrypoint.sh: Launching /docker-entrypoint.d/20-envsubst-on-templates.sh
+20-envsubst-on-templates.sh: Running envsubst on /etc/nginx/templates/default.conf.template to /etc/nginx/conf.d/default.conf
+/docker-entrypoint.sh: Launching /docker-entrypoint.d/30-tune-worker-processes.sh
+/docker-entrypoint.sh: Launching /docker-entrypoint.d/40-swagger-ui.sh
+/docker-entrypoint.sh: Configuration complete; ready for start up
+---
+----
+
+. Navigate to the `localhost` URL. In this example, it is *http://localhost:8080/*. 
+
+. Use the Swagger UI to test various API endpoints. For example, to create a new token for a user, you can click the *POST /api/v1/user/apptoken* endpoint -> *Try it out* -> *Execute* to generate an example `curl` command.
++
+[NOTE]
+====
+Currently, server responses cannot be generated. This is because the Swagger UI is not set up to accept bearer tokens. As a result, the following error is returned for each command: `{"error": "CSRF token was invalid or missing."}`. As a workaround, you can copy this command into your terminal and manually add your bearer token, for example, `-H 'Authorization: Bearer <bearer_token>'`
+====

modules/using-the-api.adoc

@@ -6,7 +6,7 @@ After you have created an application and generated an OAuth 2 access token with
 
 [source,terminal]
 ----
-$ curl -X GET -H "Authorization: Bearer <your_access_token>" <1>
+$ curl -X GET -H "Authorization: Bearer <your_access_token>" \ <1>
     https://<quay-server.example.com>/api/v1/<example>/<endpoint>/ <2>
 ----
 <1> The OAuth 2 access token that was generated through the {productname} UI.
@@ -21,7 +21,7 @@ Create a new app specific token for user. <2>
 
 *POST /api/v1/user/apptoken* <3>
 
-**Authorizations: **oauth2_implicit (**user:admin**) <4>
+**Authorizations: **oauth2_implicit (**user:admin**) <4>
 
  Request body schema (application/json)