How to: Update target document for `https: gluu.org swagger‐ui`

The https://www.gluu.org/swagger-ui URL should point to the oxAuth API specification from latest release. As releases move forward, we have to manually update the swagger-ui deployment on gluu.org to point to the yaml specification file from the latest release branch.

At the time of writing the latest release is 4.5.2, so the https://www.gluu.org/swagger-ui is pointing to https://raw.githubusercontent.com/GluuFederation/oxAuth/version_4.5.2/docs/oxAuthSwagger.yaml

This wiki lists steps to be taken in order to update this setting on gluu.org server using ssh access.

• Get VPN access and SSH access to gluu.org by collaborating with system admin. Once you have the access, https://www.gluu.org can be connected using ssh -p 22222 -i ~/.ssh/id_rsa [email protected] while on VPN.

• Swagger UI is hosted at /opt/wordpress/swagger-ui/

• Replace old URL with new URL in /opt/wordpress/swagger-ui/index.html file like below. If you are running newer version of swagger UI, you have to edit vim /var/www/html/swagger-initializer.js to add config variables.:

   <script src="./swagger-ui-bundle.js"> </script>
   <script src="./swagger-ui-standalone-preset.js"> </script>
   <script>
   window.onload = function() {
  
     // Build a system
     const ui = SwaggerUIBundle({
       url: "https://raw.githubusercontent.com/GluuFederation/oxd/version_4.0.0/oxd-server/src/main/resources/swagger.yaml#/developers/setup-client",
       dom_id: '#swagger-ui',
       deepLinking: true,
       defaultModelRendering: "model",    
       presets: [
         SwaggerUIBundle.presets.apis,
         SwaggerUIStandalonePreset
  

• After adding config variables, just save the file and refresh the webpage on browser. Effect should be visible.