Merge pull request #175 from linuxfoundation/feat/LFXV2-2013-ocg-external-sources

feat(committee): add external_sources field to committee base (LFXV2-2013)

Author: MRashad26

cmd/committee-api/design/type.go

@@ -36,6 +36,7 @@ func CommitteeBaseAttributes() {
 	ScopeAttribute()
 	DeliverablesAttribute()
 	KeyDatesAttribute()
+	ExternalSourcesAttribute()
 }
 
 // CommitteeSettings is the DSL type for a committee settings.
@@ -274,6 +275,61 @@ func KeyDatesAttribute() {
 	})
 }
 
+// ExternalSourceType is the DSL type for a single external source linked to a committee.
+var ExternalSourceType = dsl.Type("external-source", func() {
+	dsl.Description("A single source-labeled external entity linked to a committee (e.g. an OCG group or event).")
+	dsl.Attribute("provider", dsl.String, "The external platform that owns this linked entity", func() {
+		dsl.Enum("ocg")
+		dsl.Example("ocg")
+	})
+	dsl.Attribute("entity_type", dsl.String, "The type of entity in the external platform", func() {
+		dsl.Enum("community", "group", "event")
+		dsl.Example("group")
+	})
+	dsl.Attribute("label", dsl.String, "Human-readable label for the linked external entity", func() {
+		dsl.MaxLength(200)
+		dsl.Example("CNCF Meetup - San Francisco")
+	})
+	dsl.Attribute("url", dsl.String, "The URL of the linked external entity", func() {
+		dsl.Format(dsl.FormatURI)
+		dsl.Pattern(urlPattern)
+		dsl.MaxLength(2048)
+		dsl.Example("https://community.cncf.io/cncf-meetup-san-francisco/")
+	})
+	dsl.Attribute("external_id", dsl.String, "The identifier of the entity within the external platform", func() {
+		dsl.MaxLength(200)
+		dsl.Example("cncf-meetup-san-francisco")
+	})
+	dsl.Attribute("external_category", dsl.String, "The community-managed category of the entity in the external platform", func() {
+		dsl.MaxLength(200)
+		dsl.Example("Meetup")
+	})
+	dsl.Attribute("external_region", dsl.String, "The community-managed region of the entity in the external platform", func() {
+		dsl.MaxLength(200)
+		dsl.Example("North America")
+	})
+	dsl.Attribute("external_event_category", dsl.String, "The community-managed event category of the entity in the external platform", func() {
+		dsl.MaxLength(200)
+		dsl.Example("Virtual")
+	})
+	dsl.Required("provider", "entity_type", "label", "url")
+})
+
+// ExternalSourcesAttribute is the DSL attribute for a committee's linked external sources.
+func ExternalSourcesAttribute() {
+	dsl.Attribute("external_sources", dsl.ArrayOf(ExternalSourceType), "External source-labeled entities linked to this committee (e.g. OCG groups or events)", func() {
+		dsl.MaxLength(50)
+		dsl.Example([]map[string]interface{}{
+			{
+				"provider":    "ocg",
+				"entity_type": "group",
+				"label":       "CNCF Meetup - San Francisco",
+				"url":         "https://community.cncf.io/cncf-meetup-san-francisco/",
+			},
+		})
+	})
+}
+
 // 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/service/committee_service_response.go

