Drop /v1 from API namespace, because it suggests API versioning should be done this way

Author: bkoelman

docs/internals/queries.md

@@ -29,7 +29,7 @@ Processing a request involves the following steps:
 To get a sense of what this all looks like, let's look at an example query string:
 
 ```
-/api/v1/blogs?
+/api/blogs?
   include=owner,posts.comments.author&
   filter=has(posts)&
   sort=count(posts)&

docs/usage/options.md

@@ -55,8 +55,8 @@ options.UseRelativeLinks = true;
   "relationships": {
      "author": {
        "links": {
-         "self": "/api/v1/articles/4309/relationships/author",
-         "related": "/api/v1/articles/4309/author"
+         "self": "/articles/4309/relationships/author",
+         "related": "/articles/4309/author"
        }
      }
   }

docs/usage/routing.md

@@ -11,10 +11,10 @@ You can add a namespace to all URLs by specifying it at startup.
 
 ```c#
 // Program.cs
-builder.Services.AddJsonApi<AppDbContext>(options => options.Namespace = "api/v1");
+builder.Services.AddJsonApi<AppDbContext>(options => options.Namespace = "api/shopping");
 ```
 
-Which results in URLs like: https://yourdomain.com/api/v1/people
+Which results in URLs like: https://yourdomain.com/api/shopping/articles
 
 ## Default routing convention
 
@@ -66,14 +66,14 @@ It is possible to override the default routing convention for an auto-generated
 ```c#
 // Auto-generated
 [DisableRoutingConvention]
-[Route("v1/custom/route/summaries-for-orders")]
+[Route("custom/route/summaries-for-orders")]
 partial class OrderSummariesController
 {
 }
 
 // Hand-written
 [DisableRoutingConvention]
-[Route("v1/custom/route/lines-in-order")]
+[Route("custom/route/lines-in-order")]
 public class OrderLineController : JsonApiController<OrderLine, int>
 {
     public OrderLineController(IJsonApiOptions options, IResourceGraph resourceGraph,

src/Examples/JsonApiDotNetCoreExample/Program.cs

@@ -60,7 +60,7 @@ static void ConfigureServices(WebApplicationBuilder builder)
     {
         builder.Services.AddJsonApi<AppDbContext>(options =>
         {
-            options.Namespace = "api/v1";
+            options.Namespace = "api";
             options.UseRelativeLinks = true;
             options.IncludeTotalResourceCount = true;
             options.SerializerOptions.WriteIndented = true;

src/Examples/JsonApiDotNetCoreExample/Properties/launchSettings.json

@@ -12,15 +12,15 @@
     "IIS Express": {
       "commandName": "IISExpress",
       "launchBrowser": false,
-      "launchUrl": "api/v1/todoItems",
+      "launchUrl": "api/todoItems",
       "environmentVariables": {
         "ASPNETCORE_ENVIRONMENT": "Development"
       }
     },
     "Kestrel": {
       "commandName": "Project",
       "launchBrowser": false,
-      "launchUrl": "api/v1/todoItems",
+      "launchUrl": "api/todoItems",
       "applicationUrl": "https://localhost:44340;http://localhost:14140",
       "environmentVariables": {
         "ASPNETCORE_ENVIRONMENT": "Development"

src/Examples/NoEntityFrameworkExample/Program.cs

@@ -10,7 +10,7 @@
 string? connectionString = GetConnectionString(builder.Configuration);
 builder.Services.AddNpgsql<AppDbContext>(connectionString);
 
-builder.Services.AddJsonApi(options => options.Namespace = "api/v1", resources: resourceGraphBuilder => resourceGraphBuilder.Add<WorkItem, int>());
+builder.Services.AddJsonApi(options => options.Namespace = "api", resources: resourceGraphBuilder => resourceGraphBuilder.Add<WorkItem, int>());
 
 builder.Services.AddResourceService<WorkItemService>();
 

src/Examples/NoEntityFrameworkExample/Properties/launchSettings.json

@@ -12,15 +12,15 @@
     "IIS Express": {
       "commandName": "IISExpress",
       "launchBrowser": true,
-      "launchUrl": "api/v1/workItems",
+      "launchUrl": "api/workItems",
       "environmentVariables": {
         "ASPNETCORE_ENVIRONMENT": "Development"
       }
     },
     "Kestrel": {
       "commandName": "Project",
       "launchBrowser": true,
-      "launchUrl": "api/v1/workItems",
+      "launchUrl": "api/workItems",
       "applicationUrl": "https://localhost:44349;http://localhost:14149",
       "environmentVariables": {
         "ASPNETCORE_ENVIRONMENT": "Development"

src/JsonApiDotNetCore/Configuration/IJsonApiOptions.cs

@@ -15,7 +15,7 @@ public interface IJsonApiOptions
     /// </summary>
     /// <example>
     /// <code><![CDATA[
-    /// options.Namespace = "api/v1";
+    /// options.Namespace = "api/shopping";
     /// ]]></code>
     /// </example>
     string? Namespace { get; }
@@ -64,8 +64,8 @@ public interface IJsonApiOptions
     ///   "relationships": {
     ///      "author": {
     ///        "links": {
-    ///          "self": "/api/v1/articles/4309/relationships/author",
-    ///          "related": "/api/v1/articles/4309/author"
+    ///          "self": "/api/shopping/articles/4309/relationships/author",
+    ///          "related": "/api/shopping/articles/4309/author"
     ///        }
     ///      }
     ///   }

test/JsonApiDotNetCoreTests/IntegrationTests/AtomicOperations/Creating/AtomicCreateResourceTests.cs

@@ -501,7 +501,7 @@ public async Task Cannot_create_resource_for_href_element()
                 new
                 {
                     op = "add",
-                    href = "/api/v1/musicTracks"
+                    href = "/api/musicTracks"
                 }
             }
         };

test/JsonApiDotNetCoreTests/IntegrationTests/AtomicOperations/Deleting/AtomicDeleteResourceTests.cs

@@ -334,7 +334,7 @@ public async Task Cannot_delete_resource_for_href_element()
                 new
                 {
                     op = "remove",
-                    href = "/api/v1/musicTracks/1"
+                    href = "/api/musicTracks/1"
                 }
             }
         };

test/JsonApiDotNetCoreTests/IntegrationTests/AtomicOperations/Updating/Relationships/AtomicAddToToManyRelationshipTests.cs

@@ -244,7 +244,7 @@ public async Task Cannot_add_for_href_element()
                 new
                 {
                     op = "add",
-                    href = "/api/v1/musicTracks/1/relationships/performers"
+                    href = "/api/musicTracks/1/relationships/performers"
                 }
             }
         };

test/JsonApiDotNetCoreTests/IntegrationTests/AtomicOperations/Updating/Relationships/AtomicRemoveFromToManyRelationshipTests.cs

@@ -243,7 +243,7 @@ public async Task Cannot_remove_for_href_element()
                 new
                 {
                     op = "remove",
-                    href = "/api/v1/musicTracks/1/relationships/performers"
+                    href = "/api/musicTracks/1/relationships/performers"
                 }
             }
         };

test/JsonApiDotNetCoreTests/IntegrationTests/AtomicOperations/Updating/Relationships/AtomicReplaceToManyRelationshipTests.cs

@@ -278,7 +278,7 @@ public async Task Cannot_replace_for_href_element()
                 new
                 {
                     op = "update",
-                    href = "/api/v1/musicTracks/1/relationships/performers"
+                    href = "/api/musicTracks/1/relationships/performers"
                 }
             }
         };

