(#807) Add Swagger defs for envelope community config APIs

Author: excelsior

lib/swagger_docs/models.rb

@@ -512,6 +512,55 @@ module Models # rubocop:todo Metrics/ModuleLength, Style/Documentation
                    description: 'Context URL',
                    type: :string
         end
+
+        swagger_schema :EnvelopeCommunityConfigChange do
+          property :id,
+                   type: :number,
+                   description: 'ID of the change'
+          property :changed_at,
+                   type: :number,
+                   format: :'date-time',
+                   description: 'Date and time of the change'
+
+          property :previous_version do
+            key :type, :object
+            key :description, 'Previous version'
+
+            property :description do
+              key :type, :string
+              key :description, 'Description of the previous version'
+            end
+
+            property :payload do
+              key :type, :object
+              key :description, 'Payload of the previous version'
+            end
+          end
+
+          property :diff do
+            key :type, :object
+
+            property :description do
+              key :type, :array
+              key :description, 'An array containing the previous and current description'
+              key :minItems, 2
+              key :maxItems, 2
+              items do
+                key :type, :string
+              end
+            end
+
+            property :payload do
+              key :type, :array
+              key :description, 'An array containing the previous and current payload'
+              key :minItems, 2
+              key :maxItems, 2
+              items do
+                key :type, :object
+              end
+            end
+          end
+        end
       end
     end
   end

lib/swagger_docs/sections/admin.rb

@@ -213,6 +213,77 @@ module Admin # rubocop:todo Metrics/ModuleLength, Style/Documentation
               end
             end
           end
+
+          swagger_path '/metadata/{community_name}/config' do
+            operation :get do
+              key :operationId, 'getApiConfig'
+              key :description, "Get the envelope community's config"
+              key :produces, ['application/json']
+              key :tags, ['Admin']
+
+              parameter community_name
+
+              response 200 do
+                key :description, "The envelope community's config"
+                key :type, :object
+              end
+            end
+
+            operation :post do
+              key :operationId, 'postApiConfig'
+              key :description, 'Uploads a config for the envelope community'
+              key :produces, ['application/json']
+              key :tags, ['Admin']
+
+              parameter community_name
+
+              parameter do
+                key :name, :body
+                key :in, :body
+                key :description, 'JSON object containing a config and its description'
+                key :required, true
+
+                schema do
+                  key :required, %i[description payload]
+
+                  property :description do
+                    key :type, :string
+                    key :description, 'Config description'
+                  end
+
+                  property :payload do
+                    key :type, :object
+                    key :description, 'Config payload'
+                  end
+                end
+              end
+
+              response 201 do
+                key :description, 'Config uploaded'
+                key :type, :object
+              end
+            end
+          end
+
+          swagger_path '/metadata/{community_name}/config/changes' do
+            operation :get do
+              key :operationId, 'getApiConfigChanges'
+              key :description, "Get the changes to the envelope community's config"
+              key :produces, ['application/json']
+              key :tags, ['Admin']
+
+              parameter community_name
+
+              response 200 do
+                key :description, "The changes to the envelope community's config"
+
+                schema do
+                  key :type, :array
+                  items { key :$ref, :EnvelopeCommunityConfigChange }
+                end
+              end
+            end
+          end
         end
       end
     end