github.com/kaisawind/go-swagger@v0.19.0/fixtures/goparsing/classification/doc.go (about)

     1  // Copyright 2015 go-swagger maintainers
     2  //
     3  // Licensed under the Apache License, Version 2.0 (the "License");
     4  // you may not use this file except in compliance with the License.
     5  // You may obtain a copy of the License at
     6  //
     7  //    http://www.apache.org/licenses/LICENSE-2.0
     8  //
     9  // Unless required by applicable law or agreed to in writing, software
    10  // distributed under the License is distributed on an "AS IS" BASIS,
    11  // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    12  // See the License for the specific language governing permissions and
    13  // limitations under the License.
    14  
    15  // Package classification Petstore API.
    16  //
    17  // the purpose of this application is to provide an application
    18  // that is using plain go code to define an API
    19  //
    20  // This should demonstrate all the possible comment annotations
    21  // that are available to turn go code into a fully compliant swagger 2.0 spec
    22  //
    23  // Terms Of Service:
    24  //
    25  // there are no TOS at this moment, use at your own risk we take no responsibility
    26  //
    27  //     Schemes: http, https
    28  //     Host: localhost
    29  //     BasePath: /v2
    30  //     Version: 0.0.1
    31  //     License: MIT http://opensource.org/licenses/MIT
    32  //     Contact: John Doe<john.doe@example.com> http://john.doe.com
    33  //
    34  //     Consumes:
    35  //     - application/json
    36  //     - application/xml
    37  //
    38  //     Produces:
    39  //     - application/json
    40  //     - application/xml
    41  //
    42  //     Extensions:
    43  //     x-meta-value: value
    44  //     x-meta-array:
    45  //       - value1
    46  //       - value2
    47  //     x-meta-array-obj:
    48  //       - name: obj
    49  //         value: field
    50  //
    51  //     InfoExtensions:
    52  //     x-info-value: value
    53  //     x-info-array:
    54  //       - value1
    55  //       - value2
    56  //     x-info-array-obj:
    57  //       - name: obj
    58  //         value: field
    59  //
    60  //     Security:
    61  //     - api_key:
    62  //
    63  //     SecurityDefinitions:
    64  //     api_key:
    65  //          type: apiKey
    66  //          name: KEY
    67  //          in: header
    68  //     oauth2:
    69  //         type: oauth2
    70  //         authorizationUrl: /oauth2/auth
    71  //         tokenUrl: /oauth2/token
    72  //         in: header
    73  //         scopes:
    74  //           bla1: foo1
    75  //           bla2: foo2
    76  //         flow: accessCode
    77  //
    78  // swagger:meta
    79  package classification