test/JsonApiDotNetCoreTests/IntegrationTests/AtomicOperations/Updating/Relationships/AtomicUpdateToOneRelationshipTests.cs

@@ -531,7 +531,7 @@ public async Task Cannot_create_for_href_element()
                 new
                 {
                     op = "update",
-                    href = "/api/v1/musicTracks/1/relationships/ownedBy"
+                    href = "/api/musicTracks/1/relationships/ownedBy"
                 }
             }
         };

test/JsonApiDotNetCoreTests/IntegrationTests/AtomicOperations/Updating/Resources/AtomicUpdateResourceTests.cs

@@ -620,7 +620,7 @@ public async Task Cannot_update_resource_for_href_element()
                 new
                 {
                     op = "update",
-                    href = "/api/v1/musicTracks/1"
+                    href = "/api/musicTracks/1"
                 }
             }
         };

test/NoEntityFrameworkTests/WorkItemTests.cs

@@ -45,7 +45,7 @@ await RunOnDatabaseAsync(async dbContext =>
             await dbContext.SaveChangesAsync();
         });
 
-        const string route = "/api/v1/workItems";
+        const string route = "/api/workItems";
 
         // Act
         (HttpResponseMessage httpResponse, Document responseDocument) = await ExecuteGetAsync<Document>(route);
@@ -71,7 +71,7 @@ await RunOnDatabaseAsync(async dbContext =>
             await dbContext.SaveChangesAsync();
         });
 
-        string route = $"/api/v1/workItems/{workItem.StringId}";
+        string route = $"/api/workItems/{workItem.StringId}";
 
         // Act
         (HttpResponseMessage httpResponse, Document responseDocument) = await ExecuteGetAsync<Document>(route);
@@ -110,7 +110,7 @@ public async Task Can_create_WorkItem()
             }
         };
 
-        const string route = "/api/v1/workItems/";
+        const string route = "/api/workItems/";
 
         // Act
         (HttpResponseMessage httpResponse, Document responseDocument) = await ExecutePostAsync<Document>(route, requestBody);
@@ -140,7 +140,7 @@ await RunOnDatabaseAsync(async dbContext =>
             await dbContext.SaveChangesAsync();
         });
 
-        string route = $"/api/v1/workItems/{workItem.StringId}";
+        string route = $"/api/workItems/{workItem.StringId}";
 
         // Act
         (HttpResponseMessage httpResponse, string responseDocument) = await ExecuteDeleteAsync<string>(route);