Skip to content

docs: adding affilaitions api (CM-1042)#3979

Merged
joanagmaia merged 5 commits intomainfrom
docs/affiliations-api
Apr 2, 2026
Merged

docs: adding affilaitions api (CM-1042)#3979
joanagmaia merged 5 commits intomainfrom
docs/affiliations-api

Conversation

@ulemons
Copy link
Copy Markdown
Contributor

@ulemons ulemons commented Mar 30, 2026

Note

Low Risk
Documentation-only change adding an OpenAPI contract for existing endpoints; no runtime behavior or data handling logic is modified.

Overview
Adds a new openapi.yaml describing the public v1 Affiliations API, including POST /affiliations (bulk lookup with pagination) and GET /affiliations/{githubHandle} (single lookup).

The spec defines bearer API-key security, response/error schemas (Contributor, AffiliationPeriod, BulkAffiliationsResponse, HttpError), and standard error responses (400/401/403/404/429).

Written by Cursor Bugbot for commit 94c4b63. This will update automatically on new commits. Configure here.

Signed-off-by: Umberto Sgueglia <usgueglia@contractor.linuxfoundation.org>
@ulemons ulemons self-assigned this Mar 30, 2026
Copilot AI review requested due to automatic review settings March 30, 2026 14:11
@CLAassistant
Copy link
Copy Markdown

CLAassistant commented Mar 30, 2026

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you all sign our Contributor License Agreement before we can accept your contribution.
1 out of 2 committers have signed the CLA.

✅ joanagmaia
❌ ulemons
You have signed the CLA already but the status is still pending? Let us recheck it.

Signed-off-by: Umberto Sgueglia <usgueglia@contractor.linuxfoundation.org>
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds an OpenAPI specification for the Public v1 “Affiliations” endpoints to document bulk and single-handle contributor affiliation lookups.

Changes:

  • Introduces a new openapi.yaml describing POST /affiliations (bulk lookup with pagination) and GET /affiliations/{githubHandle} (single lookup).
  • Defines request/response schemas and common error responses (400/401/403/404/429) for the Affiliations API.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

ulemons and others added 2 commits March 30, 2026 16:22
Signed-off-by: Umberto Sgueglia <usgueglia@contractor.linuxfoundation.org>
@joanagmaia joanagmaia merged commit 7cdafa5 into main Apr 2, 2026
15 checks passed
@joanagmaia joanagmaia deleted the docs/affiliations-api branch April 2, 2026 14:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants