Merge pull request #198 from aroskanalen/feature/398-route-v2

398: Changed route prefix to v2

Author: tuj

.github/workflows/php_upgrade.yaml

@@ -139,7 +139,7 @@ jobs:
         run: composer install -q --no-ansi --no-interaction --no-scripts --no-suggest --no-progress --prefer-dist --ignore-platform-reqs
 
       - name: Export specifications
-        run: bin/console api:openapi:export --yaml --output=public/api-spec-v1.yaml --no-interaction
+        run: bin/console api:openapi:export --yaml --output=public/api-spec-v2.yaml --no-interaction
 
       - name: Check for changes in specifications
-        run: git diff --diff-filter=ACMRT --exit-code public/api-spec-v1.yaml
+        run: git diff --diff-filter=ACMRT --exit-code public/api-spec-v2.yaml

.github/workflows/pr.yaml

@@ -314,16 +314,16 @@ jobs:
         run: composer install -q --no-ansi --no-interaction --no-scripts --no-suggest --no-progress --prefer-dist
 
       - name: Export specifications (yaml)
-        run: bin/console api:openapi:export --yaml --output=public/api-spec-v1.yaml --no-interaction
+        run: bin/console api:openapi:export --yaml --output=public/api-spec-v2.yaml --no-interaction
 
       - name: Check for changes in specifications (yaml)
-        run: git diff --diff-filter=ACMRT --exit-code public/api-spec-v1.yaml
+        run: git diff --diff-filter=ACMRT --exit-code public/api-spec-v2.yaml
 
       - name: Export specifications (json)
-        run: bin/console api:openapi:export --output=public/api-spec-v1.json --no-interaction
+        run: bin/console api:openapi:export --output=public/api-spec-v2.json --no-interaction
 
       - name: Check for changes in specifications (json)
-        run: git diff --diff-filter=ACMRT --exit-code public/api-spec-v1.json
+        run: git diff --diff-filter=ACMRT --exit-code public/api-spec-v2.json
 
   changelog:
     runs-on: ubuntu-latest

CHANGELOG.md

@@ -4,6 +4,8 @@ All notable changes to this project will be documented in this file.
 
 ## [Unreleased]
 
