feat(api): Add logging endpoints and reverse proxy configuration (#307)

* feat(api): Add logging endpoints and reverse proxy configuration

- Introduced new endpoints for retrieving system logs and streaming logs via WebSocket.
- Added endpoint to fetch orchestrator host system logs.
- Implemented endpoint for retrieving orchestrator host reverse proxy configuration.
- Updated error response structure across various endpoints to use "error" instead of "message".
- Enhanced API documentation to reflect the new endpoints and changes in response formats.

feat(catalog): Implement compression options for manifest files

- Added support for compressing manifest files during the generation process.
- Introduced new fields in the PushCatalogManifestRequest model to handle compression options.
- Updated the manifest generation logic to calculate original and packed sizes, and log compression details.

feat(pdfile): Implement new command processors for VM import functionality

- Added command processors for handling new PDFile commands: COMPRESS_PACK, FORCE, IS_COMPRESSED, VM_REMOTE_PATH, VM_SIZE, and VM_TYPE.
- Implemented the runImportVM function to handle the import of VMs with the new parameters.
- Enhanced validation logic to ensure proper handling of new command arguments.

refactor(api): Improve API documentation extraction logic

- Refactored the logic for extracting API documentation from Go files to improve clarity and maintainability.
- Added module information retrieval to enhance the handling of import paths in the documentation process.

* Add CompressPackLevelCommandProcessor and helper functions for float rounding

- Implemented CompressPackLevelCommandProcessor to handle the COMPRESS_PACK_LEVEL command.
- Added error handling for missing and invalid arguments.
- Introduced a helper function to round float values with specified precision.

Author: cjlapao

.gitignore

@@ -25,3 +25,4 @@ _site/
 *.log.*
 *.log
 commit.msg
+.cache/

docs/_data/docs_devops_menu.yml

@@ -22,9 +22,8 @@
       link: /docs/devops/restapi/overview/
     - name: Authentication
       link: /docs/devops/restapi/authentication/
-    - name: Endpoints
-      hidden: true
-      path: /docs/devops/restapi/endpoints/
+    - name: Api Reference
+      link: /docs/devops/restapi/reference/
 - label: Catalog
   items:
     - name: Overview

docs/_data/navigation.yml

@@ -18,6 +18,8 @@
       hidden: true
       description: Learn how to use the Github Actions with Parallels Desktop DevOps Service to automate your CI/CD pipelines.
       link: /docs//github-actions/
+- name: Api Reference
+  link: /docs/devops/restapi/reference/
 - name: Features
   link: /features/
   hidden: true

docs/_layouts/api.html

@@ -8,7 +8,7 @@
   <div class="category-menu">
     <div class="api-menu-container">
       <div class="api-dropdown-root-item{% if page_name == 'rest-api' %} active{% endif %}">
-        <a class="api-menu-item" href="{{ site.baseurl }}/rest-api">All </a>
+        <a class="api-menu-item" href="{{ site.baseurl }}/docs/devops/restapi/reference/">All </a>
       </div>
       {% for category in page.categories %}
       {% if category.endpoints.size > 0 %}
@@ -19,7 +19,7 @@
               <path d="M18 7L10 15L2 7" stroke-width="2" stroke-miterlimit="10"></path>
             </svg>
           </a>
-          <a class="api-menu-item{% if page_name == category.path %} active{% endif %}" href="{{ site.baseurl }}/rest-api/{{ category.path }}">
+          <a class="api-menu-item{% if page_name == category.path %} active{% endif %}" href="{{ site.baseurl }}/docs/devops/restapi/reference/{{ category.path }}">
             <div class="menu-item-text">
               {{ category.name }}
             </div>
@@ -28,17 +28,18 @@
         <div class="api-dropdown-menu{% if page_name == category.path %} expanded{% endif %}" target="dropdown-{{ category.path }}">
           <ul>
             {% for endpoint in category.endpoints %}
+            {% assign anchor_id = page.api_prefix | append: endpoint.path | append: '_' | append: endpoint.method | replace: '/', '_' | replace: '.', '_' | replace: ':', '_' %}
             <li class="api-dropdown-menu-item">
               <span class="endpoint {{ endpoint.method | upcase }}"></span>
-              <a href=" {{ site.baseurl }}/rest-api/{{ category.path }}?#{{ endpoint.path }}">{{ endpoint.path }}</a>
+              <a href="{{ site.baseurl }}/docs/devops/restapi/reference/{{ category.path }}#{{ anchor_id }}">{{ endpoint.path }}</a>
             </li>
             {% endfor %}
           </ul>
         </div>
       </div>
       {% else %}
       <div class="api-dropdown-root-item{% if page_name == category.path %} active{% endif %}">
-        <a class="api-menu-item" href="{{ site.baseurl }}/rest-api/{{ category.path }}">
+        <a class="api-menu-item" href="{{ site.baseurl }}/docs/devops/restapi/reference/{{ category.path }}">
           {{ category.name }}
         </a>
       </div>
@@ -60,8 +61,8 @@
     {% assign endpoints = page.endpoints %}
     {% for endpoint in endpoints %}
     {% assign path = page.api_prefix | append: endpoint.path %}
-    {% assign id = site.api_prefix | append: endpoint.path | append: '_' | append: endpoint.method | replace: '/', '_' | replace: '.', '_' | replace: ':', '_' %}
-    <section class="api-main-content">
+    {% assign id = page.api_prefix | append: endpoint.path | append: '_' | append: endpoint.method | replace: '/', '_' | replace: '.', '_' | replace: ':', '_' %}
+    <section class="api-main-content" id="{{ id }}" style="scroll-margin-top: 120px;">
       <section class="api-main-body">
         {% if endpoint.title %}
         <h6 class="endpoint-title">
@@ -70,7 +71,7 @@ <h6 class="endpoint-title">
         {% endif %}
         <h4 class="api-endpoint-header">
           <div class="endpoint-header">
-            <a class="endpoint-link" id="{{ id }}">
+            <a class="endpoint-link">
               {{ path }}
               {% if endpoint.method %}
               <span class="endpoint {{ endpoint.method | upcase }}"></span>

docs/_plugins/parallels-desktop-file.rb

@@ -10,7 +10,8 @@ class ParallelsDesktopFile < Rouge::RegexLexer
 
       KEYWORDS = %w(
         TO FROM INSECURE AUTHENTICATE PROVIDER LOCAL_PATH DESCRIPTION TAG ROLE CLAIM CATALOG_ID VERSION ARCHITECTURE
-        MACHINE_NAME OWNER DESTINATION START_AFTER_PULL DO RUN
+        MACHINE_NAME OWNER DESTINATION START_AFTER_PULL DO MINIMUM_REQUIREMENT COMPRESS_PACK COMPRESS_PACK_LEVEL
+        VM_REMOTE_PATH FORCE VM_SIZE VM_TYPE IS_COMPRESSED EXECUTE CLONE RUN
       ).join('|')
 
       AUTHENTICATE_SUBCOMMANDS = %w(
@@ -21,61 +22,172 @@ class ParallelsDesktopFile < Rouge::RegexLexer
         USERNAME PASSWORD NAME BUCKET REGION ACCESS_KEY SECRET_KEY
       ).join('|')
 
+      MINIMUM_REQUIREMENT_SUBCOMMANDS = %w(
+        CPU RAM DISK MEMORY
+      ).join('|')
+
+      FORCE_SUBCOMMANDS = %w(
+        true false
+      ).join('|')
+
+      COMPRESS_PACK_LEVEL_SUBCOMMANDS = %w(
+        default balanced best_speed best_compression no_compression
+      ).join('|')
+
+      COMPRESS_PACK_SUBCOMMANDS = %w(
+        true false
+      ).join('|')
+
+      IS_COMPRESSED_SUBCOMMANDS = %w(
+        true false
+      ).join('|')
+
+      VM_TYPE_SUBCOMMANDS = %w(
+        pvm macvm
+      ).join('|')
+
       state :root do
         rule %r/\s+/, Text
+        rule %r/#.*?$/, Comment
+
+        rule %r/^((?:ONBUILD\s+)?RUN)(\s+)([^\n#]*)(\s*)(#.*)?$/io do |m|
+          token Keyword, m[1]
+          token Text::Whitespace, m[2]
+          command = m[3] || ''
+          unless command.empty?
+            stripped = command.rstrip
+            trailing = command[stripped.length..] || ''
+            token Name::Function, stripped unless stripped.empty?
+            token Text::Whitespace, trailing unless trailing.empty?
+          end
+          token Text::Whitespace, m[4] if m[4] && !m[4].empty?
+          token Comment, m[5] if m[5]
+        end
 
         rule %r/^(FROM)(\s+)(.*)(\s+)(AS)(\s+)(.*)/io do
           groups Keyword, Text::Whitespace, Str, Text::Whitespace, Keyword, Text::Whitespace, Str
         end
 
         rule %r/^(AUTHENTICATE)(\s+)(#{AUTHENTICATE_SUBCOMMANDS})(\s+)(.*)/io do
-            groups Keyword, Text::Whitespace, Name::Variable, Text::Whitespace, Punctuation
+            groups Keyword, Text::Whitespace, Name::Variable, Text::Whitespace, Str
         end
 
         rule %r/^(AUTHENTICATE)(\s+)(#{AUTHENTICATE_SUBCOMMANDS})(.*)/io do
             groups Keyword, Text::Whitespace, Error, Error
         end
 
+        rule %r/^(PROVIDER)(\s+)(?=[^#]*=)/io do
+            groups Keyword, Text::Whitespace
+            push :provider
+        end
+
         rule %r/^(PROVIDER)(\s+)(#{PROVIDER_SUBCOMMANDS})(\s+)(.*)/io do
-            groups Keyword, Text::Whitespace, Name::Variable, Text::Whitespace, Punctuation
+            groups Keyword, Text::Whitespace, Name::Variable, Text::Whitespace, Str
+        end
+
+        rule %r/^(MINIMUM_REQUIREMENT)(\s+)(#{MINIMUM_REQUIREMENT_SUBCOMMANDS})(\s+)(.*)/io do
+            groups Keyword, Text::Whitespace, Name::Variable, Text::Whitespace, Str
+        end
+
+        rule %r/^(FORCE)(\s+)(#{FORCE_SUBCOMMANDS})(?=\s*(#|$))/io do
+            groups Keyword, Text::Whitespace, Name::Constant
+        end
+
+        rule %r/^(FORCE)(\s+)(\S.*)/io do
+            groups Keyword, Text::Whitespace, Error
+        end
+
+        rule %r/^(COMPRESS_PACK_LEVEL)(\s+)(#{COMPRESS_PACK_LEVEL_SUBCOMMANDS})(?=\s*(#|$))/io do
+            groups Keyword, Text::Whitespace, Name::Constant
+        end
+
+        rule %r/^(COMPRESS_PACK_LEVEL)(\s+)(\S.*)/io do
+            groups Keyword, Text::Whitespace, Error
+        end
+
+        rule %r/^(COMPRESS_PACK)(\s+)(#{COMPRESS_PACK_SUBCOMMANDS})(?=\s*(#|$))/io do
+            groups Keyword, Text::Whitespace, Name::Constant
+        end
+
+        rule %r/^(COMPRESS_PACK)(\s+)(\S.*)/io do
+            groups Keyword, Text::Whitespace, Error
+        end
+
+        rule %r/^(IS_COMPRESSED)(\s+)(#{IS_COMPRESSED_SUBCOMMANDS})(?=\s*(#|$))/io do
+            groups Keyword, Text::Whitespace, Name::Constant
+        end
+
+        rule %r/^(IS_COMPRESSED)(\s+)(\S.*)/io do
+            groups Keyword, Text::Whitespace, Error
+        end
+
+        rule %r/^(VM_TYPE)(\s+)(#{VM_TYPE_SUBCOMMANDS})(?=\s*(#|$))/io do
+            groups Keyword, Text::Whitespace, Name::Constant
+        end
+
+        rule %r/^(VM_TYPE)(\s+)(\S.*)/io do
+            groups Keyword, Text::Whitespace, Error
         end
 
         rule %r/^(PROVIDER)(\s+)(#{PROVIDER_SUBCOMMANDS})(.*)/io do
             groups Keyword, Text::Whitespace, Error, Error
         end
 
-        rule %r/^(TAG)(\s+)(.*)/io do
-            groups Keyword, Text::Whitespace, Punctuation
+        rule %r/^(TAG)(\s+)/io do
+            groups Keyword, Text::Whitespace
+            push :csv
         end
 
-        rule %r/^(ROLE)(\s+)(.*)/io do
-            groups Keyword, Text::Whitespace, Punctuation
+        rule %r/^(ROLE)(\s+)/io do
+            groups Keyword, Text::Whitespace
+            push :csv
         end
 
-        rule %r/^(CLAIM)(\s+)(.*)/io do
-            groups Keyword, Text::Whitespace, Punctuation
+        rule %r/^(CLAIM)(\s+)/io do
+            groups Keyword, Text::Whitespace
+            push :csv
         end
 
         rule %r/^(#{KEYWORDS})\b(.*)/io do
           groups Keyword, Str
         end
 
-        rule %r/#.*?$/, Comment
+        rule %r/\w+/, Text
+        rule %r/[^\w]+/, Text
+        rule %r/./, Text
+      end
 
-        rule %r/^(ONBUILD\s+)?RUN(\s+)/i do
-          token Keyword
-          push :run
+      state :provider do
+        rule %r/#.*?$/, Comment, :pop!
+        rule %r/\n/, Text, :pop!
+        rule %r/\s+/, Text
+
+        rule %r/([A-Z0-9_-]+)(=)([^;#\s]+)(;)/io do
+          groups Name::Attribute, Operator, Str, Punctuation
+        end
+
+        rule %r/([A-Z0-9_-]+)(=)([^;#\s]+)/io do
+          groups Name::Attribute, Operator, Str
         end
 
-        rule %r/\w+/, Text
-        rule %r/[^\w]+/, Text
         rule %r/./, Text
       end
 
-      state :run do
+      state :csv do
+        rule %r/#.*?$/, Comment, :pop!
         rule %r/\n/, Text, :pop!
-        rule %r/\\./m, Str::Escape
-        rule(/(\\.|[^\n\\])+/) { delegate @shell }
+        rule %r/\s+/, Text
+
+        rule %r/([^,#\s]+)(,)/ do
+          groups Name::Variable, Punctuation
+        end
+
+        rule %r/[^,#\s]+/ do |m|
+          token Name::Variable, m[0]
+        end
+
+        rule %r/./, Text
       end
+
     end
-end
+end

docs/_plugins/prldevops.rb

@@ -9,7 +9,7 @@ class ParallelsDevops < Rouge::RegexLexer
       aliases 'prldevops'
 
       KEYWORDS = %w(
-        catalog push pull api update-root-password gen-rsa
+        catalog push pull run list import import-vm api update-root-password gen-rsa
       ).join('|')
 
       AUTHENTICATE_SUBCOMMANDS = %w(

docs/_sass/_api.scss

@@ -141,7 +141,13 @@
 
     @media screen and (min-width: $l-breakpoint) {
       display: flex;
-      width: $api-side-menu-l-width
+      width: $api-side-menu-l-width;
+      position: sticky;
+      top: 90px;
+      align-self: flex-start;
+      max-height: calc(100vh - 110px);
+      overflow-y: auto;
+      padding-right: 10px;
     }
 
     @media screen and (min-width: $xl-breakpoint) {
@@ -1134,4 +1140,4 @@
       }
     }
   }
-}
+}