Skip to content

fix(openapi): address remaining review comments — validation, content-type, schema, defaults#150

Merged
intel352 merged 2 commits intofeat/issue-79-openapifrom
copilot/sub-pr-134
Feb 24, 2026
Merged

fix(openapi): address remaining review comments — validation, content-type, schema, defaults#150
intel352 merged 2 commits intofeat/issue-79-openapifrom
copilot/sub-pr-134

Conversation

Copy link
Contributor

Copilot AI commented Feb 23, 2026

Several correctness and UX issues remained unresolved from prior review rounds on the OpenAPI module.

module/openapi.go

  • Body restoration: strings.NewReader(string(bodyBytes))bytes.NewReader(bodyBytes) — eliminates redundant alloc and prevents corruption of non-UTF-8 payloads
  • Invalid JSON → 400: json.Unmarshal errors were silently ignored; malformed bodies now produce a 400 with a descriptive message
  • YAML endpoint content-type: /openapi.yaml always returned application/yaml even for JSON source files; now detects source format by inspecting the first byte
  • swagger_ui.path normalization: paths without a leading / (e.g. "docs") were concatenated directly with base_path, producing invalid routes like /api/v1docs
  • Unknown Content-Type → 400: a Content-Type present in the request but absent from requestBody.content silently bypassed validation; now returns 400 listing the supported types

plugins/openapi/plugin.go

  • Factory defaults: OpenAPIConfig zero value left Validation.Request = false; factory now initializes it to true before applying overrides, matching documented behavior
  • Wiring hook logging: missing router was silently skipped with a misleading comment; now emits slog.Warn with the module name

schema/module_schema.go

  • router not required: removed Required: true — the wiring hook auto-detects the router when omitted
  • Dotted schema keys: validation.request, validation.response, swagger_ui.enabled, swagger_ui.path as flat bool/string fields don't map to the nested config structure; replaced with two FieldTypeJSON fields (validation, swagger_ui)

module/openapi_test.go

  • Added invalid_JSON sub-test to TestOpenAPIModule_RequestValidation_Body to cover the previously unguarded decode-error path

💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

…N errors, content-type, schema, defaults, logging

Co-authored-by: intel352 <77607+intel352@users.noreply.github.com>
Copilot AI changed the title [WIP] Add OpenAPI/Swagger spec module for auto-generating HTTP routes fix(openapi): address remaining review comments — validation, content-type, schema, defaults Feb 23, 2026
Copilot AI requested a review from intel352 February 23, 2026 21:13
@intel352 intel352 marked this pull request as ready for review February 24, 2026 00:18
@intel352 intel352 merged commit cee546a into feat/issue-79-openapi Feb 24, 2026
@intel352 intel352 deleted the copilot/sub-pr-134 branch February 24, 2026 00:18
intel352 added a commit that referenced this pull request Feb 24, 2026
…#134)

* feat: add OpenAPI/Swagger spec module for auto-generating HTTP routes (#79)

- Add openapi module type that parses OpenAPI v3 YAML/JSON specs
- Generate HTTP route handlers from spec paths with method mapping
- Add request validation against spec schemas (query params, body)
- Add optional Swagger UI and spec serving endpoints
- Add OpenAPI plugin for plugin-based registration
- Add comprehensive tests for spec parsing, routing, and validation
- Add example config and petstore spec in example/specs/

Closes #79

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

* fix: register openapi module type in schema and fix spec_file path resolution

- Add "openapi" to known module types and module schema registry
- Fix spec_file path in example config (relative to config dir, not project root)
- Add openapi plugin to test helpers allPlugins()

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

* fix(openapi): address review feedback — correctness, security, and performance improvements (#146)

* Initial plan

* fix: apply all review feedback to OpenAPI module

Co-authored-by: intel352 <77607+intel352@users.noreply.github.com>

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: intel352 <77607+intel352@users.noreply.github.com>

* fix(openapi): address remaining unresolved review comments on OpenAPI module (#149)

* Initial plan

* fix(openapi): document deferred spec_file validation and add enum scalar tests

Co-authored-by: intel352 <77607+intel352@users.noreply.github.com>

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: intel352 <77607+intel352@users.noreply.github.com>

* fix: add admin_test.go with corrected TestMergeInto_WithRealAdminConfig

Add admin/admin_test.go from main with the syntax error fixed:
TestMergeInto_WithRealAdminConfig was closed with `)` instead of `}`
and used 2-space indented brace in the inner if block, causing:
  expected statement, found ')'

This file doesn't exist on this branch (predates its addition to main)
but is needed so the PR's merge commit compiles and tests pass.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

* fix(openapi): address remaining review comments — validation, content-type, schema, defaults (#150)

* Initial plan

* fix(openapi): address all remaining review comments — body bytes, JSON errors, content-type, schema, defaults, logging

Co-authored-by: intel352 <77607+intel352@users.noreply.github.com>

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: intel352 <77607+intel352@users.noreply.github.com>

* fix(cmd): restore missing multiWorkflowAddr flag definition (#152)

* Initial plan

* fix(cmd): restore missing multiWorkflowAddr flag definition

Co-authored-by: intel352 <77607+intel352@users.noreply.github.com>

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: intel352 <77607+intel352@users.noreply.github.com>

* fix(openapi): harden body validation, determinism, and router wiring (#155)

* Initial plan

* fix(openapi): address review feedback from thread 3844286430

- Add configurable max body size limit (default 1 MiB) via http.MaxBytesReader to
  prevent DoS from arbitrarily large request bodies
- Use validateJSONValue() for request body validation to handle non-object root schemas
  (primitives, arrays) that were previously silently skipped
- Only register /openapi.yaml endpoint when source spec is YAML; JSON sources already
  served via /openapi.json
- Sort supportedContentTypes() output for deterministic error messages
- Remove /api/v1 from plugin schema DefaultConfig to match factory (empty) default
- Add server→router mapping in wireOpenAPIRoutes for consistent router discovery
  when openapi module depends on http.server instead of http.router directly
- Tests: add TestOpenAPIModule_JSONSourceNoYAMLEndpoint and TestOpenAPIModule_MaxBodySize

Co-authored-by: intel352 <77607+intel352@users.noreply.github.com>

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: intel352 <77607+intel352@users.noreply.github.com>

---------

Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>
Co-authored-by: Copilot <198982749+Copilot@users.noreply.github.com>
Co-authored-by: intel352 <77607+intel352@users.noreply.github.com>
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.

2 participants