Skip to content

Commit 83778c9

Browse files
committed
docs: fixes heading issues
Signed-off-by: Vincent Biret <[email protected]>
1 parent 55ef6dd commit 83778c9

File tree

1 file changed

+11
-4
lines changed

1 file changed

+11
-4
lines changed

docs/upgrade-guide-2.md

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -413,7 +413,7 @@ public class OpenApiComponents : IOpenApiSerializable, IOpenApiExtensible
413413
}
414414
```
415415

416-
#### Summary and Description alongside $ref
416+
### Summary and Description alongside $ref
417417

418418
Through the use of proxy objects in order to represent references, it is now possible to set the Summary and Description property on an object that is a reference. This was previously not possible.
419419

@@ -424,6 +424,13 @@ var parameter = new OpenApiParameterReference("id", hostdocument)
424424
};
425425
```
426426

427+
Once serialized results in:
428+
429+
```yaml
430+
$ref: id
431+
description: Customer Id
432+
```
433+
427434
### Use HTTP Method Object Instead of Enum
428435
429436
HTTP methods are now represented as objects instead of enums. This change enhances flexibility but requires updates to how HTTP methods are handled in your code.
@@ -443,7 +450,7 @@ OpenApiOperation operation = new OpenApiOperation
443450
};
444451
```
445452

446-
#### 3. References as Components
453+
### References as Components
447454

448455
References can now be used as components, allowing for more modular and reusable OpenAPI documents.
449456

@@ -465,9 +472,9 @@ OpenApiComponents components = new OpenApiComponents
465472
{
466473
Schemas = new Dictionary<string, IOpenApiSchema>
467474
{
468-
["MySchema"] = new OpenApiSchema
475+
["MySchema"] = new OpenApiSchemaReference("MyOtherSchema")
469476
{
470-
Reference = new OpenApiSchemaReference("MySchema")
477+
Description = "Other reusable schema from initial schema"
471478
}
472479
}
473480
};

0 commit comments

Comments
 (0)