swagger-api / swagger-api/swagger-codegen

how to ignore api or property

Open
#9,039 2 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Mustache
Stars
17.8k
Forks
6k
PR merge metrics
No merged PRs in 30d

Description

I got a task to add some annotation/ extension , on API level and on parameter level, which mark the swagger to ignore it and not generate it (not to generate at the java outputs). Any ideas how can it done?

paths: /productOffering: get: galit-ignore: tags: - "ProductOffering" description: | This service retrieves product offering details . operationId: "getProductOfferingsDetails" parameters: - name: "productOfferingId" in: "query"….

I want that the swagger won't generate the productOffering.

Thanks, Galit

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

No source file, test, or entry point is named. Start by tracing how the Swagger definition is parsed and how Java outputs are generated, then determine the supported way to mark an operation or parameter as ignored; done means the requested API or property is absent from generated Java output.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
api, tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
15/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.