Styjun

Is an "are" omitted in this sentence

How to win an all out war against ants

Why does BezierFunction not follow BezierCurve at npts>4?

A verb for when some rights are not violated?

HackerRank Implement Queue using two stacks Solution

(7 of 11: Fillomino) What is Pyramid Cult's Favorite Shape?

In MTG, was there ever a five-color deck that worked well?

How was the cosmonaut of the Soviet moon mission supposed to get back in the return vehicle?

Using Forstner bits instead of hole saws

Tikz intersecting nodes and fit boxes

Polygons crash kernel?

How do I safety check that there is no light in Darkroom / Darkbag?

Does WSL2 runs Linux in a virtual machine or alongside windows Kernel?

Export economy of Mars

Subverting the essence of fictional and/or religious entities; is it acceptable?

How to call made-up data?

Representation of the concatenation at the type level

A wiild aanimal, a cardinal direction, or a place by the water

Phase portrait of a system of differential equations

Is it uncompelling to continue the story with lower stakes?

How to design an effective polearm-bow hybrid?

On the expression "sun-down"

Can't understand an ACT practice problem: Triangle appears to be isosceles, why isn't the answer 7.3~ here?

Is law enforcement responsible for damages made by a search warrant?

Swagger reusing examples showing weird $$ref element

$ref tag in SwaggerHow to reuse example from another definition in swagger?Swagger - nested $ref not workingSwagger: How to get formatted example jsonHow can I set a description and an example in Swagger with Swagger annotations?Swagger external file $ref using URISwagger Editor not displaying $ref models in the Models sectionHow to remove the API definition URL under title in Swagger UI?$ref in response exampleSwagger Multiple Examples Not Showing

.everyoneloves__top-leaderboard:empty,.everyoneloves__mid-leaderboard:empty,.everyoneloves__bot-mid-leaderboard:empty margin-bottom:0;

0

I wrote a swagger specification Yaml file and in the components section I have:

examples:
 companyExample:
 company:
 id: uNiquEiD
 name: Company Name

I use this companyExample in the response as following:

example:
 $ref: '#/components/examples/companyExample'

Here is the output:

So what is this extra "$$ref": "#/components/examples/companyExample" is it a bug? How can I remove it?

swagger swagger-ui

share|improve this question

asked Mar 27 at 1:40

Ali ElkhateebAli Elkhateeb

64033 silver badges1313 bronze badges

add a comment | 

0

I wrote a swagger specification Yaml file and in the components section I have:

examples:
 companyExample:
 company:
 id: uNiquEiD
 name: Company Name

I use this companyExample in the response as following:

example:
 $ref: '#/components/examples/companyExample'

Here is the output:

So what is this extra "$$ref": "#/components/examples/companyExample" is it a bug? How can I remove it?

swagger swagger-ui

share|improve this question

asked Mar 27 at 1:40

Ali ElkhateebAli Elkhateeb

64033 silver badges1313 bronze badges

add a comment | 

I wrote a swagger specification Yaml file and in the components section I have:

examples:
 companyExample:
 company:
 id: uNiquEiD
 name: Company Name

I use this companyExample in the response as following:

example:
 $ref: '#/components/examples/companyExample'

Here is the output:

So what is this extra "$$ref": "#/components/examples/companyExample" is it a bug? How can I remove it?

swagger swagger-ui

share|improve this question

asked Mar 27 at 1:40

Ali ElkhateebAli Elkhateeb

64033 silver badges1313 bronze badges

examples:
 companyExample:
 company:
 id: uNiquEiD
 name: Company Name

example:
 $ref: '#/components/examples/companyExample'

share|improve this question

asked Mar 27 at 1:40

Ali ElkhateebAli Elkhateeb

64033 silver badges1313 bronze badges

share|improve this question

asked Mar 27 at 1:40

Ali ElkhateebAli Elkhateeb

64033 silver badges1313 bronze badges

asked Mar 27 at 1:40

Ali ElkhateebAli Elkhateeb

64033 silver badges1313 bronze badges

asked Mar 27 at 1:40

Ali ElkhateebAli Elkhateeb

64033 silver badges1313 bronze badges

1 Answer
1

active

oldest

votes

2

The example keyword (not to be confused with multiple exampleS) does not support $ref. The whole example value must be specified inline:

