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

Swagger has wrong values for enum fields in Broadcast definition #6740

Closed
Himpoke opened this issue Oct 28, 2024 · 1 comment
Closed

Swagger has wrong values for enum fields in Broadcast definition #6740

Himpoke opened this issue Oct 28, 2024 · 1 comment
Assignees

Comments

@Himpoke
Copy link
Contributor

Himpoke commented Oct 28, 2024

Short description

The generated swagger lists a single value for these fields, instead of an enum of those values.
Broadcast.status
Broadcast.playListStatus
Broadcast.type
Broadcast.publishType

This is due to the allowed values for these are set as a single string with commas in.

The effect of this is that we can't do correct code generation on the generated swagger file. We first must do some regex magic to make the file usable.

I actually already opened a pull request for this, but I didn't know if that's an acceptable way to request changes
#6739

Environment

  • Operating system and version: at build time
  • Java version: 17
  • Ant Media Server version: latest, but also in versions before
  • Browser name and version:

Steps to reproduce

  1. Download the swagger file
  2. Find: enum, the Broadcast properties should be the first you find.
  3. See the enum array in the fields listed.

Expected behavior

            "enum": [
              "finished","broadcasting","created","preparing","error","failed"
            ]

Actual behavior

            "enum": [
              "finished,broadcasting,created,preparing,error,failed"
            ]

Logs

no relevant logs

@burak-58
Copy link
Contributor

burak-58 commented Nov 4, 2024

Thank you @Himpoke for the report and pull request. Let us check it and merge.
Also personally I want to thank for the contribution.

@burak-58 burak-58 moved this to Next Sprint in Ant Media Server Nov 4, 2024
@burak-58 burak-58 moved this from Next Sprint to 🔖 Sprint in Ant Media Server Nov 4, 2024
@github-project-automation github-project-automation bot moved this from 🏗 In progress to ✅ Done in Ant Media Server Nov 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

No branches or pull requests

3 participants