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