Merge pull request #842 from dunglas/rename_docs

Rename /doc to /docs

Author: dunglas

features/custom_identifier.feature

@@ -88,7 +88,7 @@ Feature: Using custom identifier on resource
       """
 
   Scenario: API doc is correctly generated
-    When I send a "GET" request to "/doc.jsonld"
+    When I send a "GET" request to "/docs.jsonld"
     Then the response status code should be 200
     And the response should be in JSON
     And the hydra class "CustomIdentifierDummy" exist

features/custom_normalized.feature

@@ -89,7 +89,7 @@ Feature: Using custom normalized entity
     """
 
   Scenario: API doc is correctly generated
-    When I send a "GET" request to "/doc.jsonld"
+    When I send a "GET" request to "/docs.jsonld"
     Then the response status code should be 200
     And the response should be in JSON
     And the hydra class "CustomNormalizedDummy" exist

features/custom_writable_identifier.feature

@@ -89,8 +89,8 @@ Feature: Using custom writable identifier on resource
     }
     """
 
-  Scenario: API doc is correctly generated
-    When I send a "GET" request to "/doc.jsonld"
+  Scenario: API docs are correctly generated
+    When I send a "GET" request to "/docs.jsonld"
     Then the response status code should be 200
     And the response should be in JSON
     And the hydra class "CustomWritableIdentifierDummy" exist

features/hydra/doc.feature renamed to features/hydra/docs.feature

@@ -5,15 +5,15 @@ Feature: Documentation support
 
   Scenario: Checks that the Link pointing to the Hydra documentation is set
     Given I send a "GET" request to "/"
-    Then the header "Link" should be equal to '<http://example.com/doc.jsonld>; rel="http://www.w3.org/ns/hydra/core#apiDocumentation"'
+    Then the header "Link" should be equal to '<http://example.com/docs.jsonld>; rel="http://www.w3.org/ns/hydra/core#apiDocumentation"'
 
   Scenario: Retrieve the API vocabulary
-    Given I send a "GET" request to "/doc.jsonld"
+    Given I send a "GET" request to "/docs.jsonld"
     Then the response status code should be 200
     And the response should be in JSON
     And the header "Content-Type" should be equal to "application/ld+json; charset=utf-8"
     # Context
-    And the JSON node "@context.@vocab" should be equal to "http://example.com/doc.jsonld#"
+    And the JSON node "@context.@vocab" should be equal to "http://example.com/docs.jsonld#"
     And the JSON node "@context.hydra" should be equal to "http://www.w3.org/ns/hydra/core#"
     And the JSON node "@context.rdf" should be equal to "http://www.w3.org/1999/02/22-rdf-syntax-ns#"
     And the JSON node "@context.rdfs" should be equal to "http://www.w3.org/2000/01/rdf-schema#"
@@ -30,7 +30,7 @@ Feature: Documentation support
     And the JSON node "@context.returns.@id" should be equal to "hydra:returns"
     And the JSON node "@context.returns.@type" should be equal to "@id"
     # Root properties
-    And the JSON node "@id" should be equal to "/doc.jsonld"
+    And the JSON node "@id" should be equal to "/docs.jsonld"
     And the JSON node "hydra:title" should be equal to "My Dummy API"
     And the JSON node "hydra:description" should be equal to "This is a test API."
     And the JSON node "hydra:entrypoint" should be equal to "/"

features/jsonld/context.feature

@@ -8,7 +8,7 @@ Feature: JSON-LD contexts generation
     Then the response status code should be 200
     And the response should be in JSON
     And the header "Content-Type" should be equal to "application/ld+json; charset=utf-8"
-    And the JSON node "@context.@vocab" should be equal to "http://example.com/doc.jsonld#"
+    And the JSON node "@context.@vocab" should be equal to "http://example.com/docs.jsonld#"
     And the JSON node "@context.hydra" should be equal to "http://www.w3.org/ns/hydra/core#"
     And the JSON node "@context.dummy.@id" should be equal to "Entrypoint/dummy"
     And the JSON node "@context.dummy.@type" should be equal to "@id"
@@ -22,7 +22,7 @@ Feature: JSON-LD contexts generation
     """
     {
         "@context": {
-            "@vocab": "http://example.com/doc.jsonld#",
+            "@vocab": "http://example.com/docs.jsonld#",
             "hydra": "http://www.w3.org/ns/hydra/core#",
             "description": "https://schema.org/description",
             "dummy": "#Dummy/dummy",
@@ -55,14 +55,14 @@ Feature: JSON-LD contexts generation
       And the JSON should be equal to:
       """
       {
-        "@context": {
-          "@vocab": "http://example.com/doc.jsonld#",
-          "hydra": "http://www.w3.org/ns/hydra/core#",
-          "paris": "#RelationEmbedder/paris",
-          "krondstadt": "#RelationEmbedder/krondstadt",
-          "anotherRelated": "#RelationEmbedder/anotherRelated",
-          "related": "#RelationEmbedder/related"
-        }
+          "@context": {
+              "@vocab": "http://example.com/docs.jsonld#",
+              "hydra": "http://www.w3.org/ns/hydra/core#",
+              "paris": "#RelationEmbedder/paris",
+              "krondstadt": "#RelationEmbedder/krondstadt",
+              "anotherRelated": "#RelationEmbedder/anotherRelated",
+              "related": "#RelationEmbedder/related"
+          }
       }
       """
 
@@ -75,10 +75,10 @@ Feature: JSON-LD contexts generation
       """
       {
           "@context": {
-              "@vocab": "http:\/\/example.com\/doc.jsonld#",
-              "hydra": "http:\/\/www.w3.org\/ns\/hydra\/core#",
+              "@vocab": "http://example.com/docs.jsonld#",
+              "hydra": "http://www.w3.org/ns/hydra/core#",
               "person": {
-                  "@id": "http:\/\/example.com\/id",
+                  "@id": "http://example.com/id",
                   "@type": "@id",
                   "foo": "bar"
               }

features/swagger/doc.feature renamed to features/swagger/docs.feature

@@ -5,7 +5,7 @@ Feature: Documentation support
 
   @createSchema
   Scenario: Retrieve the Swagger/OpenAPI documentation
-    Given I send a "GET" request to "/doc.json"
+    Given I send a "GET" request to "/docs.json"
     Then the response status code should be 200
     And the response should be in JSON
     And the header "Content-Type" should be equal to "application/json; charset=utf-8"
@@ -60,9 +60,9 @@ Feature: Documentation support
     And the JSON node "paths./dummies.get.parameters[0].required" should be false
     And the JSON node "paths./dummies.get.parameters[0].type" should be equal to "integer"
 
-  Scenario: Swagger UI is enabled for the doc endpoint
+  Scenario: Swagger UI is enabled for docs endpoint
     Given I add "Accept" header equal to "text/html"
-    And I send a "GET" request to "/doc"
+    And I send a "GET" request to "/docs"
     Then the response status code should be 200
     And I should see text matching "My Dummy API"
 

src/Bridge/Symfony/Bundle/Resources/config/routing/api.xml

@@ -13,7 +13,7 @@
         <requirement key="index">index</requirement>
     </route>
 
-    <route id="api_doc" path="/doc.{_format}">
+    <route id="api_doc" path="/docs.{_format}">
         <default key="_controller">api_platform.action.documentation</default>
         <default key="_api_respond">1</default>
         <default key="_format" />

src/Bridge/Symfony/Bundle/Resources/config/routing/jsonld.xml

@@ -13,5 +13,4 @@
         <requirement key="shortName">.+</requirement>
     </route>
 
-
 </routes>