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

NIFI-14142 Declare enum values for OpenAPI using String arrays #9626

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

EndzeitBegins
Copy link
Contributor

@EndzeitBegins EndzeitBegins commented Jan 10, 2025

Summary

NIFI-14142


swagger.json before change (excerpt)

{
      "AffectedComponentDTO" : {
        "type" : "object",
        "properties" : {
          "activeThreadCount" : {
            "type" : "integer",
            "format" : "int32",
            "description" : "The number of active threads for the referencing component."
          },
          "id" : {
            "type" : "string",
            "description" : "The UUID of this component"
          },
          "name" : {
            "type" : "string",
            "description" : "The name of this component."
          },
          "processGroupId" : {
            "type" : "string",
            "description" : "The UUID of the Process Group that this component is in"
          },
          "referenceType" : {
            "type" : "string",
            "description" : "The type of this component",
            "enum" : [ "PROCESSOR,CONTROLLER_SERVICE, INPUT_PORT, OUTPUT_PORT, REMOTE_INPUT_PORT, REMOTE_OUTPUT_PORT, STATELESS_GROUP" ]
          },
          "state" : {
            "type" : "string",
            "description" : "The scheduled state of a processor or reporting task referencing a controller service. If this component is another controller service, this field represents the controller service state."
          },
          "validationErrors" : {
            "type" : "array",
            "description" : "The validation errors for the component.",
            "items" : {
              "type" : "string",
              "description" : "The validation errors for the component."
            }
          }
        }
      }
}

swagger.json after change (excerpt)

{
      "AffectedComponentDTO" : {
        "type" : "object",
        "properties" : {
          "activeThreadCount" : {
            "type" : "integer",
            "format" : "int32",
            "description" : "The number of active threads for the referencing component."
          },
          "id" : {
            "type" : "string",
            "description" : "The UUID of this component"
          },
          "name" : {
            "type" : "string",
            "description" : "The name of this component."
          },
          "processGroupId" : {
            "type" : "string",
            "description" : "The UUID of the Process Group that this component is in"
          },
          "referenceType" : {
            "type" : "string",
            "description" : "The type of this component",
            "enum" : [ "PROCESSOR", "CONTROLLER_SERVICE", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "STATELESS_GROUP" ]
          },
          "state" : {
            "type" : "string",
            "description" : "The scheduled state of a processor or reporting task referencing a controller service. If this component is another controller service, this field represents the controller service state."
          },
          "validationErrors" : {
            "type" : "array",
            "description" : "The validation errors for the component.",
            "items" : {
              "type" : "string",
              "description" : "The validation errors for the component."
            }
          }
        }
      }
}

Tracking

Please complete the following tracking steps prior to pull request creation.

Issue Tracking

Pull Request Tracking

  • Pull Request title starts with Apache NiFi Jira issue number, such as NIFI-00000
  • Pull Request commit message starts with Apache NiFi Jira issue number, as such NIFI-00000

Pull Request Formatting

  • Pull Request based on current revision of the main branch
  • Pull Request refers to a feature branch with one commit containing changes

Verification

Please indicate the verification steps performed prior to pull request creation.

Build

  • Build completed using mvn clean install -P contrib-check
    • JDK 21

Licensing

  • New dependencies are compatible with the Apache License 2.0 according to the License Policy
  • New dependencies are documented in applicable LICENSE and NOTICE files

Documentation

  • Documentation formatting appears as expected in rendered files

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant