Including an $ref in infoObject.description

[andrew....@shopify.com]

Hi there,

I was wondering if it is possible to use $ref to a definition inside info Object.description.

I need to include some descriptive information at the beginning of the spec file that defines the parameters of the defined object.  Rather than manually create a table using GFM markdown I would like to simply include the defined object using $ref.

Regards,

Andrew

[Ron Ratovsky]

At the moment, description does not support $ref.

--
You received this message because you are subscribed to the Google Groups "Swagger" group.
To unsubscribe from this group and stop receiving emails from it, send an email to swagger-swaggers...@googlegroups.com.
For more options, visit https://groups.google.com/d/optout.

[Andrew Johnston]

Thanks for your reply Ron - really appreciated!

Do you think it would be possible to use a patterned field, as part of info Object to define an object that references a definition.

I tried adding the x- field under info Object and referencing the defined Object but the object does not output to the UI.

Regards,

Andrew

To unsubscribe from this group and stop receiving emails from it, send an email to swagger-swaggersocket+unsub...@googlegroups.com.

For more options, visit https://groups.google.com/d/optout.

--
You received this message because you are subscribed to a topic in the Google Groups "Swagger" group.
To unsubscribe from this topic, visit https://groups.google.com/d/topic/swagger-swaggersocket/6L-AZ1TBAXc/unsubscribe.
To unsubscribe from this group and all its topics, send an email to swagger-swaggersocket+unsub...@googlegroups.com.

[Ron Ratovsky]

The UI doesn’t display extensions. You can add them anywhere, and even technically reference extensions (where references are allowed), but I think we currently don’t support it (meaning, it’s supported in the spec, not in the tool).

 

 

 

From: <swagger-sw...@googlegroups.com> on behalf of Andrew Johnston <andrew....@shopify.com>
Reply-To: "swagger-sw...@googlegroups.com" <swagger-sw...@googlegroups.com>
Date: Thursday, 20 October 2016 at 7:16
To: "swagger-sw...@googlegroups.com" <swagger-sw...@googlegroups.com>
Subject: Re: Including an $ref in infoObject.description

 

Thanks for your reply Ron - really appreciated!

 

Do you think it would be possible to use a patterned field, as part of info Object to define an object that references a definition.

 

I tried adding the x- field under info Object and referencing the defined Object but the object does not output to the UI.

 

Regards,

 

Andrew

On Thu, Oct 20, 2016 at 8:54 AM, Ron Ratovsky <r...@swagger.io> wrote:

At the moment, description does not support $ref.

 

 

From: <swagger-sw...@googlegroups.com> on behalf of "andrew....@shopify.com" <andrew....@shopify.com>
Reply-To: "swagger-sw...@googlegroups.com" <swagger-sw...@googlegroups.com>
Date: Wednesday, 19 October 2016 at 18:48
To: Swagger <swagger-sw...@googlegroups.com>
Subject: Including an $ref in infoObject.description

 

Hi there,

 

I was wondering if it is possible to use $ref to a definition inside info Object.description.

 

I need to include some descriptive information at the beginning of the spec file that defines the parameters of the defined object.  Rather than manually create a table using GFM markdown I would like to simply include the defined object using $ref.

 

Regards,

 

Andrew

 

 

--
You received this message because you are subscribed to the Google Groups "Swagger" group.

To unsubscribe from this group and stop receiving emails from it, send an email to swagger-swaggers...@googlegroups.com.

For more options, visit https://groups.google.com/d/optout.

--

You received this message because you are subscribed to a topic in the Google Groups "Swagger" group.
To unsubscribe from this topic, visit https://groups.google.com/d/topic/swagger-swaggersocket/6L-AZ1TBAXc/unsubscribe.

To unsubscribe from this group and all its topics, send an email to swagger-swaggers...@googlegroups.com.

For more options, visit https://groups.google.com/d/optout.

 

--

You received this message because you are subscribed to the Google Groups "Swagger" group.

To unsubscribe from this group and stop receiving emails from it, send an email to swagger-swaggers...@googlegroups.com.