Add media types

[pquentin]

As decided offline:

• Even though this is an endpoint-level property, there's no endpoint-level file, so we use request types and request_media_type/response_media_type keys, as done for URLs
• We use a union of enums and may introduce enums that refer to specific combinations
• We don’t change the metamodel, which stays as string[]
• As a first step, we replicate what is in rest-api-spec. We can fix things later. In particular, for ES|QL and EQL.

This works, as shown by the unchanged schema.json. However, the way I'm getting the request_media_type and response_media_type values is ugly, and I would appreciate a better solution here.

Closes #297

[github-actions]

Following you can find the validation changes against the target branch for the APIs.

No changes detected.

You can validate these APIs yourself by using the make validate target.

[lcawl]

It would be great to ultimately have those text/plain variations appear in the OpenAPI documents too. It's supported per https://swagger.io/docs/specification/v3_0/describing-responses/#response-media-types

[pquentin]

@lcawl Agreed! However, this one fixes #297, not #4081.

[JoshMock]

However, the way I'm getting the request_media_type and response_media_type values is ugly, and I would appreciate a better solution here.

Do you mean mediaTypeToStringArray? If so, that's a pretty straightforward solution. If we had a lot more media types it could feel a bit verbose, but I think it's fine as is.

[pquentin]

Right, parsing unions as strings feels wrong. I would rather use the AST if possible. 🤷

[Anaethelion]

I took a jab at using more the AST.
This however raise a validation error on the codestyle that we should take care of if we decide to move forward with this.

[pquentin]

Thanks! LGTM.

[Anaethelion]

LGTM

[github-actions]

The backport to 8.19 failed:

The process '/usr/bin/git' failed with exit code 1

To backport manually, run these commands in your terminal:

# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add .worktrees/backport-8.19 8.19
# Navigate to the new working tree
cd .worktrees/backport-8.19
# Create a new branch
git switch --create backport-5779-to-8.19
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 8260d402ec3ef0dfdf86a88736c190016f1adbad
# Push it to GitHub
git push --set-upstream origin backport-5779-to-8.19
# Go back to the original working tree
cd ../..
# Delete the working tree
git worktree remove .worktrees/backport-8.19

Then, create a pull request where the base branch is 8.19 and the compare/head branch is backport-5779-to-8.19.

[github-actions]

The backport to 9.1 failed:

The process '/usr/bin/git' failed with exit code 1

To backport manually, run these commands in your terminal:

# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add .worktrees/backport-9.1 9.1
# Navigate to the new working tree
cd .worktrees/backport-9.1
# Create a new branch
git switch --create backport-5779-to-9.1
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 8260d402ec3ef0dfdf86a88736c190016f1adbad
# Push it to GitHub
git push --set-upstream origin backport-5779-to-9.1
# Go back to the original working tree
cd ../..
# Delete the working tree
git worktree remove .worktrees/backport-9.1

Then, create a pull request where the base branch is 9.1 and the compare/head branch is backport-5779-to-9.1.

[github-actions]

The backport to 9.2 failed:

The process '/usr/bin/git' failed with exit code 1

To backport manually, run these commands in your terminal:

# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add .worktrees/backport-9.2 9.2
# Navigate to the new working tree
cd .worktrees/backport-9.2
# Create a new branch
git switch --create backport-5779-to-9.2
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 8260d402ec3ef0dfdf86a88736c190016f1adbad
# Push it to GitHub
git push --set-upstream origin backport-5779-to-9.2
# Go back to the original working tree
cd ../..
# Delete the working tree
git worktree remove .worktrees/backport-9.2

Then, create a pull request where the base branch is 9.2 and the compare/head branch is backport-5779-to-9.2.

[pquentin]

💚 All backports created successfully

Status	Branch	Result
✅	9.2
✅	9.1
✅	8.19

Questions ?

Please refer to the Backport tool documentation