René's URL Explorer Experiment

{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"Consider returning reference type from `AddComponent` API","articleBody":"The `AddComponent` API currently returns a boolean that indicates if the addition of the component to the document registry succeeded.\n\nIt would be nice if the API returned a reference to the item that was just constructed. In an M.A.OpenAPI transformer, I currently need to write:\n\n```csharp\noptions.AddOperationTransformer((operation, context, cancellationToken) =\u003e\n{\n    var schemaService = context.ApplicationServices.GetRequiredKeyedService\u003cIOpenApiSchemaService\u003e(context.DocumentName);\n    if (context.Description.RelativePath == \"error\")\n    {\n        var errorSchema = schemaService.GetOrCreateSchema(typeof(ProblemDetails));\n        context.Document.AddComponent(\"Error\", errorSchema);\n        operation.Responses[\"500\"] = new OpenApiResponse\n        {\n            Description = \"Error\",\n            Content =\n            {\n                [\"application/problem+json\"] = new OpenApiMediaType\n                {\n                    Schema = new OpenApiSchemaReference(\"Error\", context.Document),\n                },\n            },\n        };\n    }\n    return Task.CompletedTask;\n});\n```\n\nbut would like to write:\n\n```csharp\noptions.AddOperationTransformer((operation, context, cancellationToken) =\u003e\n{\n    var schemaService = context.ApplicationServices.GetRequiredKeyedService\u003cIOpenApiSchemaService\u003e(context.DocumentName);\n    if (context.Description.RelativePath == \"error\")\n    {\n        var errorSchema = schemaService.GetOrCreateSchema(typeof(ProblemDetails));\n        var insertedSchema = context.Document.AddComponent(\"Error\", errorSchema);\n        operation.Responses[\"500\"] = new OpenApiResponse\n        {\n            Description = \"Error\",\n            Content =\n            {\n                [\"application/problem+json\"] = new OpenApiMediaType\n                {\n                    Schema = insertedSchema,\n                },\n            },\n        };\n    }\n    return Task.CompletedTask;\n});\n```\n\ncc: @baywet I couldn't see if an API that did this existed already and figured I'd add the proposal.","author":{"url":"https://github.com/captainsafia","@type":"Person","name":"captainsafia"},"datePublished":"2025-02-24T16:53:43.000Z","interactionStatistic":{"@type":"InteractionCounter","interactionType":"https://schema.org/CommentAction","userInteractionCount":3},"url":"https://github.com/2162/OpenAPI.NET/issues/2162"}