Allow using a response reference in the list of responses

[jacob-pro]

First of all this updates the Responses struct to have:

pub responses: BTreeMap<String, RefOr<Response>>,

Which should now correctly match the way the OpenAPI specs work:

      responses:
        '200':
          description: Success
        '400':
          "$ref": "#/components/responses/BadRequest"

And then it enables you to use a reference in the path macro:

    responses: (
        (status = 200, description = "Success"),
        (status = 400, response = crate::BadRequestResponse),
    )

where crate::BadRequestResponse is a type that implements ToResponse and is used in:

#[openapi(
    components(
        responses(
            crate::BadRequestResponse,
        )
    ),
)]

(Note I had to use response instead of just ref since it is a reserved keyword)

This should close #300

[jacob-pro]

Hey @juhaku - please can you let me know what you think of this?

[juhaku]

Hey @juhaku - please can you let me know what you think of this?

Hi @jacob-pro I will try to check this out today / tomorrow. I am bit busy during these days unfortunately. Thanks for patience. 🙂 .

I took a quick look and overall looks quite good. One thing I am wondering whether the response_ref should actually just be a response. This would work as well as a first go. But with response we could introduce possibility to inline the response as well.

Also the Parse implementation is currently implemented to ResponseValue struct. But the response could also be changed to an enum like.

enum Response {
  Value(ResponseValue),
  Ref(ResponseRef),
}

[jacob-pro]

@juhaku No problem, thanks for all the quick responses!

I have updated the PR as requested - hopefully I have understood correctly?

[juhaku]

Looks good, awesome 🥇

[juhaku]

I have updated the PR as requested - hopefully I have understood correctly?

Yeah pretty much yes 🙂