Skip to content

Fix some OpenAPI typos #1494

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Feb 13, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
14 changes: 7 additions & 7 deletions docs/dev/api/0.1.0/objects.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@ Instruction:
type: string
example: Peel the bananas
description: An instruction step for processing the recipe

Nutrition:
type: object
properties:
Expand Down Expand Up @@ -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"
Expand All @@ -238,8 +238,8 @@ Recipe:
- url
- recipeYield
- recipeCategory
- tools
- recipeIngredients
- tool
- recipeIngredient
- recipeInstructions
- nutrition
additionalProperties: true
Expand All @@ -254,7 +254,7 @@ Recipe:
cookTime: null
totalTime: PT1H20M
url: ''
tools: []
tool: []
recipeIngredient:
- 3 ripe bananas
- 100g sugar
Expand Down
2 changes: 1 addition & 1 deletion docs/dev/api/0.1.0/openapi-cookbook.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
4 changes: 4 additions & 0 deletions docs/dev/api/changelog/0.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down