diff --git a/CHANGELOG.md b/CHANGELOG.md index c6e26066a..229cff746 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -22,6 +22,7 @@ [#1457](https://github.com/nextcloud/cookbook/pull/1457) @christianlupus - Add quick start guide for backend testing [#1466](https://github.com/nextcloud/cookbook/pull/1466) @MarcelRobitaille +- Fixed some typos in the OpenAPI specification @leptopoda ## 0.10.1 - 2022-11-09 diff --git a/docs/dev/api/0.1.0/objects.yaml b/docs/dev/api/0.1.0/objects.yaml index e5fcca2f2..070832ee1 100644 --- a/docs/dev/api/0.1.0/objects.yaml +++ b/docs/dev/api/0.1.0/objects.yaml @@ -106,7 +106,7 @@ Instruction: type: string example: Peel the bananas description: An instruction step for processing the recipe - + Nutrition: type: object properties: @@ -211,15 +211,15 @@ Recipe: type: integer example: 4 description: Number of servings in recipe - recipeCatregory: + recipeCategory: type: string example: Dessert description: The category of the recipe - tools: + tool: type: array items: $ref: "#/Tool" - recipeIngredients: + recipeIngredient: type: array items: $ref: "#/Ingredient" @@ -238,8 +238,8 @@ Recipe: - url - recipeYield - recipeCategory - - tools - - recipeIngredients + - tool + - recipeIngredient - recipeInstructions - nutrition additionalProperties: true @@ -254,7 +254,7 @@ Recipe: cookTime: null totalTime: PT1H20M url: '' - tools: [] + tool: [] recipeIngredient: - 3 ripe bananas - 100g sugar diff --git a/docs/dev/api/0.1.0/openapi-cookbook.yaml b/docs/dev/api/0.1.0/openapi-cookbook.yaml index 1b8bfcb88..456e29d0b 100644 --- a/docs/dev/api/0.1.0/openapi-cookbook.yaml +++ b/docs/dev/api/0.1.0/openapi-cookbook.yaml @@ -336,7 +336,7 @@ paths: application/json: schema: type: string - example: Recipe 2345 was deletes successfully + example: Recipe 2345 deleted successfully 502: description: An Exception was thrown content: diff --git a/docs/dev/api/changelog/0.md b/docs/dev/api/changelog/0.md index ee27abd5c..601152fc5 100644 --- a/docs/dev/api/changelog/0.md +++ b/docs/dev/api/changelog/0.md @@ -19,6 +19,10 @@ These flaws caused some code generation tools to fail or produce incomplete resu The fixture of these issues should not be critical as these are mainly cosmetic and will __not__ change the actual transmitted data. +### New objects for keywords, categories and additional data added +Together with the fixture of some typos, new JSON objects for `Keyword`, `Category`, and `Url` are defined. +With these, the documentation gets better structured but no change in behavior is introduced. + ## Version 0.1.0 - cookbook v0.9.15 - 2022-09-08