+- [#198](https://github.com/os2display/display-api-service/pull/198)
+  - Changed route prefix to v2.
 - [#197](https://github.com/os2display/display-api-service/pull/197)
   - Fixed weight issue when assigning slides to playlist.
 - [#194](https://github.com/os2display/display-api-service/pull/194)

README.md

@@ -2,8 +2,8 @@
 
 ## OpenAPI specification
 
-The OpenAPI specification is committed to this repo as `public/api-spec-v1.yaml`
-and as `public/api-spec-v1.json`.
+The OpenAPI specification is committed to this repo as `public/api-spec-v2.yaml`
+and as `public/api-spec-v2.json`.
 
 A CI check will compare the current API implementation to the spec. If they
 are different the check will fail.
@@ -18,7 +18,7 @@ If these are _breaking_ changes the API version must be changed accordingly.
 
 ## Stateless
 
-The API is stateless except `/v1/authentication` routes.
+The API is stateless except `/v2/authentication` routes.
 Make sure to set the `CORS_ALLOW_ORIGIN` correctly in `.env.local`.
 
 ## Rest API & Relationships
@@ -27,7 +27,7 @@ To avoid embedding all relations in REST representations but still allow the cli
 they have to make all endpoints that have relations also has a `relationsModified` field:
 
 ```json
-  "@id": "/v1/screens/000XB4RQW418KK14AJ054W1FN2",
+  "@id": "/v2/screens/000XB4RQW418KK14AJ054W1FN2",
   ...
   "relationsModified": {
       "campaigns": "cf9bb7d5fd04743dd21b5e3361db7eed575258e0",
@@ -155,11 +155,11 @@ docker compose exec phpfpm bin/console app:user:add
 ```
 
 You can now obtain a token by sending a `POST` request to the
-`/v1/authentication/token` endpoint:
+`/v2/authentication/token` endpoint:
 
 ```curl
 curl --location --request 'POST' \
-  'http://displayapiservice.local.itkdev.dk/v1/authentication/token' \
+  'http://displayapiservice.local.itkdev.dk/v2/authentication/token' \
   --header 'accept: application/json' \
   --header 'Content-Type: application/json' \
   --data '{
@@ -180,7 +180,7 @@ as the api key value. Or by adding an auth header to your requests
 
 ```curl
 curl --location --request 'GET' \
-  'http://displayapiservice.local.itkdev.dk/v1/layouts?page=1&itemsPerPage=10' \
+  'http://displayapiservice.local.itkdev.dk/v2/layouts?page=1&itemsPerPage=10' \
   --header 'accept: application/ld+json' \
   --header 'Authorization: Bearer <token>'
 ```

composer.json

@@ -144,8 +144,8 @@
             "bin/console --env=test doctrine:migrations:migrate --no-interaction --quiet"
         ],
         "update-api-spec": [
-            "bin/console api:openapi:export --output=public/api-spec-v1.yaml --yaml --no-interaction",
-            "bin/console api:openapi:export --output=public/api-spec-v1.json --no-interaction"
+            "bin/console api:openapi:export --output=public/api-spec-v2.yaml --yaml --no-interaction",
+            "bin/console api:openapi:export --output=public/api-spec-v2.json --no-interaction"
         ]
     }
 }

config/api_platform/feed.yaml

@@ -38,7 +38,7 @@ resources:
                 openapiContext:
                     description: Get data from a feed.
                     summary: Get data from a feed.
-                    operationId: get-v1-feed-id-data
+                    operationId: get-v2-feed-id-data
                     tags:
                         - Feeds
                     parameters:
@@ -70,7 +70,7 @@ resources:
                     - 'created.at.order_filter'
                     - 'modified.at.order_filter'
                 openapiContext:
-                    operationId: get-v1-feeds
+                    operationId: get-v2-feeds
                     description: Retrieves a collection of Feed resources.
                     summary: Retrieves a collection of Feed resources.
                     tags:

config/api_platform/feed_source.yaml

@@ -42,7 +42,7 @@ resources:
                 openapiContext:
                     description: Get config for name from a feed source.
                     summary: Get config for name from a feed source.
-                    operationId: get-v1-feed-source-id-config-name
+                    operationId: get-v2-feed-source-id-config-name
                     tags:
                         - FeedSources
                     parameters:
@@ -78,7 +78,7 @@ resources:
                     - 'modified.at.order_filter'
                     - 'feed_source.search_filter'
                 openapiContext:
-                    operationId: get-v1-feed-sources
+                    operationId: get-v2-feed-sources
                     description: Retrieves a collection of FeedSource resources.
                     summary: Retrieves a collection of FeedSource resources.
                     tags:

config/api_platform/layout.yaml

@@ -12,7 +12,7 @@ resources:
                 openapiContext:
                     description: Retrieves a screen layout resource.
                     summary: Retrieve a screen layout resource.
-                    operationId: get-v1-layouts-id
+                    operationId: get-v2-layouts-id
                     tags:
                         - Layouts
                     parameters:
@@ -38,7 +38,7 @@ resources:
                     summary: Retrieves a collection of layouts resources.
                     tags:
                         - Layouts
-                    operationId: get-v1-layouts
+                    operationId: get-v2-layouts
                     parameters:
                         - schema:
                               type: integer

config/api_platform/media.yaml

@@ -13,7 +13,7 @@ resources:
                 openapiContext:
                     description: Retrieves a Media resource.
                     summary: Retrieve a Media resource.
-                    operationId: getV1MediaById
+                    operationId: getv2MediaById
                     tags:
                         - Media
                     parameters:
@@ -36,7 +36,7 @@ resources:
                 openapiContext:
                     description: Delete a Media resource.
                     summary: Delete a Media resource.
-                    operationId: delete-v1-media-id
+                    operationId: delete-v2-media-id
                     tags:
                         - Media
                     parameters:
@@ -60,7 +60,7 @@ resources:
                     summary: Retrieves a collection of Media resources.
                     tags:
                         - Media
-                    operationId: get-v1-medias
+                    operationId: get-v2-medias
                     parameters:
                         - schema:
                               type: integer

config/api_platform/playlist.yaml

@@ -13,7 +13,7 @@ resources:
                 normalizationContext:
                     jsonld_embed_context: true
                 openapiContext:
-                    operationId: get-v1-playlist-id
+                    operationId: get-v2-playlist-id
                     description: Retrieve a Playlist resource.
                     summary: Retrieves a Playlist resource.
                     tags:
@@ -38,7 +38,7 @@ resources:
                 openapiContext:
                     description: Update a Playlist resource.
                     summary: Update a Playlist resource.
-                    operationId: put-v1-playlist-id
+                    operationId: put-v2-playlist-id
                     tags:
                         - Playlists
                     parameters:
@@ -54,7 +54,7 @@ resources:
                 openapiContext:
                     description: Delete a Playlist resource.
                     summary: Delete a Playlist resource.
-                    operationId: delete-v1-playlist-id
+                    operationId: delete-v2-playlist-id
                     tags:
                         - Playlists
                     parameters:
@@ -77,7 +77,7 @@ resources:
                     - 'modified.at.order_filter'
                     - 'App\Filter\SharedWithMe'
                 openapiContext:
-                    operationId: get-v1-playlists
+                    operationId: get-v2-playlists
                     description: Retrieves a collection of Playlist resources.
                     summary: Retrieve a collection of Playlist resources.
                     tags:
@@ -103,7 +103,7 @@ resources:
                 normalizationContext:
                     jsonld_embed_context: true
                 openapiContext:
-                    operationId: create-v1-playlist
+                    operationId: create-v2-playlist
                     description: Creates a Playlist resource.
                     summary: Creates a Playlist resource.
                     tags: