`openapiv3`: Custom Annotations

[aidandj]

🚀 Feature

Custom annotations allow overriding a variety of aspects of the generated code. Extension 1295 has been registered for v3 annotations.

I'll list a few common use cases, and we can prioritize and check them off as we go (moved to sub-issues).

Additionally something I'd like to explore, is referencing proto messages in annotations. For example, a custom error response code, with a custom schema, but instead of defining the schema with the custom annotations, reference a proto message.

      responses: {
        key: "207"
        value: {
          description: "Mixed response."
          schema: {
            proto_message: {ref: ".api.responses.v1.MixedResponse"}
          }
        }
      }

Please add a 👍 if this feature is useful/required for you.

[johanbrandhorst]

The last feature was something that I think v2 supported? But it was a bit fragile since you had to match the exact ref string directly.

[aidandj]

The last feature was something that I think v2 supported? But it was a bit fragile since you had to match the exact ref string directly.

It would be nice that this could be hardened. Maybe have a different value type for a message reference. So that we can error if the reference isn't found?