openAPI specs with a schema format value of uuid prepends urn:uuid: to the value of a variable

[JaredAAT]

Given an openAPI spec like:

{
	"openapi": "3.0.3",
	"info": {
		"title": "Document Generation",
		"description": "Document Generation API",
		"version": "0.0.3"
	},
	"components": {
		"schemas": {
			"ErrorResponse": {
				"type": "object",
				"properties": {
					"message": {
						"type": "string"
					},
					"errors": {
						"type": "object"
					}
				}
			},
			"contactId": {
				"type": "string",
				"format": "uuid"
			},
			"pdfResponse": {
				"type": "string",
				"format": "binary"
			},
			"programmeId": {
				"type": "integer"
			}
		}
	},
	"paths": {
		"/pdf/soa/{contactId}/{programmeId}": {
			"get": {
				"summary": "Generates a Statement Of Achievement PDF",
				"description": "> **Produces a Statement Of Achievement PDF for a particular contact and programme**.\n\n### Authorization\n\n\nThis API endpoint is protected by Lambda Authorizer `Authenticated`\n\n\nThis API endpoint implements following Authorization types. Authorization is granted if one of the listed types is satisfied.\n* `- Resource owner`\n* `- Connected by programme registration`\n* `- Connected by organisation`\n",
				"operationId": "APIDocumentGeneration-uat-unitresultpdf",
				"parameters": [
					{
						"name": "contactId",
						"in": "path",
						"description": "The Contact ID of the contact a Statement Of Achievement PDF should be generated for",
						"required": true,
						"schema": {
							"$ref": "#/components/schemas/contactId"
						}
					},
					{
						"name": "programmeId",
						"in": "path",
						"description": "The Programme ID of the Statement Of Achievement PDF should be generated for",
						"required": true,
						"schema": {
							"$ref": "#/components/schemas/programmeId"
						}
					}
				],
				"tags": ["Document Generation"],
				"responses": {
					"200": {
						"description": "The Statement Of Achievement PDF",
						"content": {
							"application/pdf": {
								"schema": {
									"$ref": "#/components/schemas/pdfResponse"
								}
							}
						}
					},
					"400": {
						"description": "An error message",
						"content": {
							"application/json": {
								"schema": {
									"$ref": "#/components/schemas/ErrorResponse"
								}
							}
						}
					},
					"403": {
						"description": "Forbidden response",
						"content": {
							"application/json": {
								"schema": {
									"$ref": "#/components/schemas/ErrorResponse"
								}
							}
						}
					}
				}
			}
		}
	},
	"servers": [
		{
			"url": "/document-generation",
			"description": "The base URL"
		}
	],
	"tags": [
		{
			"name": "Document Generation",
			"description": "v0.0.3 - Libs API v8.6.12\n"
		}
	],
	"externalDocs": {
		"description": "Postman Collection V2"
	}
}

Where the schema for a contactId is a type of string with a format of uuid, it seems that running the openAPI through portman generates a postman collection containing path parameter values with "urn:uuid":

{
                  "disabled": false,
                  "description": {
                    "content": "(Required) The Contact ID of the contact a Statement Of Achievement PDF should be generated for",
                    "type": "text/plain"
                  },
                  "type": "any",
                  "value": "urn:uuid:623e721d-b1a8-4121-d8c9-b38159b064e9",
                  "key": "contactId"
                },

a straight up postman conversion sets the value to be:

{
                                    "disabled": false,
                                    "type": "any",
                                    "value": "<uuid>",
                                    "key": "contactId",
                                    "description": "(Required) The Contact ID of the contact a Statement Of Achievement PDF should be generated for"
                                },

Whilst i feel like generating the actual UUID is a good idea, i feel that prepending with urn:uuid is a mistake.

[ikenna]

Gentle bump on this one.

[ikenna]

PS: I worked around this by providing an example uuid in the spec.

[JaredAAT]

@ikenna you mean something like:

"components": {
  "schemas": {
    "contactId": {
      "type": "string",
      "format": "uuid"
      "example": "0e9d207a-1ad0-45ab-8b00-4cc0a435fcb2"
    },
}

[thim81]

FYI: We opened a small issue postmanlabs/openapi-to-postman#823 to get some info on why there is urn:uuid: in front of the generated UUID.