@@ -67,6 +67,9 @@ func (s *committeeServicesrvc) convertPayloadToBase(p *committeeservice.CreateCo
 	// Handle KeyDates if present
 	base.KeyDates = convertPayloadKeyDatesToModel(p.KeyDates)
 
+	// Handle ExternalSources if present
+	base.ExternalSources = convertPayloadExternalSourcesToModel(p.ExternalSources)
+
 	// Handle calendar if present
 	if p.Calendar != nil {
 		base.Calendar = model.Calendar{
@@ -143,6 +146,9 @@ func (s *committeeServicesrvc) convertPayloadToUpdateBase(p *committeeservice.Up
 	// Handle KeyDates if present
 	base.KeyDates = convertPayloadKeyDatesToModel(p.KeyDates)
 
+	// Handle ExternalSources if present
+	base.ExternalSources = convertPayloadExternalSourcesToModel(p.ExternalSources)
+
 	base.JoinMode = p.JoinMode
 
 	// Handle calendar if present
@@ -199,6 +205,78 @@ func convertModelKeyDatesToResponse(dates []model.KeyDate) []*committeeservice.K
 	return result
 }
 
+// convertPayloadExternalSourcesToModel converts GOA ExternalSource payloads to domain ExternalSources.
+func convertPayloadExternalSourcesToModel(sources []*committeeservice.ExternalSource) []model.ExternalSource {
+	if sources == nil {
+		return nil
+	}
+
+	result := make([]model.ExternalSource, 0, len(sources))
+	for _, src := range sources {
+		if src == nil {
+			continue
+		}
+
+		entry := model.ExternalSource{
+			Provider:   src.Provider,
+			EntityType: src.EntityType,
+			Label:      src.Label,
+			URL:        src.URL,
+		}
+
+		if src.ExternalID != nil {
+			entry.ExternalID = *src.ExternalID
+		}
+		if src.ExternalCategory != nil {
+			entry.ExternalCategory = *src.ExternalCategory
+		}
+		if src.ExternalRegion != nil {
+			entry.ExternalRegion = *src.ExternalRegion
+		}
+		if src.ExternalEventCategory != nil {
+			entry.ExternalEventCategory = *src.ExternalEventCategory
+		}
+
+		result = append(result, entry)
+	}
+
+	return result
+}
+
+// convertModelExternalSourcesToResponse converts domain ExternalSources to GOA response ExternalSources.
+func convertModelExternalSourcesToResponse(sources []model.ExternalSource) []*committeeservice.ExternalSource {
+	if sources == nil {
+		return nil
+	}
+
+	result := make([]*committeeservice.ExternalSource, 0, len(sources))
+	for _, src := range sources {
+		entry := &committeeservice.ExternalSource{
+			Provider:   src.Provider,
+			EntityType: src.EntityType,
+			Label:      src.Label,
+			URL:        src.URL,
+		}
+
+		if src.ExternalID != "" {
+			entry.ExternalID = &src.ExternalID
+		}
+		if src.ExternalCategory != "" {
+			entry.ExternalCategory = &src.ExternalCategory
+		}
+		if src.ExternalRegion != "" {
+			entry.ExternalRegion = &src.ExternalRegion
+		}
+		if src.ExternalEventCategory != "" {
+			entry.ExternalEventCategory = &src.ExternalEventCategory
+		}
+
+		result = append(result, entry)
+	}
+
+	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.
@@ -271,6 +349,7 @@ func (s *committeeServicesrvc) convertDomainToFullResponse(response *model.Commi
 	result.Scope = response.Scope
 	result.Deliverables = response.Deliverables
 	result.KeyDates = convertModelKeyDatesToResponse(response.KeyDates)
+	result.ExternalSources = convertModelExternalSourcesToResponse(response.ExternalSources)
 	if response.SSOGroupName != "" {
 		result.SsoGroupName = &response.SSOGroupName
 	}
@@ -358,6 +437,7 @@ func (s *committeeServicesrvc) convertBaseToResponse(base *model.CommitteeBase)
 	result.Scope = base.Scope
 	result.Deliverables = base.Deliverables
 	result.KeyDates = convertModelKeyDatesToResponse(base.KeyDates)
+	result.ExternalSources = convertModelExternalSourcesToResponse(base.ExternalSources)
 	if base.SSOGroupName != "" {
 		result.SsoGroupName = &base.SSOGroupName
 	}

cmd/committee-api/service/committee_service_response_test.go

@@ -1531,6 +1531,18 @@ func TestConvertPayloadToBase_CommitteeMetadata(t *testing.T) {
 					{Date: "2026-01", Label: "Kickoff"},
 					{Date: "2026-06", Label: "Review"},
 				},
+				ExternalSources: []*committeeservice.ExternalSource{
+					{
+						Provider:              "ocg",
+						EntityType:            "group",
+						Label:                 "CNCF Meetup - San Francisco",
+						URL:                   "https://community.cncf.io/cncf-meetup-san-francisco/",
+						ExternalID:            stringPtr("cncf-meetup-san-francisco"),
+						ExternalCategory:      stringPtr("meetup"),
+						ExternalRegion:        stringPtr("north-america"),
+						ExternalEventCategory: stringPtr("in-person"),
+					},
+				},
 			},
 			expected: model.CommitteeBase{
 				ProjectUID:   "project-123",
@@ -1543,6 +1555,18 @@ func TestConvertPayloadToBase_CommitteeMetadata(t *testing.T) {
 					{Date: "2026-01", Label: "Kickoff"},
 					{Date: "2026-06", Label: "Review"},
 				},
+				ExternalSources: []model.ExternalSource{
+					{
+						Provider:              "ocg",
+						EntityType:            "group",
+						Label:                 "CNCF Meetup - San Francisco",
+						URL:                   "https://community.cncf.io/cncf-meetup-san-francisco/",
+						ExternalID:            "cncf-meetup-san-francisco",
+						ExternalCategory:      "meetup",
+						ExternalRegion:        "north-america",
+						ExternalEventCategory: "in-person",
+					},
+				},
 			},
 		},
 		{
@@ -1589,6 +1613,17 @@ func TestConvertPayloadToUpdateBase_CommitteeMetadata(t *testing.T) {
 				KeyDates: []*committeeservice.KeyDate{
 					{Date: "2026-02", Label: "Milestone"},
 				},
+				ExternalSources: []*committeeservice.ExternalSource{
+					{
+						Provider:              "ocg",
+						EntityType:            "event",
+						Label:                 "CNCF Meetup - Austin",
+						URL:                   "https://community.cncf.io/cncf-meetup-austin/",
+						ExternalCategory:      stringPtr("meetup"),
+						ExternalRegion:        stringPtr("north-america"),
+						ExternalEventCategory: stringPtr("virtual"),
+					},
+				},
 			},
 			expected: model.CommitteeBase{
 				UID:          "committee-123",
@@ -1601,6 +1636,17 @@ func TestConvertPayloadToUpdateBase_CommitteeMetadata(t *testing.T) {
 				KeyDates: []model.KeyDate{
 					{Date: "2026-02", Label: "Milestone"},
 				},
+				ExternalSources: []model.ExternalSource{
+					{
+						Provider:              "ocg",
+						EntityType:            "event",
+						Label:                 "CNCF Meetup - Austin",
+						URL:                   "https://community.cncf.io/cncf-meetup-austin/",
+						ExternalCategory:      "meetup",
+						ExternalRegion:        "north-america",
+						ExternalEventCategory: "virtual",
+					},
+				},
 			},
 		},
 		{
@@ -1649,6 +1695,18 @@ func TestConvertBaseToResponse_CommitteeMetadata(t *testing.T) {
 				KeyDates: []model.KeyDate{
 					{Date: "2026-01", Label: "Kickoff"},
 				},
+				ExternalSources: []model.ExternalSource{
+					{
+						Provider:              "ocg",
+						EntityType:            "group",
+						Label:                 "CNCF Meetup - San Francisco",
+						URL:                   "https://community.cncf.io/cncf-meetup-san-francisco/",
+						ExternalID:            "cncf-meetup-san-francisco",
+						ExternalCategory:      "meetup",
+						ExternalRegion:        "north-america",
+						ExternalEventCategory: "in-person",
+					},
+				},
 			},
 			expected: &committeeservice.CommitteeBaseWithReadonlyAttributes{
 				UID:          stringPtr("committee-123"),
@@ -1661,6 +1719,18 @@ func TestConvertBaseToResponse_CommitteeMetadata(t *testing.T) {
 				KeyDates: []*committeeservice.KeyDate{
 					{Date: "2026-01", Label: "Kickoff"},
 				},
+				ExternalSources: []*committeeservice.ExternalSource{
+					{
+						Provider:              "ocg",
+						EntityType:            "group",
+						Label:                 "CNCF Meetup - San Francisco",
+						URL:                   "https://community.cncf.io/cncf-meetup-san-francisco/",
+						ExternalID:            stringPtr("cncf-meetup-san-francisco"),
+						ExternalCategory:      stringPtr("meetup"),
+						ExternalRegion:        stringPtr("north-america"),
+						ExternalEventCategory: stringPtr("in-person"),
+					},
+				},
 				Calendar: &struct {
 					Public bool
 				}{},
@@ -1751,6 +1821,34 @@ func TestValidateCreateCommitteeRequestBody_Metadata(t *testing.T) {
 			},
 			wantErr: false,
 		},
+		{
+			name: "external_sources entry with invalid url rejected",
+			mutate: func(b *server.CreateCommitteeRequestBody) {
+				b.ExternalSources = []*server.ExternalSourceRequestBody{
+					{
+						Provider:   stringPtr("ocg"),
+						EntityType: stringPtr("group"),
+						Label:      stringPtr("CNCF Meetup"),
+						URL:        stringPtr("javascript:alert(1)"),
+					},
+				}
+			},
+			wantErr: true,
+		},
+		{
+			name: "external_sources entry with invalid provider rejected",
+			mutate: func(b *server.CreateCommitteeRequestBody) {
+				b.ExternalSources = []*server.ExternalSourceRequestBody{
+					{
+						Provider:   stringPtr("unknown"),
+						EntityType: stringPtr("group"),
+						Label:      stringPtr("CNCF Meetup"),
+						URL:        stringPtr("https://community.cncf.io/cncf-meetup-san-francisco/"),
+					},
+				}
+			},
+			wantErr: true,
+		},
 	}
 
 	for _, tt := range tests {
@@ -1811,6 +1909,34 @@ func TestValidateUpdateCommitteeBaseRequestBody_Metadata(t *testing.T) {
 			},
 			wantErr: true,
 		},
+		{
+			name: "external_sources entry with invalid url rejected",
+			mutate: func(b *server.UpdateCommitteeBaseRequestBody) {
+				b.ExternalSources = []*server.ExternalSourceRequestBody{
+					{
+						Provider:   stringPtr("ocg"),
+						EntityType: stringPtr("group"),
+						Label:      stringPtr("CNCF Meetup"),
+						URL:        stringPtr("javascript:alert(1)"),
+					},
+				}
+			},
+			wantErr: true,
+		},
+		{
+			name: "external_sources entry with invalid provider rejected",
+			mutate: func(b *server.UpdateCommitteeBaseRequestBody) {
+				b.ExternalSources = []*server.ExternalSourceRequestBody{
+					{
+						Provider:   stringPtr("unknown"),
+						EntityType: stringPtr("group"),
+						Label:      stringPtr("CNCF Meetup"),
+						URL:        stringPtr("https://community.cncf.io/cncf-meetup-san-francisco/"),
+					},
+				}
+			},
+			wantErr: true,
+		},
 	}
 
 	for _, tt := range tests {

docs/indexer-contract.md

@@ -59,6 +59,7 @@ These fields are indexed and queryable via `filters` or `cel_filter` in the quer
 | `scope` | []string (optional) | Committee scope bullet points |
 | `deliverables` | []string (optional) | Committee deliverables bullet points |
 | `key_dates` | []object (optional) | Committee key-dates timeline, each with `date` (`YYYY-MM`) and `label` |
+| `external_sources` | []object (optional) | Source-labeled external entities linked to the committee (e.g. OCG groups/events), each with `provider`, `entity_type`, `label`, `url`, and optional `external_id`, `external_category`, `external_region`, `external_event_category` |
 | `total_members` | int | Current total member count |
 | `total_voting_repos` | int | Current total voting repos count |
 | `has_mailing_list` | bool | Whether a related mailing list exists |