ThreeMammals/Ocelot

Hide FileConfiguration and OutputCache controller from Swagger

Open

#989 opened on Aug 13, 2019

View on GitHub
 (8 comments) (0 reactions) (1 assignee)C# (1,617 forks)batch import
AdministrationSwaggerbuggood first issuehelp wantedsmall effort

Repository metrics

Stars
 (8,137 stars)
PR merge metrics
 (Avg merge 44d 17h) (6 merged PRs in 30d)

Description

Expected Behavior / New Feature

I do not need to display FileConfigurationController and OutputCacheController in my swagger of API Geteway.

Actual Behavior / Motivation for New Feature

Screenshot_1

Steps to Reproduce the Problem

  1. Install-Package Ocelot -Version 13.5.2

How to hide/remove them?

Contributor guide

Research direction
Investigate how Ocelot registers its controllers and explore ways to exclude specific controllers from Swagger documentation using Swashbuckle or NSwag attributes or configuration.
Tech stack
csharp
Domain
apibackend
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Mostly clear
Prerequisites
C#ASP.NET CoreSwagger
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70