Swagger says"not a valid parameter defenition" -


i'm new swagger , appreciate direction on resources learning.

i have test project i'm putting , running issues.

i'm getting error saying "parameters" in "delete" block not valid. looks ok me i've seen in examples. apparently i'm missing something. ideas?

swagger: "2.0"  info:   version: "2"   title: title   description: provides services vacation rentals site   termsofservice: private   contact:     name: name     url: www.myurl.com     email: my@email.address   license:     name: mit     url: http://opensource.org/licenses/mit schemes:   - http host: myurl.com basepath: /api  paths:    /guestbook:     get:       summary: gets persons       description: returns list containing persons.       responses:         200:           description: list of posts           schema:             type: array             items:               required:                 - firstname               properties:                 firstname:                   type: string                 lastname:                   type: string                 email:                   type: string                 comment:                   type: string     post:       summary: adds comment guestbook       description: adds comment guestbook       parameters:         - name: firstname           in: formdata           required: true           type: string         - name: lastname           in: formdata           required: true           type: string         - name: email           in: formdata           required: true           type: string         - name: comment           in: formdata           required: true           type: string        responses:         201:           description: shows successful post         '405':           description: invalid input   /guestbook/{id}:     get:       summary: gets single post       description: returns single post       operationid: getpost       parameters:         - name: id           in: path           description: id of pet fetch           required: true           type: integer           format: int64       responses:         200:           description: list of posts           schema:             type: array             items:               required:                 - firstname               properties:                 id:                   type: number                 firstname:                   type: string                 lastname:                   type: string                 email:                   type: string                 comment:                   type: string     delete:       summary: removes post       description: removes post       operationid: deletepost       parameters:         - name: id           in: path       responses:         200:           description: post has been removed

you need describe id parameter in delete /guestbook/{id} operation did in get /guestbook/{id}.

delete:   summary: removes post   description: removes post   operationid: deletepost   parameters:     - name: id       in: path       description: id of pet fetch       required: true       type: integer       format: int64   responses:     200:       description: post has been removed

you can define parameter once operations of path /guestbook/{id}:

/guestbook/{id}:   parameters:     - name: id       in: path       description: id of pet fetch       required: true       type: integer       format: int64   get:     summary: gets single post     description: returns single post     operationid: getpost     responses:       200:         description: list of posts         schema:           type: array           items:             required:               - firstname             properties:               id:                 type: number               firstname:                 type: string               lastname:                 type: string               email:                 type: string               comment:                 type: string   delete:     summary: removes post     description: removes post     operationid: deletepost     responses:       200:         description: post has been removed

if need learn how write openapi (fka. swagger) specification files, can read writing openapi/swagger specification tutorial


Comments

Post a Comment

Popular posts from this blog

jOOQ update returning clause with Oracle -

according http://www.jooq.org/doc/3.8/manual/sql-building/sql-statements/update-statement/ jooq doesn't support returning clause in update statements databases except firebird , postgres. does know, still correct oracle jooq? according oracle's documentation, oracle db supports returning clase delete, insert, or update statements. incorrect manual you're right - manual wrong , should fixed: https://github.com/jooq/jooq/issues/5470 single row update returning jooq 3.8 added support single row update .. returning statements. internally, uses callablestatement , pl/sql block of form: begin update "my_table" set "my_table"."column" = 'xyz' "my_table"."id" = 1 returning "my_table"."id", "my_table"."column" ?, ?; ? := sql%rowcount; end; the relevant issue is: https://github.com/jooq/jooq/issues/5190 multi row update returning a...
Read more

java - Warning equals/hashCode on @Data annotation lombok with inheritance -

i have entity inherits other. on other hand, i'm using lombok project reduce boilerplate code, put @data annotation. annotation @data inheritance produces next warning: generating equals/hashcode implementation without call superclass, though class not extend java.lang.object. if intentional, add '@equalsandhashcode(callsuper=false)' type. is advisable add annotation @equalsandhashcode (callsuper = true) or @equalsandhashcode (callsuper = false) ? if not added, 1 callsuper=false or callsuper=true ? the default value false . 1 if don't specify , ignore warning. yes, recommended add @equalsandhashcode annotation on @data annotated classes extend else object. cannot tell if need true or false , depends on class hierarchy, , need examined on case-by-case basis. however, project or package, can configure in lombok.config call super methods if not direct subclass of object. lombok.equalsandhashcode.callsuper = call for configuration system ...
Read more

java - BasicPathUsageException: Cannot join to attribute of basic type -

i using java 8 jpa (hibernate 5.2.1). have clause works perfectly, until introduce clause make use foreign key table values too. i getting following error: basicpathusageexception: cannot join attribute of basic type i think problem related fact have join table, , not sure how create join using join table. employee - employee_category - category model (employee.java): @manytomany(cascade = cascadetype.all, fetch=fetchtype.eager) @jointable ( name="employee_category", joincolumns={ @joincolumn(name="emp_id", referencedcolumnname="id") }, inversejoincolumns={ @joincolumn(name="cat_id", referencedcolumnname="id") } ) private set<category> categories; model (category.java): @id private string id; jpa when introduce following code, fails error above (i think problem new piece of code): join<t, category> category = from.join("id"); predicates.add(criteriabuilder.like(category....
Read more