Re: Creating other kinds of documentation besides API reference with Swagger

[Alexey Akimov]

 Thank you, Ron.


On Wednesday, May 17, 2017 at 10:05:36 PM UTC+2, Ron wrote:
>
> Yes. Take a look at the operationsSorter - 
> https://github.com/swagger-api/swagger-ui#parameters.
>
>  
>
>  
>
>  
>
> *From: *<swagger-sw...@googlegroups.com > on behalf of 
> Alexey Akimov <alexey...@gmail.com >
> *Reply-To: *"swagger-sw...@googlegroups.com " <
> swagger-sw...@googlegroups.com >
> *Date: *Wednesday, 17 May 2017 at 12:50
> *To: *Swagger <swagger-sw...@googlegroups.com >
> *Subject: *Re: Creating other kinds of documentation besides API 
> reference with Swagger
>
>  
>
> Ron,  
>
>  
>
> Is it also possible to specify operations order within each group (instead 
> of using the default alphabetical order)?
>
> On Tuesday, May 16, 2017 at 11:31:49 PM UTC+2, Ron wrote: 
>
> You can use tags to group operations, but that’s pretty much it. Of 
> course, as an OSS project, your abilities to customize are endless but 
> those would require code changes.
>
>  
>
>  
>
> -- 
> 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-swaggersocket+unsubscr...@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-swaggersocket+unsubscr...@googlegroups.com.
For more options, visit https://groups.google.com/d/optout.

Re: Creating other kinds of documentation besides API reference with Swagger

[Ron Ratovsky]

You can use tags to group operations, but that’s pretty much it. Of course, as 
an OSS project, your abilities to customize are endless but those would require 
code changes.

 

 

 

From: <swagger-swaggersocket@googlegroups.com> on behalf of Chris Hermansen 
<clherman...@gmail.com>
Reply-To: "swagger-swaggersocket@googlegroups.com" 
<swagger-swaggersocket@googlegroups.com>
Date: Wednesday, 10 May 2017 at 10:10
To: Swagger <swagger-swaggersocket@googlegroups.com>
Subject: Re: Creating other kinds of documentation besides API reference with 
Swagger

 

Thanks for the reply, Ron.

Rather than referring to external documents from the spec, I was thinking more 
along the lines of reorganizing the layout and annotating it to a greater 
degree.

For example as far as I can tell the Swagger UI shows all the JSON calls in 
alphabetical order, with explanatory text shown when a particular call is 
expanded. Is there a mechanism to instead group the calls in more of a 
"functional order", interspersing some text in the layout; or alternatively, 
grouping the calls in a "task oriented" order, that is, oriented toward 
accomplishing a sample task?

On Monday, May 8, 2017 at 3:32:30 PM UTC-7, Ron wrote: 

That’s out of scope for Swagger. You can link to external docs from different 
point in the spec, but the content there would be entirely controlled by you.

 

 

 

From: <swagger-sw...@googlegroups.com> on behalf of Chris Hermansen 
<clher...@gmail.com>
Reply-To: "swagger-sw...@googlegroups.com" <swagger-sw...@googlegroups.com>
Date: Monday, 8 May 2017 at 14:52
To: Swagger <swagger-sw...@googlegroups.com>
Subject: Creating other kinds of documentation besides API reference with 
Swagger

 

I am learning about Swagger, which seems quite wonderful generally, but I 
haven't yet found a discussion of how to make documentation other than an API 
reference.

In case I'm not being clear, I'm thinking of User Guide, which would explain 
how to use my API elements to accomplish user-centric tasks and would typically 
involve making a specific sequence of calls to API elements.

Can anyone offer some advice on this matter?

-- 
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-swaggersocket+unsubscr...@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-swaggersocket+unsubscr...@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-swaggersocket+unsubscr...@googlegroups.com.
For more options, visit https://groups.google.com/d/optout.

Re: Creating other kinds of documentation besides API reference with Swagger

[Ron Ratovsky]

That’s out of scope for Swagger. You can link to external docs from different 
point in the spec, but the content there would be entirely controlled by you.

 

 

 

From:  on behalf of Chris Hermansen 

Reply-To: "swagger-swaggersocket@googlegroups.com" 

Date: Monday, 8 May 2017 at 14:52
To: Swagger 
Subject: Creating other kinds of documentation besides API reference with 
Swagger

 

I am learning about Swagger, which seems quite wonderful generally, but I 
haven't yet found a discussion of how to make documentation other than an API 
reference.

In case I'm not being clear, I'm thinking of User Guide, which would explain 
how to use my API elements to accomplish user-centric tasks and would typically 
involve making a specific sequence of calls to API elements.

Can anyone offer some advice on this matter?

-- 
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-swaggersocket+unsubscr...@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-swaggersocket+unsubscr...@googlegroups.com.
For more options, visit https://groups.google.com/d/optout.