Schema as body (not in body)?

[Anthony Liatsis]

Hi is it possible to define a json schema as the body instead of a named parameter in the body of a POST request?

For example, if I had a User schema, can I define the request body as the user object instead of needing a 'user' parameter within the body?

Thanks in advance!

[Ron Ratovsky]

Unfortunately, I don’t follow the question. Can you clarify?

--
You received this message because you are subscribed to the Google Groups "Swagger" group.
To unsubscribe from this group and stop receiving emails from it, send an email to swagger-swaggers...@googlegroups.com.
For more options, visit https://groups.google.com/d/optout.

[Anthony Liatsis]

Hi, so for example:

I've seen Swagger docs use a schema as a parameter in the body like this :

paths:

  /user:

    post:

      summary: Create a User

      parameters:

        - name: user

          in: body

          required: true

          schema: 

            $ref: '#/definitions/User'

which means the POST request body must provide the user in the nested field `user` like this:
{

  user: {

    firstName: 'John',

    lastName: 'Smith'

  }

}

My question is if the User schema can define the body parameters itself without needing the nested object in the request body like this:

{

  firstName: 'John',

  lastName: 'Smith'

}

Thanks in advance!

To unsubscribe from this group and stop receiving emails from it, send an email to swagger-swaggersocket+unsub...@googlegroups.com.

[Ron Ratovsky]

How is your '#/definitions/User' defined?

To unsubscribe from this group and stop receiving emails from it, send an email to swagger-swaggers...@googlegroups.com.

For more options, visit https://groups.google.com/d/optout.

--

You received this message because you are subscribed to the Google Groups "Swagger" group.

To unsubscribe from this group and stop receiving emails from it, send an email to swagger-swaggers...@googlegroups.com.

[Anthony Liatsis]

For example:

definitions:

  User:

    type: object

    properties:

      firstName:

        type: string

        description: First name of the user

      lastName:

        type: string

        description: Last name of the user

To unsubscribe from this group and stop receiving emails from it, send an email to swagger-swaggersocket+unsub...@googlegroups.com.

For more options, visit https://groups.google.com/d/optout.

--
You received this message because you are subscribed to the Google Groups "Swagger" group.

To unsubscribe from this group and stop receiving emails from it, send an email to swagger-swaggersocket+unsub...@googlegroups.com.

[Ron Ratovsky]

 

Then there’s no problem. There’s nothing wrapping the request in another layer with the user property.

The name defined for the parameter doesn’t affect the input.

For example:

 

To unsubscribe from this group and stop receiving emails from it, send an email to swagger-swaggers...@googlegroups.com.

For more options, visit https://groups.google.com/d/optout.

--
You received this message because you are subscribed to the Google Groups "Swagger" group.

To unsubscribe from this group and stop receiving emails from it, send an email to swagger-swaggers...@googlegroups.com.

For more options, visit https://groups.google.com/d/optout.

--
You received this message because you are subscribed to the Google Groups "Swagger" group.

To unsubscribe from this group and stop receiving emails from it, send an email to swagger-swaggers...@googlegroups.com.

[Anthony Liatsis]

wow you are very correct!

I guess I was just getting thrown off by it being called a parameter and having a name.

Thanks for the help!

For example:

 

To unsubscribe from this group and stop receiving emails from it, send an email to swagger-swaggersocket+unsub...@googlegroups.com.

For more options, visit https://groups.google.com/d/optout.

--
You received this message because you are subscribed to the Google Groups "Swagger" group.

To unsubscribe from this group and stop receiving emails from it, send an email to swagger-swaggersocket+unsub...@googlegroups.com.

For more options, visit https://groups.google.com/d/optout.

--
You received this message because you are subscribed to the Google Groups "Swagger" group.

To unsubscribe from this group and stop receiving emails from it, send an email to swagger-swaggersocket+unsub...@googlegroups.com.

[Ron Ratovsky]

Yes, I’m often surprised by my level of correctness too! Just don’t tell others, to not raise their expectations ;)

 

Glad we got it sorted out, feel free to reach out again in the future.

For example:

 

To unsubscribe from this group and stop receiving emails from it, send an email to swagger-swaggers...@googlegroups.com.

For more options, visit https://groups.google.com/d/optout.

--
You received this message because you are subscribed to the Google Groups "Swagger" group.

To unsubscribe from this group and stop receiving emails from it, send an email to swagger-swaggers...@googlegroups.com.

For more options, visit https://groups.google.com/d/optout.

--
You received this message because you are subscribed to the Google Groups "Swagger" group.

To unsubscribe from this group and stop receiving emails from it, send an email to swagger-swaggers...@googlegroups.com.

For more options, visit https://groups.google.com/d/optout.

--
You received this message because you are subscribed to the Google Groups "Swagger" group.

To unsubscribe from this group and stop receiving emails from it, send an email to swagger-swaggers...@googlegroups.com.