example:
 company:
 id: uNiquEiD
 name: Company Name

To $ref an example defined in #/components/examples, you'll need to use the examples keyword. examples can be used in parameters, request bodies, response bodies and response headers but NOT in schemas. In other words, examples can be used
alongside schema but not inside schema.

For instance, to $ref an example as a response example, you would use the following. Note that the example definition uses the value keyword to wrap the actual example value. (The example definition in your original question is not valid because of the missing value.)

 responses:
 '200':
 description: OK
 content:
 application/json:
 schema:
 $ref: '#/components/schemas/Company'
 examples:
 companyExample:
 $ref: '#/components/examples/companyExample'

components:
 examples:
 companyExample:
 summary: Sample company data
 value:
 # The actual example value begins here
 company:
 id: uNiquEiD
 name: Company Name

Note for Swagger UI users: Support for multiple examples is available in Swagger UI 3.23.0+ and Swagger Editor 3.6.31+.

share|improve this answer

edited Jul 1 at 8:28

answered Mar 27 at 12:44

HelenHelen

38k55 gold badges9090 silver badges148148 bronze badges

• 
  
  
  

  
  

  
  
  
  
  
  

  
  
  Hi @Helen, thanks for the info I didn't know rendering it is not implemented yet in Swagger UI.
  
  – Ali Elkhateeb
  Apr 1 at 3:17
  
  

  
  
  
  

add a comment | 

Your Answer

StackExchange.ifUsing("editor", function ()
StackExchange.using("externalEditor", function ()
StackExchange.using("snippets", function ()
StackExchange.snippets.init();
);
);
, "code-snippets");

StackExchange.ready(function()
var channelOptions =
tags: "".split(" "),
id: "1"
;
initTagRenderer("".split(" "), "".split(" "), channelOptions);

StackExchange.using("externalEditor", function()
// Have to fire editor after snippets, if snippets enabled
if (StackExchange.settings.snippets.snippetsEnabled)
StackExchange.using("snippets", function()
createEditor();
);

else
createEditor();

);

function createEditor()
StackExchange.prepareEditor(
heartbeatType: 'answer',
autoActivateHeartbeat: false,
convertImagesToLinks: true,
noModals: true,
showLowRepImageUploadWarning: true,
reputationToPostImages: 10,
bindNavPrevention: true,
postfix: "",
imageUploader:
brandingHtml: "Powered by u003ca class="icon-imgur-white" href="https://imgur.com/"u003eu003c/au003e",
contentPolicyHtml: "User contributions licensed under u003ca href="https://creativecommons.org/licenses/by-sa/3.0/"u003ecc by-sa 3.0 with attribution requiredu003c/au003e u003ca href="https://stackoverflow.com/legal/content-policy"u003e(content policy)u003c/au003e",
allowUrls: true
,
onDemand: true,
discardSelector: ".discard-answer"
,immediatelyShowMarkdownHelp:true
);



);

draft saved

draft discarded

Sign up or log in

StackExchange.ready(function ()
StackExchange.helpers.onClickDraftSave('#login-link');
);

Sign up using Google

Sign up using Facebook

Sign up using Email and Password

Post as a guest

Name

Email

Required, but never shown

StackExchange.ready(
function ()
StackExchange.openid.initPostLogin('.new-post-login', 'https%3a%2f%2fstackoverflow.com%2fquestions%2f55368560%2fswagger-reusing-examples-showing-weird-ref-element%23new-answer', 'question_page');

);

Post as a guest

Name

Email

Required, but never shown

2

The example keyword (not to be confused with multiple exampleS) does not support $ref. The whole example value must be specified inline:

example:
 company:
 id: uNiquEiD
 name: Company Name

To $ref an example defined in #/components/examples, you'll need to use the examples keyword. examples can be used in parameters, request bodies, response bodies and response headers but NOT in schemas. In other words, examples can be used
alongside schema but not inside schema.

For instance, to $ref an example as a response example, you would use the following. Note that the example definition uses the value keyword to wrap the actual example value. (The example definition in your original question is not valid because of the missing value.)

 responses:
 '200':
 description: OK
 content:
 application/json:
 schema:
 $ref: '#/components/schemas/Company'
 examples:
 companyExample:
 $ref: '#/components/examples/companyExample'

