github.com/AngusLu/go-swagger@v0.28.0/fixtures/goparsing/meta/v2/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 meta 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  // TermsOfService:
    24  // there are no TOS at this moment, use at your own risk we take no responsibility
    25  //
    26  //     Schemes: http, https
    27  //     Host: localhost
    28  //     BasePath: /v2
    29  //     Version: 0.0.1
    30  //     License: MIT http://opensource.org/licenses/MIT
    31  //     Contact: John Doe<john.doe@example.com> http://john.doe.com
    32  //
    33  //     Consumes:
    34  //     - application/json
    35  //     - application/xml
    36  //
    37  //     Produces:
    38  //     - application/json
    39  //     - application/xml
    40  //
    41  //     Extensions:
    42  //     x-meta-value: value
    43  //     x-meta-array:
    44  //       - value1
    45  //       - value2
    46  //     x-meta-array-obj:
    47  //       - name: obj
    48  //         value: field
    49  //
    50  //     InfoExtensions:
    51  //     x-info-value: value
    52  //     x-info-array:
    53  //       - value1
    54  //       - value2
    55  //     x-info-array-obj:
    56  //       - name: obj
    57  //         value: field
    58  //
    59  //     Security:
    60  //     - api_key:
    61  //
    62  //     SecurityDefinitions:
    63  //     api_key:
    64  //          type: apiKey
    65  //          name: KEY
    66  //          in: header
    67  //     oauth2:
    68  //         type: oauth2
    69  //         authorizationUrl: /oauth2/auth
    70  //         tokenUrl: /oauth2/token
    71  //         in: header
    72  //         scopes:
    73  //           bla1: foo1
    74  //           bla2: foo2
    75  //         flow: accessCode
    76  //
    77  // swagger:meta
    78  package meta