github.com/josephspurrier/go-swagger@v0.2.1-0.20221129144919-1f672a142a00/fixtures/codegen/todolist.url.simple.yml (about)

     1  swagger: '2.0'
     2  info:
     3    version: "1.0.0"
     4    title: Private to-do list
     5    description: |
     6      A very simple api description that makes a json only API to submit to do's.
     7  
     8  produces:
     9    - application/json
    10  
    11  consumes:
    12    - application/json
    13  
    14  paths:
    15    /singleValuePath/{siString}/{siInt}/{siInt32}/{siInt64}/{siFloat}/{siFloat32}/{siFloat64}/{siBool}:
    16      get:
    17        operationId: simplePathParams
    18        summary: all possible single value path parameters
    19        description: Used to see if a codegen can render all the possible parameter variations for a header param
    20        tags:
    21          - testcgen
    22        parameters:
    23          - name: siString
    24            in: path
    25            type: string
    26            description: a simple string
    27            required: true
    28            minLength: 5
    29            maxLength: 50
    30            pattern: "[A-Z][\\w-]+"
    31          - name: siInt
    32            in: path
    33            type: integer
    34            description: an integer  property
    35            required: true
    36            multipleOf: 2
    37            minimum: 8
    38            exclusiveMinimum: true
    39            maximum: 100
    40            exclusiveMaximum: true
    41          - name: siInt32
    42            in: path
    43            type: integer
    44            format: int32
    45            description: an int32 integer property
    46            required: true
    47            multipleOf: 2
    48            minimum: 8
    49            exclusiveMinimum: true
    50            maximum: 100
    51            exclusiveMaximum: true
    52          - name: siInt64
    53            in: path
    54            type: integer
    55            format: int64
    56            description: an int64 integer property
    57            multipleOf: 2
    58            minimum: 8
    59            exclusiveMinimum: true
    60            maximum: 100
    61            exclusiveMaximum: true
    62            required: true
    63          - name: siFloat
    64            in: path
    65            type: number
    66            description: a float property
    67            required: true
    68            multipleOf: 1.5
    69            minimum: 3
    70            exclusiveMinimum: true
    71            maximum: 100
    72            exclusiveMaximum: true
    73          - name: siFloat32
    74            in: path
    75            type: number
    76            format: float
    77            description: a float32 float property
    78            required: true
    79            multipleOf: 1.5
    80            minimum: 3
    81            exclusiveMinimum: true
    82            maximum: 100
    83            exclusiveMaximum: true
    84          - name: siFloat64
    85            in: path
    86            type: number
    87            format: double
    88            description: a float64 float property
    89            multipleOf: 1.5
    90            minimum: 3
    91            exclusiveMinimum: true
    92            maximum: 100
    93            exclusiveMaximum: true
    94            required: true
    95          - name: siBool
    96            in: path
    97            type: boolean
    98            description: a boolean property
    99            required: true
   100  
   101        responses:
   102          default:
   103            description: Generic Error
   104          200:
   105            description: Task list result
   106            schema:
   107              $ref: "#/definitions/Task"
   108  
   109    /singleValueQuery/{id}:
   110      get:
   111        operationId: simpleQueryParams
   112        summary: all possible single value query parameters
   113        description: Used to see if a codegen can render all the possible parameter variations for a query param
   114        tags:
   115          - testcgen
   116        parameters:
   117          - name: id
   118            in: path
   119            type: integer
   120            format: int32
   121            description: The id of the task
   122            required: true
   123            minimum: 1
   124          - name: siString
   125            in: query
   126            type: string
   127            description: a simple string
   128            required: true
   129            minLength: 5
   130            maxLength: 50
   131            pattern: "[A-Z][\\w-]+"
   132          - name: siInt
   133            in: query
   134            type: integer
   135            description: an integer  property
   136            multipleOf: 2
   137            minimum: 8
   138            exclusiveMinimum: true
   139            maximum: 100
   140            exclusiveMaximum: true
   141          - name: siInt32
   142            in: query
   143            type: integer
   144            format: int32
   145            description: an int32 integer property
   146            multipleOf: 2
   147            minimum: 8
   148            exclusiveMinimum: true
   149            maximum: 100
   150            exclusiveMaximum: true
   151          - name: siInt64
   152            in: query
   153            type: integer
   154            format: int64
   155            description: an int64 integer property
   156            multipleOf: 2
   157            minimum: 8
   158            exclusiveMinimum: true
   159            maximum: 100
   160            exclusiveMaximum: true
   161            required: true
   162          - name: siFloat
   163            in: query
   164            type: number
   165            description: a float property
   166            multipleOf: 1.5
   167            minimum: 3
   168            exclusiveMinimum: true
   169            maximum: 100
   170            exclusiveMaximum: true
   171          - name: siFloat32
   172            in: query
   173            type: number
   174            format: float
   175            description: a float32 float property
   176            multipleOf: 1.5
   177            minimum: 3
   178            exclusiveMinimum: true
   179            maximum: 100
   180            exclusiveMaximum: true
   181          - name: siFloat64
   182            in: query
   183            type: number
   184            format: double
   185            description: a float64 float property
   186            multipleOf: 1.5
   187            minimum: 3
   188            exclusiveMinimum: true
   189            maximum: 100
   190            exclusiveMaximum: true
   191            required: true
   192          - name: siBool
   193            in: query
   194            type: boolean
   195            description: a boolean property
   196            required: true
   197  
   198        responses:
   199          default:
   200            description: Generic Error
   201          200:
   202            description: Task list result
   203            schema:
   204              $ref: "#/definitions/Task"
   205  
   206    /arrayValueQuery/{id}:
   207      get:
   208        operationId: arrayQueryParams
   209        summary: all possible array value query parameters
   210        description: Used to see if a codegen can render all the possible parameter variations for a array query param
   211        tags:
   212          - testcgen
   213        parameters:
   214          - name: id
   215            in: path
   216            type: integer
   217            format: int32
   218            description: The id of the task
   219            required: true
   220            minimum: 1
   221          - name: siString
   222            in: query
   223            type: array
   224            items:
   225              minLength: 5
   226              maxLength: 50
   227              pattern: "[A-Z][\\w-]+"
   228              type: string
   229            description: a simple string array
   230            required: true
   231            minItems: 5
   232            maxItems: 50
   233            collectionFormat: csv
   234          - name: siNested
   235            in: query
   236            type: array
   237            items:
   238              collectionFormat: pipes
   239              type: array
   240              items:
   241                collectionFormat: csv
   242                type: array
   243                items:
   244                  minLength: 5
   245                  maxLength: 50
   246                  pattern: "[A-Z][\\w-]+"
   247                  type: string
   248            description: a simple string array
   249            required: true
   250            minItems: 5
   251            maxItems: 50
   252            collectionFormat: multi
   253          - name: siInt
   254            in: query
   255            description: an integer array property
   256            type: array
   257            minItems: 5
   258            maxItems: 50
   259            collectionFormat: pipes
   260            items:
   261              type: integer
   262              multipleOf: 2
   263              minimum: 8
   264              exclusiveMinimum: true
   265              maximum: 100
   266              exclusiveMaximum: true
   267          - name: siInt32
   268            in: query
   269            description: an int32 integer array property
   270            type: array
   271            minItems: 5
   272            maxItems: 50
   273            collectionFormat: tsv
   274            items:
   275              type: integer
   276              format: int32
   277              multipleOf: 2
   278              minimum: 8
   279              exclusiveMinimum: true
   280              maximum: 100
   281              exclusiveMaximum: true
   282          - name: siInt64
   283            in: query
   284            description: an int64 integer array property
   285            type: array
   286            minItems: 5
   287            maxItems: 50
   288            collectionFormat: ssv
   289            items:
   290              type: integer
   291              format: int64
   292              multipleOf: 2
   293              minimum: 8
   294              exclusiveMinimum: true
   295              maximum: 100
   296              exclusiveMaximum: true
   297            required: true
   298          - name: siFloat
   299            in: query
   300            description: a float array property
   301            type: array
   302            minItems: 5
   303            maxItems: 50
   304            collectionFormat: multi
   305            items:
   306              type: number
   307              multipleOf: 1.5
   308              minimum: 3
   309              exclusiveMinimum: true
   310              maximum: 100
   311              exclusiveMaximum: true
   312          - name: siFloat32
   313            in: query
   314            description: a float32 float array property
   315            type: array
   316            minItems: 5
   317            maxItems: 50
   318            items:
   319              type: number
   320              format: float
   321              multipleOf: 1.5
   322              minimum: 3
   323              exclusiveMinimum: true
   324              maximum: 100
   325              exclusiveMaximum: true
   326          - name: siFloat64
   327            in: query
   328            description: a float64 float array property
   329            type: array
   330            minItems: 5
   331            maxItems: 50
   332            collectionFormat: pipes
   333            items:
   334              type: number
   335              format: double
   336              multipleOf: 1.5
   337              minimum: 3
   338              exclusiveMinimum: true
   339              maximum: 100
   340              exclusiveMaximum: true
   341            required: true
   342          - name: siBool
   343            description: a boolean array property
   344            in: query
   345            type: array
   346            minItems: 5
   347            maxItems: 50
   348            collectionFormat: ssv
   349            items:
   350              type: boolean
   351            required: true
   352        responses:
   353          default:
   354            description: Generic Error
   355          200:
   356            description: Task list result
   357            schema:
   358              $ref: "#/definitions/Task"
   359  
   360  definitions:
   361    Task:
   362      title: A Task object
   363      description: |
   364        This describes a task. Tasks require a content property to be set.
   365      required:
   366        - content
   367      type: object
   368      properties:
   369        id:
   370          title: the unique id of the task
   371          description: |
   372            This id property is autogenerated when a task is created.
   373          type: integer
   374          format: int64
   375          readOnly: true
   376        content:
   377          title: The content of the task
   378          description: |
   379            Task content can contain [GFM](https://help.github.com/articles/github-flavored-markdown/).
   380          type: string
   381          minLength: 5
   382        completed:
   383          title: when true this task is completed
   384          type: boolean
   385        creditcard:
   386          title: the credit card format usage
   387          type: string
   388          format: creditcard
   389        createdAt:
   390          title: task creation time
   391          type: string
   392          format: date-time
   393          readOnly: true
   394  
   395