components:
 examples:
 companyExample:
 summary: Sample company data
 value:
 # The actual example value begins here
 company:
 id: uNiquEiD
 name: Company Name

Note for Swagger UI users: Support for multiple examples is available in Swagger UI 3.23.0+ and Swagger Editor 3.6.31+.

share|improve this answer

edited Jul 1 at 8:28

answered Mar 27 at 12:44

HelenHelen

38k55 gold badges9090 silver badges148148 bronze badges

• 
  
  
  

  
  

  
  
  
  
  
  

  
  
  Hi @Helen, thanks for the info I didn't know rendering it is not implemented yet in Swagger UI.
  
  – Ali Elkhateeb
  Apr 1 at 3:17
  
  

  
  
  
  

add a comment | 

2

The example keyword (not to be confused with multiple exampleS) does not support $ref. The whole example value must be specified inline:

example:
 company:
 id: uNiquEiD
 name: Company Name

To $ref an example defined in #/components/examples, you'll need to use the examples keyword. examples can be used in parameters, request bodies, response bodies and response headers but NOT in schemas. In other words, examples can be used
alongside schema but not inside schema.

For instance, to $ref an example as a response example, you would use the following. Note that the example definition uses the value keyword to wrap the actual example value. (The example definition in your original question is not valid because of the missing value.)

 responses:
 '200':
 description: OK
 content:
 application/json:
 schema:
 $ref: '#/components/schemas/Company'
 examples:
 companyExample:
 $ref: '#/components/examples/companyExample'

components:
 examples:
 companyExample:
 summary: Sample company data
 value:
 # The actual example value begins here
 company:
 id: uNiquEiD
 name: Company Name

Note for Swagger UI users: Support for multiple examples is available in Swagger UI 3.23.0+ and Swagger Editor 3.6.31+.

share|improve this answer

edited Jul 1 at 8:28

answered Mar 27 at 12:44

HelenHelen

38k55 gold badges9090 silver badges148148 bronze badges

• 
  
  
  

  
  

  
  
  
  
  
  

  
  
  Hi @Helen, thanks for the info I didn't know rendering it is not implemented yet in Swagger UI.
  
  – Ali Elkhateeb
  Apr 1 at 3:17
  
  

  
  
  
  

add a comment | 

The example keyword (not to be confused with multiple exampleS) does not support $ref. The whole example value must be specified inline:

example:
 company:
 id: uNiquEiD
 name: Company Name

To $ref an example defined in #/components/examples, you'll need to use the examples keyword. examples can be used in parameters, request bodies, response bodies and response headers but NOT in schemas. In other words, examples can be used
alongside schema but not inside schema.

For instance, to $ref an example as a response example, you would use the following. Note that the example definition uses the value keyword to wrap the actual example value. (The example definition in your original question is not valid because of the missing value.)

 responses:
 '200':
 description: OK
 content:
 application/json:
 schema:
 $ref: '#/components/schemas/Company'
 examples:
 companyExample:
 $ref: '#/components/examples/companyExample'

components:
 examples:
 companyExample:
 summary: Sample company data
 value:
 # The actual example value begins here
 company:
 id: uNiquEiD
 name: Company Name

Note for Swagger UI users: Support for multiple examples is available in Swagger UI 3.23.0+ and Swagger Editor 3.6.31+.

share|improve this answer

edited Jul 1 at 8:28

answered Mar 27 at 12:44

HelenHelen

38k55 gold badges9090 silver badges148148 bronze badges

example:
 company:
 id: uNiquEiD
 name: Company Name

 responses:
 '200':
 description: OK
 content:
 application/json:
 schema:
 $ref: '#/components/schemas/Company'
 examples:
 companyExample:
 $ref: '#/components/examples/companyExample'

components:
 examples:
 companyExample:
 summary: Sample company data
 value:
 # The actual example value begins here
 company:
 id: uNiquEiD
 name: Company Name

share|improve this answer

edited Jul 1 at 8:28

answered Mar 27 at 12:44

HelenHelen

38k55 gold badges9090 silver badges148148 bronze badges

answered Mar 27 at 12:44

HelenHelen

38k55 gold badges9090 silver badges148148 bronze badges

answered Mar 27 at 12:44

HelenHelen

38k55 gold badges9090 silver badges148148 bronze badges