semaphoreio/semaphore

Add missing `Content-Type` headers in public api

Open

#372 opened on Jun 9, 2025

View on GitHub
 (3 comments) (0 reactions) (2 assignees)Elixir (77 forks)batch import
enhancementgood first issue

Repository metrics

Stars
 (1,519 stars)
PR merge metrics
 (Avg merge 4d 11h) (23 merged PRs in 30d)

Description

Is your improvement proposal related to a problem? Please describe.

Currently, only some responses from the public API have a Content-Type header set. This can lead to issues when the requester expects a specific content type and it is not provided.

Describe the solution you'd like

Add Content-Type headers to all responses from the public API, ensuring that they are set to the appropriate type based on the content being returned (e.g., application/json for JSON responses).

Describe alternatives you've considered

No response

Additional context

Contributor guide

Research direction
Start by examining the public API router at `public api/v1alpha/lib/pipelines api/router.ex`. Identify all response handlers that fail to set a `Content Type` header. Add the appropriate header (e.g., `application/json`) to these responses, ensuring consistency with existing handlers. Follow the contribution guide for code style and testing.
Tech stack
elixir
Domain
apibackend
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Blocked
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
ElixirHTTP headersPhoenix framework
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40