Generate OAS3 as code #174

rgreinho · 2024-12-28T19:45:04Z

Leverages utoipa to generate the OAS3.

Changes:

Splits /ratings and /pipelines.
Moves schemas to schema.rs.
Adds OAS 3.1 from Axum.
Adds OAS 3.0, down-converted from the OAS 3.1.
Regenerates the bnaclient.
Updates the Justfile.
Makes enums not optional.
Uses APIErrors struct for errors.
Adds ApiError examples for each support HTTP status (400, 401, 403, 404).
Adds ErrorResponses enum to group all errors.

Signed-off-by: Rémy Greinhofer [email protected]

lambdas/src/core/resource/cities/endpoint.rs

lambdas/src/core/resource/pipelines/endpoint.rs

robahtou · 2024-12-30T15:52:00Z

lambdas/src/core/resource/ratings/endpoint.rs

-) -> Result<(StatusCode, Json<Value>), ExecutionError> {
-    post_ratings_analysis_adaptor(bna_pipeline)
+#[utoipa::path(
+  post,


should this have a request body for the POST request?

It totally should! I completely missed it 😱

robahtou · 2024-12-30T15:53:58Z

noticed that many of the endpoints have: page_size & page. Can these be it's own component schema and use a reference?

robahtou · 2024-12-30T15:56:56Z

going over the response errors. Can you make them their own schema? For example,

components:
  responses:
    BadRequest:
      description: The request was formatted incorrectly or missing required parameters.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/APIError'
...

Then,

 /cities:
    get:
      responses:
        '400':
          $ref: '#/components/responses/BadRequest'

something like that?

rgreinho · 2024-12-30T16:16:58Z

going over the response errors. Can you make them their own schema? For example,

components:
  responses:
    BadRequest:
      description: The request was formatted incorrectly or missing required parameters.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/APIError'
...

Then,

 /cities:
    get:
      responses:
        '400':
          $ref: '#/components/responses/BadRequest'

something like that?

I think the generator considers them as custom objects and therefore inlines them. This is because I had to created custom examples for each one with the specific error codes and messages.

rgreinho · 2024-12-30T20:07:53Z

noticed that many of the endpoints have: page_size & page. Can these be it's own component schema and use a reference?

Done ✅

Leverages `utoipa` to generate the OAS3. Changes: - Splits `/ratings` and `/pipelines`. - Moves schemas to schema.rs. - Adds OAS 3.1 from Axum. - Adds OAS 3.0, down-converted from the OAS 3.1. - Regenerates the bnaclient. - Updates the Justfile. - Makes enums not optional. - Uses APIErrors struct for errors. - Adds ApiError examples for each support HTTP status (400, 401, 403, 404). - Adds ErrorResponses enum to group all errors. - Updates Hurl tests. Signed-off-by: Rémy Greinhofer <[email protected]>

rgreinho self-assigned this Dec 28, 2024

pull-request-size bot added the size/XXL Extra Extra Large (1000+ lines of changes) label Dec 28, 2024

rgreinho force-pushed the utoipa branch from 952fdfd to b88c8ec Compare December 28, 2024 20:19