You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/upgrade-guide-2.md
+11-4Lines changed: 11 additions & 4 deletions
Original file line number
Diff line number
Diff line change
@@ -413,7 +413,7 @@ public class OpenApiComponents : IOpenApiSerializable, IOpenApiExtensible
413
413
}
414
414
```
415
415
416
-
####Summary and Description alongside $ref
416
+
### Summary and Description alongside $ref
417
417
418
418
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.
419
419
@@ -424,6 +424,13 @@ var parameter = new OpenApiParameterReference("id", hostdocument)
424
424
};
425
425
```
426
426
427
+
Once serialized results in:
428
+
429
+
```yaml
430
+
$ref: id
431
+
description: Customer Id
432
+
```
433
+
427
434
### Use HTTP Method Object Instead of Enum
428
435
429
436
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
443
450
};
444
451
```
445
452
446
-
#### 3. References as Components
453
+
### References as Components
447
454
448
455
References can now be used as components, allowing for more modular and reusable OpenAPI documents.
449
456
@@ -465,9 +472,9 @@ OpenApiComponents components = new OpenApiComponents
0 commit comments