Enhancement of JSON Schema generation

[guersam]

I'm currently adapting the same command model for ChatGPT, utilizing it in two ways: one through an HTTP endpoint called by the ChatGPT plugin, and the other for direct use via the ChatGPT API.

Thanks to #2470, I've successfully generated a JSON schema. However, while experimenting with RC4, I identified two specific use cases that could be improved:

Eliminating the Need for an Intermediate HttpCodec

To generate a JSON Schema of a case class A, I currently need to wrap my schema with HttpCodec.content. A more straightforward method to directly convert Schema[A] to JsonSchema would be beneficial.

    OpenAPIGen
      .contentAsJsonSchema(
        HttpCodec.content[A](MediaType.application.json)(using inputSchema),
      )

EDIT: JsonSchema.fromZSchema does the job.

Enhanced Customization During Serialization

In RC4, the generated JsonSchema invariably includes the additionalProperties field in the serialized JSON. However, I'm looking to remove this field to minimize ChatGPT token usage. I currently do not have a clear interface design or idea for how to achieve this level of customization.

[987Nabil]

For directly creating JsonSchema without the need of an HttpCodec, you should be able to just call JsonSchema#fromZSchema

[guersam]

@987Nabil Thanks for fromZSchema!

Another use case is to transform a JsonSchema into a Java data type generated by protobuf. Currently I need to pollute zio.http.endpoint.openapi namespace to access SerializableJsonSchema or concrete JsonSchema variants.

I considered zio-schema-protobuf, but there's no guarantee that the inferred codec matches the desired protobuf spec. (e.g. the order of enum values)

[987Nabil]

@guersam I am working currently on openapi to endpoint code gen and want to work on protobuf next. I will try to solve this in this workflow

[guersam]

Another finding: Having OpenAPI.paths as a Map[OpenAPI.Path, OpenAPI.PathItem] results in the erasure of the order of path items. This leads to the rendered output being less coherent.

[jdegoes]

/bounty $200

For all issues raised herein.

[algora-pbc]

💎 $200 bounty created by ZIO
🙋 If you start working on this, comment /attempt #2549 along with your implementation plan
👉 To claim this bounty, submit a pull request that includes the text /claim #2549 somewhere in its body
📝 Before proceeding, please make sure you can receive payouts in your country
💵 Payment arrives in your account 2-5 days after the bounty is rewarded
💯 You keep 100% of the bounty award
🙏 Thank you for contributing to zio/zio-http!

👉 Add a bounty • Share on socials

Attempt	Started (GMT+0)	Solution
🟢 @987Nabil		#2661

[algora-pbc]

💡 @987Nabil submitted a pull request that claims the bounty. You can visit your bounty board to reward.

[algora-pbc]

🎉🎈 @987Nabil has been awarded $200! 🎈🎊

• Share on socials
• Give feedback