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.

Sign up for GitHub

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

Jump to bottom

Supporting backend API types generation for plugins. #14202

Open
wants to merge 13 commits into
base: master
Choose a base branch
from
Open

Supporting backend API types generation for plugins. #14202

wants to merge 13 commits into from

Conversation

dennisoelkers
Copy link
Member

@dennisoelkers dennisoelkers commented Dec 13, 2022 •
edited
Loading

Description

Motivation and Context

This PR is adding support for generating swagger/OpenAPI types for the backend API for REST resources in plugins by:

  • Allowing to prefix REST resource paths
  • Fixing an issue where the inferred schema of additional_properties was not taken over when it was an inline model

/nocl
/prd https://github.com/Graylog2/graylog-plugin-enterprise/pull/4456

How Has This Been Tested?

Screenshots (if appropriate):

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Refactoring (non-breaking change)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document.
  • I have added tests to cover my changes.

@dennisoelkers dennisoelkers force-pushed the feat/make-swagger-generator-usable-for-plugins branch 3 times, most recently from 9fbc2d3 to 59c6222 Compare December 15, 2022 08:24
@dennisoelkers dennisoelkers marked this pull request as draft March 29, 2023 07:19
@dennisoelkers dennisoelkers marked this pull request as ready for review November 5, 2024 13:42
@dennisoelkers dennisoelkers requested review from a team and linuspahl November 5, 2024 13:43
@linuspahl
Copy link
Contributor

linuspahl commented Nov 7, 2024 •
edited
Loading

Based on the failing build it looks like this branch needs to be merged together with https://github.com/Graylog2/graylog-plugin-enterprise/pull/4456

@dennisoelkers dennisoelkers force-pushed the feat/make-swagger-generator-usable-for-plugins branch from 526898f to 142d981 Compare November 11, 2024 10:17
janheise
janheise approved these changes Nov 11, 2024
View reviewed changes
Copy link
Contributor

@janheise janheise left a comment

Choose a reason for hiding this comment

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

LGTM

@dennisoelkers dennisoelkers force-pushed the feat/make-swagger-generator-usable-for-plugins branch from 142d981 to 86eff69 Compare November 12, 2024 11:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@linuspahl linuspahl linuspahl approved these changes

@janheise janheise janheise approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@dennisoelkers @linuspahl @janheise