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: *<[email protected] <javascript:>> on behalf of Chris > Hermansen <[email protected] <javascript:>> > *Reply-To: *"[email protected] <javascript:>" < > [email protected] <javascript:>> > *Date: *Monday, 8 May 2017 at 14:52 > *To: *Swagger <[email protected] <javascript:>> > *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 [email protected] <javascript:>. > 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 [email protected]. For more options, visit https://groups.google.com/d/optout.
