diff --git a/CHANGELOG.md b/CHANGELOG.md index 4cf447696..e3f243527 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -27,6 +27,8 @@ [#1680](https://github.com/nextcloud/cookbook/pull/1680) @dependabot - Fix bug in browser console [#1686](https://github.com/nextcloud/cookbook/pull/1686) @christianlupus +- Make OpenAPI specs more compatible regarding `@type` + [#1700](https://github.com/nextcloud/cookbook/pull/1700) @christianlupus ## 0.10.2 - 2023-03-24 diff --git a/docs/dev/api/0.1.0/objects.yaml b/docs/dev/api/0.1.0/objects.yaml index 599121a08..070832ee1 100644 --- a/docs/dev/api/0.1.0/objects.yaml +++ b/docs/dev/api/0.1.0/objects.yaml @@ -110,6 +110,10 @@ Instruction: Nutrition: type: object properties: + "@type": + type: string + example: NutritionInformation + description: Schema.org object description calories: type: string description: The number of calories for the given amount @@ -158,6 +162,8 @@ Nutrition: type: string description: The number of grams of unsaturated fat example: 40 g + required: + - "@type" Recipe: #type: object @@ -166,6 +172,10 @@ Recipe: - $ref: "#/RecipeStubInformation" - type: object properties: + "@type": + type: string + example: "Recipe" + description: Schema.org object type identifier id: type: string description: The index of the recipe. Note the representation as a string as the representation might change in the future. diff --git a/docs/dev/api/0.1.1/objects.yaml b/docs/dev/api/0.1.1/objects.yaml index 1bf699f75..abeded831 100644 --- a/docs/dev/api/0.1.1/objects.yaml +++ b/docs/dev/api/0.1.1/objects.yaml @@ -167,6 +167,11 @@ Instruction: Nutrition: type: object properties: + "@type": + type: string + example: NutritionInformation + description: Schema.org object description + default: NutritionInformation calories: type: string description: The number of calories for the given amount @@ -215,6 +220,8 @@ Nutrition: type: string description: The number of grams of unsaturated fat example: 40 g + required: + - "@type" Recipe: #type: object @@ -223,6 +230,11 @@ Recipe: - $ref: "#/RecipeStubInformation" - type: object properties: + "@type": + type: string + example: "Recipe" + default: Recipe + description: Schema.org object type identifier id: type: string description: The index of the recipe. Note the representation as a string as the representation might change in the future.