docs: update documentation for CS architecture and REST API Gateway#191
docs: update documentation for CS architecture and REST API Gateway#191cuioss-oliver wants to merge 2 commits intomainfrom
Conversation
… API Gateway (#188) Update all specification documents, PlantUML diagrams, READMEs, and guides to reflect the architectural evolution: Controller Service pattern, RestApiGatewayProcessor with embedded Jetty, 4-module structure, and unified Custom UI. Add gateway requirements (NIFI-GATEWAY-1 through NIFI-GATEWAY-8), fix 15+ broken cross-references, create module READMEs, and correct misplaced nifi-cuioss-processors/README.md content. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Summary of ChangesHello @cuioss-oliver, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request significantly enhances the NiFi Extensions project by introducing a powerful new REST API Gateway processor, alongside a thorough overhaul of the project's documentation and internal architecture. The changes aim to provide a more robust and streamlined solution for handling JWT-authenticated REST APIs within Apache NiFi, improving both developer experience and operational visibility. The architectural refactoring ensures better modularity and adherence to NiFi 2.x standards, while comprehensive documentation updates ensure clarity and ease of use for all new and existing features. Highlights
Changelog
Activity
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
There was a problem hiding this comment.
Code Review
This is an excellent and thorough documentation update that aligns all specifications, diagrams, and guides with the new architecture including the RestApiGatewayProcessor. The new module READMEs and restructured integration patterns significantly improve clarity for developers and users. I've found a couple of minor issues in the documentation that could be addressed to make it even better, detailed in the comments below.
Remove reference to non-existent 02-verify-custom-ui-tabs.spec.js — this test file does not exist on disk. The actual test numbering starts at 01 (configuration), 02 (JWKS validation), 03 (token verification), etc. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Summary
Changes by category
Closes #188
Test plan
./mvnw -Ppre-commit clean install -DskipTestspasses./mvnw clean installpasses (all tests green)🤖 Generated with Claude Code