Merge pull request #149 from linuxfoundation/LFXV2-1709

feat: add repository, scope, deliverables, and key_dates to committee metadata

Author: dealako

cmd/committee-api/design/type.go

@@ -32,6 +32,10 @@ func CommitteeBaseAttributes() {
 	DisplayNameAttribute()
 	ParentCommitteeUIDAttribute()
 	JoinModeAttribute()
+	RepositoryAttribute()
+	ScopeAttribute()
+	DeliverablesAttribute()
+	KeyDatesAttribute()
 }
 
 // CommitteeSettings is the DSL type for a committee settings.
@@ -197,15 +201,78 @@ func DescriptionAttribute() {
 	})
 }
 
+// urlPattern validates an HTTP(S) URL (used by website and repository attributes).
+// The scheme is mandatory to reject non-HTTP schemes (e.g. javascript:, data:) that
+// would otherwise pass dsl.FormatURI as syntactically valid URIs.
+const urlPattern = `^https?://[^\s/$.?#][^\s]*$`
+
 // WebsiteAttribute is the DSL attribute for committee website.
 func WebsiteAttribute() {
 	dsl.Attribute("website", dsl.String, "The website URL of the committee", func() {
 		dsl.Format(dsl.FormatURI)
-		dsl.Pattern(`^(https?://)?[^\s/$.?#].[^\s]*$`)
+		dsl.Pattern(urlPattern)
 		dsl.Example("https://committee.example.org")
 	})
 }
 
+// RepositoryAttribute is the DSL attribute for committee repository URL.
+func RepositoryAttribute() {
+	dsl.Attribute("repository", dsl.String, "The URL of the committee's code repository", func() {
+		dsl.Format(dsl.FormatURI)
+		dsl.Pattern(urlPattern)
+		dsl.Example("https://github.com/example/repo")
+	})
+}
+
+// ScopeAttribute is the DSL attribute for committee scope bullet points.
+func ScopeAttribute() {
+	dsl.Attribute("scope", dsl.ArrayOf(dsl.String), "The scope of the committee, as a list of bullet points", func() {
+		dsl.MaxLength(50)
+		dsl.Elem(func() {
+			dsl.MaxLength(500)
+		})
+		dsl.Example([]string{"Define governance for the project", "Review and approve major architectural changes"})
+	})
+}
+
+// DeliverablesAttribute is the DSL attribute for committee deliverables bullet points.
+func DeliverablesAttribute() {
+	dsl.Attribute("deliverables", dsl.ArrayOf(dsl.String), "The deliverables of the committee, as a list of bullet points", func() {
+		dsl.MaxLength(50)
+		dsl.Elem(func() {
+			dsl.MaxLength(500)
+		})
+		dsl.Example([]string{"Quarterly technical roadmap", "Annual governance review"})
+	})
+}
+
+// keyDateFormatPattern validates a month-only date in YYYY-MM format.
+const keyDateFormatPattern = `^\d{4}-(0[1-9]|1[0-2])$`
+
+// KeyDateType is the DSL type for a single entry in a committee's key-dates timeline.
+var KeyDateType = dsl.Type("key-date", func() {
+	dsl.Description("A single entry in a committee's key-dates timeline.")
+	dsl.Attribute("date", dsl.String, "The month of the key date, in YYYY-MM format", func() {
+		dsl.Pattern(keyDateFormatPattern)
+		dsl.Example("2026-04")
+	})
+	dsl.Attribute("label", dsl.String, "Label describing the key date", func() {
+		dsl.MaxLength(200)
+		dsl.Example("Charter renewal")
+	})
+	dsl.Required("date", "label")
+})
+
+// KeyDatesAttribute is the DSL attribute for a committee's key-dates timeline.
+func KeyDatesAttribute() {
+	dsl.Attribute("key_dates", dsl.ArrayOf(KeyDateType), "Timeline of important dates for the committee", func() {
+		dsl.MaxLength(50)
+		dsl.Example([]map[string]interface{}{
+			{"date": "2026-04", "label": "Charter renewal"},
+		})
+	})
+}
+
 // EnableVotingAttribute is the DSL attribute for enabling voting.
 func EnableVotingAttribute() {
 	dsl.Attribute("enable_voting", dsl.Boolean, "Whether voting is enabled for this committee", func() {

cmd/committee-api/design/type_test.go

@@ -0,0 +1,35 @@
+// Copyright The Linux Foundation and each contributor to LFX.
+// SPDX-License-Identifier: MIT
+
+package design
+
+import (
+	"regexp"
+	"testing"
+)
+
+func TestURLPattern(t *testing.T) {
+	re := regexp.MustCompile(urlPattern)
+
+	tests := []struct {
+		name  string
+		value string
+		want  bool
+	}{
+		{"https URL", "https://github.com/example/repo", true},
+		{"http URL", "http://committee.example.org", true},
+		{"javascript scheme rejected", "javascript:alert(1)", false},
+		{"data scheme rejected", "data:text/html,<script>alert(1)</script>", false},
+		{"file scheme rejected", "file:///etc/passwd", false},
+		{"schemeless domain rejected", "committee.example.org", false},
+		{"empty string rejected", "", false},
+	}
+
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			if got := re.MatchString(tt.value); got != tt.want {
+				t.Errorf("urlPattern.MatchString(%q) = %v, want %v", tt.value, got, tt.want)
+			}
+		})
+	}
+}

cmd/committee-api/service/committee_service_response.go

@@ -59,6 +59,14 @@ func (s *committeeServicesrvc) convertPayloadToBase(p *committeeservice.CreateCo
 	// Handle ParentUID (already a pointer, safe to assign directly)
 	base.ParentUID = p.ParentUID
 
+	// Handle Repository (already a pointer, safe to assign directly)
+	base.Repository = p.Repository
+	base.Scope = p.Scope
+	base.Deliverables = p.Deliverables
+
+	// Handle KeyDates if present
+	base.KeyDates = convertPayloadKeyDatesToModel(p.KeyDates)
+
 	// Handle calendar if present
 	if p.Calendar != nil {
 		base.Calendar = model.Calendar{
@@ -127,6 +135,14 @@ func (s *committeeServicesrvc) convertPayloadToUpdateBase(p *committeeservice.Up
 	// Handle ParentUID (already a pointer, safe to assign directly)
 	base.ParentUID = p.ParentUID
 
+	// Handle Repository (already a pointer, safe to assign directly)
+	base.Repository = p.Repository
+	base.Scope = p.Scope
+	base.Deliverables = p.Deliverables
+
+	// Handle KeyDates if present
+	base.KeyDates = convertPayloadKeyDatesToModel(p.KeyDates)
+
 	base.JoinMode = p.JoinMode
 
 	// Handle calendar if present
@@ -145,6 +161,44 @@ func (s *committeeServicesrvc) convertPayloadToUpdateBase(p *committeeservice.Up
 	return committee
 }
 
+// convertPayloadKeyDatesToModel converts GOA KeyDate payloads to domain KeyDates.
+func convertPayloadKeyDatesToModel(dates []*committeeservice.KeyDate) []model.KeyDate {
+	if dates == nil {
+		return nil
+	}
+
+	result := make([]model.KeyDate, 0, len(dates))
+	for _, d := range dates {
+		if d == nil {
+			continue
+		}
+
+		result = append(result, model.KeyDate{
+			Date:  d.Date,
+			Label: d.Label,
+		})
+	}
+
+	return result
+}
+
+// convertModelKeyDatesToResponse converts domain KeyDates to GOA response KeyDates.
+func convertModelKeyDatesToResponse(dates []model.KeyDate) []*committeeservice.KeyDate {
+	if dates == nil {
+		return nil
+	}
+
+	result := make([]*committeeservice.KeyDate, 0, len(dates))
+	for _, d := range dates {
+		result = append(result, &committeeservice.KeyDate{
+			Date:  d.Date,
+			Label: d.Label,
+		})
+	}
+
+	return result
+}
+
 // convertPayloadToUpdateSettings converts GOA UpdateCommitteeSettingsPayload to CommitteeSettings domain model.
 // existing, when non-nil, is used to seed each writer/auditor entry so stored identity fields
 // are preserved across PUT requests without the client having to send them.
@@ -211,6 +265,12 @@ func (s *committeeServicesrvc) convertDomainToFullResponse(response *model.Commi
 	if response.ParentUID != nil && *response.ParentUID != "" {
 		result.ParentUID = response.ParentUID
 	}
+	if response.Repository != nil && *response.Repository != "" {
+		result.Repository = response.Repository
+	}
+	result.Scope = response.Scope
+	result.Deliverables = response.Deliverables
+	result.KeyDates = convertModelKeyDatesToResponse(response.KeyDates)
 	if response.SSOGroupName != "" {
 		result.SsoGroupName = &response.SSOGroupName
 	}
@@ -292,6 +352,12 @@ func (s *committeeServicesrvc) convertBaseToResponse(base *model.CommitteeBase)
 	if base.ParentUID != nil && *base.ParentUID != "" {
 		result.ParentUID = base.ParentUID
 	}
+	if base.Repository != nil && *base.Repository != "" {
+		result.Repository = base.Repository
+	}
+	result.Scope = base.Scope
+	result.Deliverables = base.Deliverables
+	result.KeyDates = convertModelKeyDatesToResponse(base.KeyDates)
 	if base.SSOGroupName != "" {
 		result.SsoGroupName = &base.SSOGroupName
 	}