docs(readme): sync Architecture section with v3.0 channel EP and add YAML field conversion#730
Merged
Merged
Conversation
Contributor
|
📦 Plugin has been packaged for this PR. You can download |
…YAML field conversion - Replace stale `ApiExporter` (no longer exists) with the `Channel` extension point — the actual v3.0 export abstraction registered in plugin.xml - Reflect built-in ClassExporter implementations (Spring MVC, Feign, JAX-RS, Actuator, gRPC) and built-in channels (Markdown, Postman, cURL, HTTP Client, Hoppscotch Beta) - Add the AI Assistant layer (ai/ package) — a v3.0 pillar missing from the diagram - Add Groovy (optional) to the Languages row — GroovyPsiAdapter + optional easy-api-groovy.xml dep ship in the plugin - Add To YAML to Field Conversion and the Convert Fields action list — YamlFieldFormatChannel is registered in plugin.xml
tangcent
force-pushed
the
docs/readme-sync-arch-and-yaml
branch
from
8e9b7f1 to
4b61fe3
Compare
Contributor
|
📦 Plugin has been packaged for this PR. You can download |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
The README's Architecture section described a
ExportOrchestrator → ClassExporter → ApiExporterpipeline, butApiExporterno longer exists in the v3.0 rewrite — the export surface is now theChannelextension point (registered inplugin.xml). This PR syncs the README with the actual code and adds two missing feature rows.Changes
Architecture section (content fix)
ApiExporter— the class doesn't exist. The v3.0 export abstraction isChannel(see Channel.kt), whose own KDoc says it "merges the formerApiChannel(export surface) and the survivingChannelSettingsExtension".Channelextension point as the bullet that convertsApiEndpointmodels to output formats — Markdown, Postman, cURL, HTTP Client, Hoppscotch (Beta). This is the v3.0 extensibility pillar (a new output target only needs aChannelimpl, no core edits).ClassExporterimplementations accurately: Spring MVC, Spring Cloud OpenFeign, JAX-RS, Spring Actuator, gRPC (perplugin.xml).ai/package is a v3.0 pillar (AI-assisted rule authoring) that was missing from the diagram.Feature rows (content fix)
Groovy (optional)—GroovyPsiAdapteris loaded byPsiLanguageAdapterLoaderwhen the Groovy plugin is present, andeasy-api-groovy.xmlis declared as an optional dependency inplugin.xml.To YAML—YamlFieldFormatChannelis registered inplugin.xmland honors@ConfigurationPropertiesprefix with Spring Bootapplication.ymlsemantics.ToYamlto the action list.Verification
./gradlew compileKotlin— N/A (docs-only change)Sync note
Companion PR opened on
easy-yapiwith the same content changes; branding (channel list, plugin name) preserved perSYNC.md§4.3 (IV-C).