Skip to content

Conversation

@moutonjeremy
Copy link
Member

Introduce OpenAPI YAML path configuration and support in the application, enhancing documentation capabilities. Update dependencies and include relevant documentation in README.

Copilot AI review requested due to automatic review settings September 29, 2025 07:37
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR introduces OpenAPI YAML specification support alongside the existing JSON format, enhancing the API documentation capabilities of the fiber-oapi library. The implementation adds comprehensive YAML support throughout the codebase while maintaining backward compatibility.

  • Adds OpenAPI YAML endpoint configuration and generation functionality
  • Updates dependency management to include yaml.v3 as a direct dependency
  • Extends authentication middleware to exclude YAML endpoints from authentication requirements

Reviewed Changes

Copilot reviewed 9 out of 10 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
types.go Adds OpenAPIYamlPath field to Config struct for YAML endpoint configuration
go.mod Promotes yaml.v3 from indirect to direct dependency
fiberoapi.go Implements YAML spec generation and routing with proper content-type handling
docs_test.go Extends test configuration to include YAML path testing
docs.go Adds YamlPath field to DocConfig struct for documentation configuration
conditional_auth.go Updates authentication middleware to exclude YAML endpoints
_examples/simple/main.go Demonstrates YAML configuration in example application
_examples/simple/go.mod Updates example dependencies for consistency
README.md Documents the new YAML configuration option

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

moutonjeremy and others added 3 commits September 29, 2025 09:37
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

Copilot reviewed 9 out of 11 changed files in this pull request and generated no new comments.


Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

@moutonjeremy moutonjeremy merged commit 942f90f into main Sep 29, 2025
4 checks passed
@moutonjeremy moutonjeremy deleted the feat/openapi-yaml branch September 29, 2025 07:40
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