Add "title" in each item when generating OpenAPI schema

[cueckoo]

Originally opened by @zzxwill in cuelang/cue#612

I call openapi.Gen to generate OpenAPI schema from a .cue file. Is it possible to add title filed in each item, along with description and type? Thanks.

• .cue file.

#parameter: {
        // +usage=Which image would you like to use for your service
        // +short=i
        image: string

        // +usage=Commands to run in the container
        cmd?: [...string]

        // +usage=Which port do you want customer traffic sent to
        // +short=p
        port: *80 | int
        // +usage=Define arguments by using environment variables
        env?: [...{
                // +usage=Environment variable name
                name: string
                // +usage=The value of the environment variable
                value?: string
                // +usage=Specifies a source the value of this var should come from
                valueFrom?: {
                        // +usage=Selects a key of a secret in the pod's namespace
                        secretKeyRef: {
                                // +usage=The name of the secret in the pod's namespace to select from
                                name: string
                                // +usage=The key of the secret to select from. Must be a valid secret key
                                key: string
                        }
                }
        }]
        // +usage=Number of CPU units for the service, like `0.5` (0.5 CPU core), `1` (1 CPU core)
        cpu?: string
}

• generated OpenAPI schema

{
   "openapi": "3.0.0",
   "info": {
      "title": "Generated by cue.",
      "version": "no version"
   },
   "paths": {},
   "components": {
      "schemas": {
         "parameter": {
            "type": "object",
            "required": [
               "image",
               "port"
            ],
            "properties": {
               "cmd": {
                  "description": "+usage=Commands to run in the container",
                  "type": "array",
                  "items": {
                     "type": "string"
                  }
               },
               "env": {
                  "description": "+usage=Define arguments by using environment variables",
                  "type": "array",
                  "items": {
                     "type": "object",
                     "required": [
                        "name"
                     ],
                     "properties": {
                        "name": {
                           "description": "+usage=Environment variable name",
                           "type": "string"
                        },
                        "value": {
                           "description": "+usage=The value of the environment variable",
                           "type": "string"
                        },
                        "valueFrom": {
                           "description": "+usage=Specifies a source the value of this var should come from",
                           "type": "object",
                           "required": [
                              "secretKeyRef"
                           ],
                           "properties": {
                              "secretKeyRef": {
                                 "description": "+usage=Selects a key of a secret in the pod's namespace",
                                 "type": "object",
                                 "required": [
                                    "name",
                                    "key"
                                 ],
                                 "properties": {
                                    "name": {
                                       "description": "+usage=The name of the secret in the pod's namespace to select from",
                                       "type": "string"
                                    },
                                    "key": {
                                       "description": "+usage=The key of the secret to select from. Must be a valid secret key",
                                       "type": "string"
                                    }
                                 }
                              }
                           }
                        }
                     }
                  }
               },
               "image": {
                  "description": "+usage=Which image would you like to use for your service\n+short=i",
                  "type": "string"
               },
               "port": {
                  "description": "+usage=Which port do you want customer traffic sent to\n+short=p",
                  "type": "integer",
                  "default": 80
               },
               "cpu": {
                  "description": "+usage=Number of CPU units for the service, like `0.5` (0.5 CPU core), `1` (1 CPU core)",
                  "type": "string"
               }
            }
         }
      }
   }
}

More background:
I intend to call form-render to automatically render forms based on the generated OpenAPI json schema, but it required title field for each item, along with description and type, like the example as below.

"properties": {
               "cmd": {
                  "description": "+usage=Commands to run in the container",
                  "type": "array",
                  "title": "cmd",      # newly added
                  "items": {
                     "type": "string"
                  }
               },
...

[myitcv]

@zzxwill apologies, this definitely slipped through the cracks!

Is this still a requirement from your perspective? If so, please feel free to raise an issue with a feature request.

[zzxwill]

Yes. Currently I add the title myself based on the json.

[myitcv]

@zzxwill just to confirm, the value of the title field would be the key associated with that value in the properties map?

[zzxwill]

Correct.

[myitcv]

So this is more a convenience then, because that information is already accessible in an iteration the containing struct?

[zzxwill]

Correct.