Class: Zavudev::Models::RequirementType

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Zavudev::Models::RequirementType

Defined in:

lib/zavudev/models/requirement_type.rb

Instance Attribute Summary

• #acceptance_criteria ⇒ Zavudev::Models::RequirementAcceptanceCriteria^?

  Acceptance criteria for a requirement.

• #description ⇒ String
• #example ⇒ String^?
• #id ⇒ String
• #name ⇒ String
• #type ⇒ Symbol, Zavudev::Models::RequirementFieldType

  Type of requirement field.

Instance Method Summary

• #initialize(id:, description:, name:, type:, acceptance_criteria: nil, example: nil) ⇒ Object constructor

  A specific requirement type within a requirement group.

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(id:, description:, name:, type:, acceptance_criteria: nil, example: nil) ⇒ Object

A specific requirement type within a requirement group.

Parameters:

• id (String)
• description (String)
• name (String)
• type (Symbol, Zavudev::Models::RequirementFieldType) —

  Type of requirement field.

• acceptance_criteria (Zavudev::Models::RequirementAcceptanceCriteria) (defaults to: nil) —

  Acceptance criteria for a requirement.

• example (String, nil) (defaults to: nil)

# File 'lib/zavudev/models/requirement_type.rb', line 40

Instance Attribute Details

#acceptance_criteria ⇒ Zavudev::Models::RequirementAcceptanceCriteria^?

Acceptance criteria for a requirement.

Returns:

• (Zavudev::Models::RequirementAcceptanceCriteria, nil)

# File 'lib/zavudev/models/requirement_type.rb', line 31

optional :acceptance_criteria,
-> { Zavudev::RequirementAcceptanceCriteria },
api_name: :acceptanceCriteria

#description ⇒ String

Returns:

• (String)

# File 'lib/zavudev/models/requirement_type.rb', line 14

required :description, String

#example ⇒ String^?

Returns:

• (String, nil)

# File 'lib/zavudev/models/requirement_type.rb', line 38

optional :example, String, nil?: true

#id ⇒ String

Returns:

• (String)

# File 'lib/zavudev/models/requirement_type.rb', line 9

required :id, String

#name ⇒ String

Returns:

• (String)

# File 'lib/zavudev/models/requirement_type.rb', line 19

required :name, String

#type ⇒ Symbol, Zavudev::Models::RequirementFieldType

Type of requirement field.

Returns:

• (Symbol, Zavudev::Models::RequirementFieldType)

# File 'lib/zavudev/models/requirement_type.rb', line 25

required :type, enum: -> { Zavudev::RequirementFieldType }