make max length 5000, let empty be valid

Author: kathap

app/actions/stack_update.rb

@@ -15,7 +15,7 @@ def update(stack, message)
         stack_updates = {}
         stack_updates[:state] = message.state if message.requested?(:state)
         stack_updates[:state_reason] = message.state_reason if message.state_reason_requested?
-        stack_updates[:description] = message.description if message.description_requested?
+        stack_updates[:description] = message.description if message.requested?(:description)
         stack.update(stack_updates) if stack_updates.any?
 
         MetadataUpdate.update(stack, message)

app/messages/stack_create_message.rb

@@ -6,18 +6,14 @@ class StackCreateMessage < MetadataBaseMessage
     register_allowed_keys %i[name description state state_reason]
 
     validates :name, presence: true, length: { maximum: 250 }
-    validates :description, presence: true, length: { maximum: 250 }, if: :description_requested?
+    validates :description, length: { maximum: 250 }
     validates :state, inclusion: { in: StackStates::VALID_STATES, message: "must be one of #{StackStates::VALID_STATES.join(', ')}" }, allow_nil: false, if: :state_requested?
     validates :state_reason, length: { maximum: 5000 }, allow_nil: true
 
     def state_requested?
       requested?(:state)
     end
 
-    def description_requested?
-      requested?(:description)
-    end
-
     def state
       return @state if defined?(@state)
 

app/messages/stack_update_message.rb

@@ -8,7 +8,7 @@ class StackUpdateMessage < MetadataBaseMessage
     validates_with NoAdditionalKeysValidator
     validates :state, inclusion: { in: StackStates::VALID_STATES, message: "must be one of #{StackStates::VALID_STATES.join(', ')}" }, allow_nil: false, if: :state_requested?
     validates :state_reason, length: { maximum: 5000 }, allow_nil: true
-    validates :description, presence: true, length: { maximum: 250 }, if: :description_requested?
+    validates :description, length: { maximum: 5000 }, allow_nil: true
 
     def state_requested?
       requested?(:state)
@@ -17,9 +17,5 @@ def state_requested?
     def state_reason_requested?
       requested?(:state_reason)
     end
-
-    def description_requested?
-      requested?(:description)
-    end
   end
 end

docs/openapi/apis/cf/latest/components/requestBodies/StackCreateRequestBody.yaml

@@ -11,7 +11,7 @@ content:
           maxLength: 250
         description:
           type: string
-          description: Description of the stack; must be non-empty and no longer than 250 characters
+          description: Description of the stack; must be no longer than 5000 characters
           maxLength: 250
         metadata:
           $ref: '../schemas/Metadata.yaml'

docs/openapi/apis/cf/latest/paths/Stacks.yaml

@@ -155,7 +155,7 @@
             properties:
               description:
                 type: string
-                description: Description of the stack; must be non-empty and no longer than 250 characters
+                description: Description of the stack; must be no longer than 5000 characters
                 maxLength: 250
               metadata:
                 $ref: ../components/schemas/Metadata.yaml

docs/v3/source/includes/resources/stacks/_create.md.erb

@@ -41,7 +41,7 @@ Name | Type | Description
 
 Name | Type | Description | Default
 ---- | ---- | ----------- | -------
-**description** | _string_ | Description of the stack; when provided, must be non-empty and no longer than 250 characters | `null`
+**description** | _string_ | Description of the stack; must be no longer than 5000 characters | `null`
 **metadata.labels** | [_label object_](#labels) | Labels applied to the stack
 **metadata.annotations**  | [_annotation object_](#annotations) | Annotations applied to the stack
 **state** | string | The state of the stack; valid states are: `ACTIVE`, `RESTRICTED`, `DEPRECATED`, `DISABLED`

docs/v3/source/includes/resources/stacks/_update.md.erb

@@ -31,7 +31,7 @@ Content-Type: application/json
 
 Name | Type | Description
 ---- | ---- | -----------
-**description** | _string_ | Description of the stack; must be non-empty and no longer than 250 characters
+**description** | _string_ | Description of the stack; must be no longer than 5000 characters
 **metadata.labels** | [_label object_](#labels) | Labels applied to the stack
 **metadata.annotations**  | [_annotation object_](#annotations) | Annotations applied to the stack
 **state** | string | The state of the stack; valid states are: `ACTIVE`, `RESTRICTED`, `DEPRECATED`, `DISABLED`

spec/request/stacks_spec.rb

@@ -774,11 +774,11 @@
       expect(stack.description).to eq('Preview stack, do not use in production')
     end
 
-    it 'returns 422 when description is empty' do
-      patch "/v3/stacks/#{stack.guid}", { description: '' }.to_json, headers
+    it 'returns 422 when description exceeds the maximum length' do
+      patch "/v3/stacks/#{stack.guid}", { description: 'A' * 5001 }.to_json, headers
 
       expect(last_response.status).to eq(422)
-      expect(last_response).to have_error_message("Description can't be blank")
+      expect(last_response).to have_error_message('Description is too long (maximum is 5000 characters)')
     end
   end
 

spec/unit/messages/stack_create_message_spec.rb

@@ -88,33 +88,6 @@
           expect(subject.errors[:description]).to eq ["is too long (maximum is #{MAX_DESCRIPTION_LENGTH} characters)"]
         end
       end
-
-      context 'when it is an empty string' do
-        let(:params) { valid_params.merge({ description: '' }) }
-
-        it 'returns an error' do
-          expect(subject).not_to be_valid
-          expect(subject.errors[:description]).to include("can't be blank")
-        end
-      end
-
-      context 'when it is only whitespace' do
-        let(:params) { valid_params.merge({ description: '   ' }) }
-
-        it 'returns an error' do
-          expect(subject).not_to be_valid
-          expect(subject.errors[:description]).to include("can't be blank")
-        end
-      end
-
-      context 'when it is explicitly null' do
-        let(:params) { valid_params.merge({ description: nil }) }
-
-        it 'returns an error' do
-          expect(subject).not_to be_valid
-          expect(subject.errors[:description]).to include("can't be blank")
-        end
-      end
     end
 
     describe 'state' do

spec/unit/messages/stack_update_message_spec.rb

@@ -130,10 +130,6 @@
         it 'is valid' do
           expect(subject).to be_valid
         end
-
-        it 'reports description not requested' do
-          expect(subject.description_requested?).to be false
-        end
       end
 
       context 'when it is provided' do
@@ -143,10 +139,6 @@
           expect(subject).to be_valid
           expect(subject.description).to eq('Preview stack, do not use in production')
         end
-
-        it 'reports description requested' do
-          expect(subject.description_requested?).to be true
-        end
       end
 
       context 'when it is at maximum length' do
@@ -169,27 +161,16 @@
       context 'when it is an empty string' do
         let(:params) { valid_params.merge({ description: '' }) }
 
-        it 'returns an error' do
-          expect(subject).not_to be_valid
-          expect(subject.errors[:description]).to include("can't be blank")
-        end
-      end
-
-      context 'when it is only whitespace' do
-        let(:params) { valid_params.merge({ description: '   ' }) }
-
-        it 'returns an error' do
-          expect(subject).not_to be_valid
-          expect(subject.errors[:description]).to include("can't be blank")
+        it 'is valid' do
+          expect(subject).to be_valid
         end
       end
 
       context 'when it is explicitly null' do
         let(:params) { valid_params.merge({ description: nil }) }
 
-        it 'returns an error' do
-          expect(subject).not_to be_valid
-          expect(subject.errors[:description]).to include("can't be blank")
+        it 'is valid' do
+          expect(subject).to be_valid
         end
       end
     end