chore: rename annotations to metadata

src/Microsoft.OpenApi/Interfaces/IOpenApiAnnotatable.cs → src/Microsoft.OpenApi/Interfaces/IMetadataContainer.cs

@@ -1,4 +1,4 @@
-// Copyright (c) Microsoft Corporation. All rights reserved.
+// Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT license.
 
 using System.Collections.Generic;
@@ -9,11 +9,11 @@ namespace Microsoft.OpenApi.Interfaces
     /// Represents an Open API element that can be annotated with
     /// non-serializable properties in a property bag. 
     /// </summary>
-    public interface IOpenApiAnnotatable
+    public interface IMetadataContainer
     {
         /// <summary>
         /// A collection of properties associated with the current OpenAPI element.
         /// </summary>
-        IDictionary<string, object> Annotations { get; set; }
+        IDictionary<string, object> Metadata { get; set; }
     }
 }

src/Microsoft.OpenApi/Models/OpenApiDocument.cs

@@ -24,7 +24,7 @@
     /// <summary>
     /// Describes an OpenAPI object (OpenAPI document). See: https://spec.openapis.org
     /// </summary>
-    public class OpenApiDocument : IOpenApiSerializable, IOpenApiExtensible, IOpenApiAnnotatable
+    public class OpenApiDocument : IOpenApiSerializable, IOpenApiExtensible, IMetadataContainer
     {
         /// <summary>
         /// Register components in the document to the workspace
@@ -109,7 +109,7 @@
         public IDictionary<string, IOpenApiExtension>? Extensions { get; set; } = new Dictionary<string, IOpenApiExtension>();
 
         /// <inheritdoc />
-        public IDictionary<string, object>? Annotations { get; set; }
+        public IDictionary<string, object>? Metadata { get; set; }
 
         /// <summary>
         /// Implements IBaseDocument
@@ -143,7 +143,7 @@
             Tags = document?.Tags != null ? new HashSet<OpenApiTag>(document.Tags, OpenApiTagComparer.Instance) : null;
             ExternalDocs = document?.ExternalDocs != null ? new(document?.ExternalDocs) : null;
             Extensions = document?.Extensions != null ? new Dictionary<string, IOpenApiExtension>(document.Extensions) : null;
-            Annotations = document?.Annotations != null ? new Dictionary<string, object>(document.Annotations) : null;
+            Metadata = document?.Metadata != null ? new Dictionary<string, object>(document.Metadata) : null;
             BaseUri = document?.BaseUri != null ? document.BaseUri : new(OpenApiConstants.BaseRegistryUri + Guid.NewGuid());
         }
 
@@ -239,7 +239,7 @@
         /// <summary>
         /// Serialize <see cref="OpenApiDocument"/> to OpenAPI object V2.0.
         /// </summary>
         public void SerializeAsV2(IOpenApiWriter writer)
         {
             Utils.CheckArgumentNull(writer);
 
@@ -533,7 +533,7 @@
             }
             else
             {
                 string relativePath = OpenApiConstants.ComponentsSegment + reference.Type.GetDisplayName() + "/" + reference.Id;
 
                 uriLocation = useExternal
                     ? Workspace?.GetDocumentId(reference.ExternalResource)?.OriginalString + relativePath

src/Microsoft.OpenApi/Models/OpenApiOperation.cs

@@ -16,7 +16,7 @@
     /// <summary>
     /// Operation Object.
     /// </summary>
-    public class OpenApiOperation : IOpenApiSerializable, IOpenApiExtensible, IOpenApiAnnotatable
+    public class OpenApiOperation : IOpenApiSerializable, IOpenApiExtensible, IMetadataContainer
     {
         /// <summary>
         /// Default value for <see cref="Deprecated"/>.
@@ -127,7 +127,7 @@
         public IDictionary<string, IOpenApiExtension>? Extensions { get; set; } = new Dictionary<string, IOpenApiExtension>();
 
         /// <inheritdoc />
-        public IDictionary<string, object>? Annotations { get; set; }
+        public IDictionary<string, object>? Metadata { get; set; }
 
         /// <summary>
         /// Parameterless constructor
@@ -153,7 +153,7 @@
             Security = operation.Security != null ? new List<OpenApiSecurityRequirement>(operation.Security) : null;
             Servers = operation.Servers != null ? new List<OpenApiServer>(operation.Servers) : null;
             Extensions = operation.Extensions != null ? new Dictionary<string, IOpenApiExtension>(operation.Extensions) : null;
-            Annotations = operation.Annotations != null ? new Dictionary<string, object>(operation.Annotations) : null;
+            Metadata = operation.Metadata != null ? new Dictionary<string, object>(operation.Metadata) : null;
         }
 
         /// <summary>
@@ -229,7 +229,7 @@
         /// <summary>
         /// Serialize <see cref="OpenApiOperation"/> to Open Api v2.0.
         /// </summary>
         public void SerializeAsV2(IOpenApiWriter writer)
         {
             Utils.CheckArgumentNull(writer);
 

test/Microsoft.OpenApi.Tests/Models/OpenApiDocumentTests.cs

@@ -92,7 +92,7 @@
             {
                 Version = "1.0.0"
             },
-            Annotations = new Dictionary<string, object> { { "key1", "value" } },
+            Metadata = new Dictionary<string, object> { { "key1", "value" } },
             Components = TopLevelReferencingComponents
         };
 
@@ -102,7 +102,7 @@
             {
                 Version = "1.0.0"
             },
-            Annotations = new Dictionary<string, object> { { "key1", "value" } },
+            Metadata = new Dictionary<string, object> { { "key1", "value" } },
             Components = TopLevelSelfReferencingComponentsWithOtherProperties
         };
 
@@ -112,7 +112,7 @@
             {
                 Version = "1.0.0"
             },
-            Annotations = new Dictionary<string, object> { { "key1", "value" } },
+            Metadata = new Dictionary<string, object> { { "key1", "value" } },
             Components = TopLevelSelfReferencingComponents
         };
 
@@ -489,7 +489,7 @@
                     }
                 }
             },
-            Annotations = new Dictionary<string, object> { { "key1", "value" } },
+            Metadata = new Dictionary<string, object> { { "key1", "value" } },
             Components = AdvancedComponentsWithReference
         };
 
@@ -865,7 +865,7 @@
                     }
                 }
             },
-            Annotations = new Dictionary<string, object> { { "key1", "value" } },
+            Metadata = new Dictionary<string, object> { { "key1", "value" } },
             Components = AdvancedComponents
         };
 
@@ -1024,7 +1024,7 @@
                     }
                 }
             },
-            Annotations = new Dictionary<string, object> { { "key1", "value" } },
+            Metadata = new Dictionary<string, object> { { "key1", "value" } },
             Components = AdvancedComponents
         };
 
@@ -1324,7 +1324,7 @@
                     }
                 }
             },
-            Annotations = new Dictionary<string, object> { { "key1", "value" } },
+            Metadata = new Dictionary<string, object> { { "key1", "value" } },
             Components = AdvancedComponents
         };
 
@@ -1830,7 +1830,7 @@
         {
             var baseDocument = new OpenApiDocument
             {
-                Annotations = new Dictionary<string, object>
+                Metadata = new Dictionary<string, object>
                 {
                     ["key1"] = "value1",
                     ["key2"] = 2
@@ -1839,15 +1839,15 @@
 
             var actualDocument = new OpenApiDocument(baseDocument);
 
-            Assert.Equal(baseDocument.Annotations["key1"], actualDocument.Annotations["key1"]);
+            Assert.Equal(baseDocument.Metadata["key1"], actualDocument.Metadata["key1"]);
 
-            baseDocument.Annotations["key1"] = "value2";
+            baseDocument.Metadata["key1"] = "value2";
 
-            Assert.NotEqual(baseDocument.Annotations["key1"], actualDocument.Annotations["key1"]);
+            Assert.NotEqual(baseDocument.Metadata["key1"], actualDocument.Metadata["key1"]);
         }
 
         [Fact]
         public void SerializeExamplesDoesNotThrowNullReferenceException()
         {
             OpenApiDocument doc = new OpenApiDocument
             {

test/Microsoft.OpenApi.Tests/Models/OpenApiOperationTests.cs

@@ -84,7 +84,7 @@ public class OpenApiOperationTests
                     Description = "serverDescription"
                 }
             },
-            Annotations = new Dictionary<string, object> { { "key1", "value1" }, { "key2", 2 } },
+            Metadata = new Dictionary<string, object> { { "key1", "value1" }, { "key2", 2 } },
         };
 
         private static OpenApiOperation _advancedOperationWithTagsAndSecurity => new()
@@ -844,7 +844,7 @@ public void OpenApiOperationCopyConstructorWithAnnotationsSucceeds()
         {
             var baseOperation = new OpenApiOperation
             {
-                Annotations = new Dictionary<string, object>
+                Metadata = new Dictionary<string, object>
                 {
                     ["key1"] = "value1",
                     ["key2"] = 2
@@ -853,11 +853,11 @@ public void OpenApiOperationCopyConstructorWithAnnotationsSucceeds()
 
             var actualOperation = new OpenApiOperation(baseOperation);
 
-            Assert.Equal(baseOperation.Annotations["key1"], actualOperation.Annotations["key1"]);
+            Assert.Equal(baseOperation.Metadata["key1"], actualOperation.Metadata["key1"]);
 
-            baseOperation.Annotations["key1"] = "value2";
+            baseOperation.Metadata["key1"] = "value2";
 
-            Assert.NotEqual(baseOperation.Annotations["key1"], actualOperation.Annotations["key1"]);
+            Assert.NotEqual(baseOperation.Metadata["key1"], actualOperation.Metadata["key1"]);
         }
     }
 }

test/Microsoft.OpenApi.Tests/PublicApi/PublicApi.approved.txt

@@ -199,9 +199,9 @@ namespace Microsoft.OpenApi.Extensions
 namespace Microsoft.OpenApi.Interfaces
 {
     public interface IDiagnostic { }
-    public interface IOpenApiAnnotatable
+    public interface IMetadataContainer
     {
-        System.Collections.Generic.IDictionary<string, object> Annotations { get; set; }
+        System.Collections.Generic.IDictionary<string, object> Metadata { get; set; }
     }
     public interface IOpenApiElement { }
     public interface IOpenApiExtensible : Microsoft.OpenApi.Interfaces.IOpenApiElement
@@ -706,17 +706,17 @@ namespace Microsoft.OpenApi.Models
         public void SerializeAsV3(Microsoft.OpenApi.Writers.IOpenApiWriter writer) { }
         public void SerializeAsV31(Microsoft.OpenApi.Writers.IOpenApiWriter writer) { }
     }
-    public class OpenApiDocument : Microsoft.OpenApi.Interfaces.IOpenApiAnnotatable, Microsoft.OpenApi.Interfaces.IOpenApiElement, Microsoft.OpenApi.Interfaces.IOpenApiExtensible, Microsoft.OpenApi.Interfaces.IOpenApiSerializable
+    public class OpenApiDocument : Microsoft.OpenApi.Interfaces.IMetadataContainer, Microsoft.OpenApi.Interfaces.IOpenApiElement, Microsoft.OpenApi.Interfaces.IOpenApiExtensible, Microsoft.OpenApi.Interfaces.IOpenApiSerializable
     {
         public OpenApiDocument() { }
         public OpenApiDocument(Microsoft.OpenApi.Models.OpenApiDocument? document) { }
-        public System.Collections.Generic.IDictionary<string, object>? Annotations { get; set; }
         public System.Uri BaseUri { get; }
         public Microsoft.OpenApi.Models.OpenApiComponents? Components { get; set; }
         public System.Collections.Generic.IDictionary<string, Microsoft.OpenApi.Interfaces.IOpenApiExtension>? Extensions { get; set; }
         public Microsoft.OpenApi.Models.OpenApiExternalDocs? ExternalDocs { get; set; }
         public Microsoft.OpenApi.Models.OpenApiInfo Info { get; set; }
         public System.Uri? JsonSchemaDialect { get; set; }
+        public System.Collections.Generic.IDictionary<string, object>? Metadata { get; set; }
         public Microsoft.OpenApi.Models.OpenApiPaths Paths { get; set; }
         public System.Collections.Generic.IList<Microsoft.OpenApi.Models.OpenApiSecurityRequirement>? Security { get; set; }
         public System.Collections.Generic.IList<Microsoft.OpenApi.Models.OpenApiServer>? Servers { get; set; }
@@ -894,17 +894,17 @@ namespace Microsoft.OpenApi.Models
         public void SerializeAsV3(Microsoft.OpenApi.Writers.IOpenApiWriter writer) { }
         public void SerializeAsV31(Microsoft.OpenApi.Writers.IOpenApiWriter writer) { }
     }
-    public class OpenApiOperation : Microsoft.OpenApi.Interfaces.IOpenApiAnnotatable, Microsoft.OpenApi.Interfaces.IOpenApiElement, Microsoft.OpenApi.Interfaces.IOpenApiExtensible, Microsoft.OpenApi.Interfaces.IOpenApiSerializable
+    public class OpenApiOperation : Microsoft.OpenApi.Interfaces.IMetadataContainer, Microsoft.OpenApi.Interfaces.IOpenApiElement, Microsoft.OpenApi.Interfaces.IOpenApiExtensible, Microsoft.OpenApi.Interfaces.IOpenApiSerializable
     {
         public const bool DeprecatedDefault = false;
         public OpenApiOperation() { }
         public OpenApiOperation(Microsoft.OpenApi.Models.OpenApiOperation operation) { }
-        public System.Collections.Generic.IDictionary<string, object>? Annotations { get; set; }
         public System.Collections.Generic.IDictionary<string, Microsoft.OpenApi.Models.Interfaces.IOpenApiCallback>? Callbacks { get; set; }
         public bool Deprecated { get; set; }
         public string? Description { get; set; }
         public System.Collections.Generic.IDictionary<string, Microsoft.OpenApi.Interfaces.IOpenApiExtension>? Extensions { get; set; }
         public Microsoft.OpenApi.Models.OpenApiExternalDocs? ExternalDocs { get; set; }
+        public System.Collections.Generic.IDictionary<string, object>? Metadata { get; set; }
         public string? OperationId { get; set; }
         public System.Collections.Generic.IList<Microsoft.OpenApi.Models.Interfaces.IOpenApiParameter>? Parameters { get; set; }
         public Microsoft.OpenApi.Models.Interfaces.IOpenApiRequestBody? RequestBody { get; set; }