Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Avoid arbitrary source keys #1139

Open
1 of 2 tasks
defagos opened this issue Feb 14, 2025 · 0 comments · May be fixed by #1140
Open
1 of 2 tasks

Avoid arbitrary source keys #1139

defagos opened this issue Feb 14, 2025 · 0 comments · May be fixed by #1140
Assignees
Labels
enhancement New feature or request

Comments

@defagos
Copy link
Member

defagos commented Feb 14, 2025

As a developer integrating Pillarbox I find it misleading to be able to set any Commanders Act source key while not being able to set an associated site id.

As a Pillarbox developer I want to make our APIs easier to use and understand, while avoiding incorrect usage.

Hints

  • Site id and source key are related.
  • The unique source id supported by Pillarbox is 3666 (GD). This site id has only two valid associated source keys.

Acceptance criteria

  • Only valid supported source keys for site id 3666 are possible.

Tasks

  • Replace source key constants with an enum.
  • Update documentation.
@defagos defagos converted this from a draft issue Feb 14, 2025
@defagos defagos added the enhancement New feature or request label Feb 14, 2025
@defagos defagos moved this from 📋 Backlog to 🍿 Code Review in Pillarbox Feb 14, 2025
@defagos defagos linked a pull request Feb 14, 2025 that will close this issue
4 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
Status: 🍿 Code Review
2 participants