documentation is in english and text/markdown

also specify application/hal+json for everything else

Author: thefringeninja

src/SqlStreamStore.HAL.Tests/StreamAppendTests.cs

@@ -186,7 +186,7 @@ public async Task wrong_expected_version(int[] expectedVersions)
             {
                 response.StatusCode.ShouldBe(HttpStatusCode.Conflict);
                 response.Content.Headers.ContentType.ShouldBe(new MediaTypeHeaderValue(
-                    Constants.Headers.ContentTypes.HalJson));
+                    Constants.MediaTypes.HalJson));
             }
             var page = await _fixture.StreamStore.ReadStreamForwards(StreamId, 0, int.MaxValue);
 
@@ -250,7 +250,7 @@ public async Task malformed_request_body(string malformedRequest)
                 {
                     Content = new StringContent(malformedRequest)
                     {
-                        Headers = { ContentType = new MediaTypeHeaderValue(Constants.Headers.ContentTypes.HalJson) }
+                        Headers = { ContentType = new MediaTypeHeaderValue(Constants.MediaTypes.HalJson) }
                     }
                 }))
             {

src/SqlStreamStore.HAL.Tests/StreamDeleteTests.cs

@@ -57,7 +57,7 @@ public async Task wrong_expected_version(int expectedVersion)
             {
                 response.StatusCode.ShouldBe(HttpStatusCode.Conflict);
                 response.Content.Headers.ContentType.ShouldBe(new MediaTypeHeaderValue(
-                    Constants.Headers.ContentTypes.HalJson));
+                    Constants.MediaTypes.HalJson));
             }
 
             var page = await _fixture.StreamStore.ReadStreamForwards(StreamId, 0, 1);

src/SqlStreamStore.HAL.Tests/StreamMetadataTests.cs

@@ -214,7 +214,7 @@ public async Task set_wrong_expected_version(int[] expectedVersions)
             {
                 response.StatusCode.ShouldBe(HttpStatusCode.Conflict);
                 response.Content.Headers.ContentType.ShouldBe(new MediaTypeHeaderValue(
-                    Constants.Headers.ContentTypes.HalJson));
+                    Constants.MediaTypes.HalJson));
             }
 
             var page = await _fixture.StreamStore.ReadStreamForwards($"$${StreamId}", 0, int.MaxValue);

src/SqlStreamStore.HAL/Constants.cs

@@ -2,6 +2,13 @@ namespace SqlStreamStore.HAL
 {
     internal static class Constants
     {
+        public static class MediaTypes
+        {
+            public const string TextMarkdown = "text/markdown; charset=UTF-8";
+            public const string HalJson = "application/hal+json";
+            public const string Any = "*/*";
+        }
+
         public static class Headers
         {
             public const string ExpectedVersion = "SSS-ExpectedVersion";
@@ -11,13 +18,6 @@ public static class Headers
             public const string ETag = "ETag";
             public const string IfNoneMatch = "If-None-Match";
             public const string CacheControl = "Cache-Control";
-
-            public static class ContentTypes
-            {
-                public const string Json = "application/json";
-                public const string HalJson = "application/hal+json";
-                public const string Any = "*/*";
-            }
         }
 
         public static class Relations

src/SqlStreamStore.HAL/HttpContextExtensions.cs

@@ -70,7 +70,7 @@ private static async Task WriteHalResponse(HttpContext context, Response respons
         {
             context.Response.StatusCode = response.StatusCode;
 
-            context.Response.ContentType = Constants.Headers.ContentTypes.HalJson;
+            context.Response.ContentType = Constants.MediaTypes.HalJson;
 
             foreach(var header in response.Headers)
             {

src/SqlStreamStore.HAL/Links.cs

@@ -63,15 +63,21 @@ public Link[] ToHalLinks()
                 var (rel, href, title) = _links[i];
                 var resolvedHref = $"{_relativePathToRoot}{href}";
 
-                links[i] = new Link(rel, resolvedHref, title, replaceParameters: false);
+                links[i] = new Link(rel, resolvedHref, title, replaceParameters: false)
+                {
+                    Type = Constants.MediaTypes.HalJson
+                };
             }
 
             links[_links.Count] = new Link(
                 Constants.Relations.Curies,
                 $"{_relativePathToRoot}docs/{{rel}}",
+                "Documentation",
                 replaceParameters: false)
             {
-                Name = Constants.Relations.StreamStorePrefix
+                Name = Constants.Relations.StreamStorePrefix,
+                HrefLang = "en",
+                Type = Constants.MediaTypes.TextMarkdown
             };
 
             return links;

src/SqlStreamStore.HAL/SqlStreamStoreHalMiddleware.cs

@@ -41,14 +41,14 @@ public static class SqlStreamStoreHalMiddleware
         {
             var accept = context.Request.GetAcceptHeaders();
 
-            return accept.Any(header => header == Constants.Headers.ContentTypes.HalJson
-                                        || header == Constants.Headers.ContentTypes.Any)
+            return accept.Any(header => header == Constants.MediaTypes.HalJson
+                                        || header == Constants.MediaTypes.Any)
                 ? next()
                 : context.WriteResponse(new Response(new HALResponse(new
                     {
                         type = "Not Acceptable",
                         title = "Not Acceptable",
-                        detail = $"The server only understands {Constants.Headers.ContentTypes.HalJson}."
+                        detail = $"The server only understands {Constants.MediaTypes.HalJson}."
                     }),
                     406));
         };