Merge pull request #7 from iMvBremen/feature/api-spec-versions-refactor

Refactor to /api-specification-versions/{apiSpecificationVersionId} endpoints
Nictiz · Jan 6, 2025 · 7d6758c · 7d6758c
2 parents 80367f8 + 2a36200
commit 7d6758c
Show file tree

Hide file tree

Showing 215 changed files with 749 additions and 663 deletions.
diff --git a/.github/workflows/publish-docs.yml b/.github/workflows/publish-docs.yml
@@ -26,7 +26,7 @@ jobs:
 
       - name: Bundle
         run: |
-          npx @redocly/[email protected] bundle ./src/v1beta1/openapi.yaml --output=./build/openapi.yaml
+          npx @redocly/[email protected] bundle ./src/v1beta2/openapi.yaml --output=./build/openapi.yaml
           
       - name: Lint
         run: |

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -9,6 +9,28 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
 
 ## [Unreleased]
 
+This release refactors `/api-specifications/{apiSpecificationId}/versions` endpoints to 
+`/api-specification-versions/{apiSpecificationVersionId}` endpoints to allow for querying versions without needing the 
+`apiSpecificationId`, which brings it in line with other endpoints, like `/information-standard-versions` and 
+`/trust-framework-versions`. As this is a breaking change, the version has been updated to `v1beta2`.
+
+### Changed
+
+- Change `/api-specifications/{apiSpecificationId}/versions` endpoints to 
+  `/api-specification-versions/{apiSpecificationVersionId}`
+- Change `/api-specifications/{apiSpecificationId}/versions/{versionId}/urls` endpoints to
+  `/api-specification-versions/{apiSpecificationVersionId}/urls`
+- Change `/api-specifications/{apiSpecificationId}/versions/{versionId}/declarations-of-conformity` endpoints to
+  `/api-specification-versions/{apiSpecificationVersionId}/declarations-of-conformity`
+- Change `/api-specifications/{apiSpecificationId}/versions/{versionId}/communication-standard-versions` endpoints to
+  `/api-specification-versions/{apiSpecificationVersionId}/communication-standard-versions`
+- Change `/api-specifications/{apiSpecificationId}/versions/{versionId}/information-standard-versions` endpoints to
+  `/api-specification-versions/{apiSpecificationVersionId}/information-standard-versions`
+- Change `/api-specifications/{apiSpecificationId}/versions/{versionId}/trust-framework-versions` endpoints to
+  `/api-specification-versions/{apiSpecificationVersionId}/trust-framework-versions`
+- Change `ApiSpecificationVersion` schema to include `apiSpecificationId` and `apiSpecification`
+- Change base path in server URL from `v1beta1` to `v1beta2`
+
 ## [0.6.0] - 2024-12-18
 
 This release adds optional properties `communicationStandardVersions` and `trustFrameworkVersions` to

diff --git a/src/README.md b/src/README.md
@@ -84,7 +84,7 @@ specification, follow these steps:
 npm i -g @redocly/cli
 ```
 3. Bundle the specification from the command line (in the API specification's root folder) for the specific API version
-   (e.g. `v1beta1`):
+   (e.g. `v1beta2`):
 ```shell
-redocly bundle ./v1beta1/openapi.yaml --output v1beta1.yaml
+redocly bundle ./v1beta2/openapi.yaml --output v1beta2.yaml
 ```
diff --git a/src/bundle.bat b/src/bundle.bat
@@ -3,7 +3,7 @@ set Self=%~dp0
 set MyPath=%self:~0,-1%
 
 :: Variables
-set Version=v1beta1
+set Version=v1beta2
 set Ext=yaml
 set Input=%MyPath%\%Version%\openapi.yaml
 set Output=%MyPath%\dist\%Version%

diff --git a/src/dist/v1beta1.yaml → src/dist/v1beta2.yaml b/src/dist/v1beta1.yaml → src/dist/v1beta2.yaml
diff --git a/src/v1beta1/api-specifications/versions/_schemas/ApiSpecificationVersion_Update.yaml b/src/v1beta1/api-specifications/versions/_schemas/ApiSpecificationVersion_Update.yaml
diff --git a/...ard-versions/_paths/communication-standard-versions_{communicationStandardVersionId}.yaml b/...ard-versions/_paths/communication-standard-versions_{communicationStandardVersionId}.yaml
diff --git a/...arations-of-conformity/_paths/declarations-of-conformity_{declarationOfConformityId}.yaml b/...arations-of-conformity/_paths/declarations-of-conformity_{declarationOfConformityId}.yaml
diff --git a/...tandard-versions/_paths/information-standard-versions_{informationStandardVersionId}.yaml b/...tandard-versions/_paths/information-standard-versions_{informationStandardVersionId}.yaml
diff --git a/...s/trust-framework-versions/_paths/trust-framework-versions_{trustFrameworkVersionId}.yaml b/...s/trust-framework-versions/_paths/trust-framework-versions_{trustFrameworkVersionId}.yaml
diff --git a/src/v1beta1/api-specifications/versions/urls/_paths/urls.yaml b/src/v1beta1/api-specifications/versions/urls/_paths/urls.yaml