Merge pull request #26 from valpackett/master

Spec fixes

Author: ddsky

.github/workflows/compare.yaml

@@ -1,6 +1,9 @@
 name: Compare spec to docs
 on:
   workflow_dispatch:
+  pull_request:
+  push:
+    branches: [master]
 jobs:
   compare:
     runs-on: ubuntu-22.04

_docmatch/src/docmatch.py

@@ -188,6 +188,24 @@ def compare_schema(location, l_name, l, r_name, r):
                 print(f"** ! unresolved/unnamed param in spec: {p}")
                 continue
             spec_params[p['name']] = p
+        spec_frm_sch = scm.get('requestBody', {}).get('content', {}).get('application/x-www-form-urlencoded', {}).get('schema')
+        if not spec_frm_sch:
+            spec_frm_sch = scm.get('requestBody', {}).get('content', {}).get('multipart/form-data', {}).get('schema')
+        if spec_frm_sch:
+            if spec_frm_sch.get('type') != 'object':
+                print(f"** ! form schema is not an object")
+            for key, prop in spec_frm_sch.get('properties', {}).items():
+                spec_params[key] = {
+                    'name': key,
+                    'in': 'form',
+                    'required': False,
+                    'schema': prop
+                }
+            for reqd in spec_frm_sch.get('required', []):
+                if reqd in spec_params:
+                    spec_params[reqd]['required'] = True
+                else:
+                    print(f"** ! param `{reqd}` marked as required but does not exist")
         for name in spec_params.keys():
             if not name in pdoc.params:
                 print(f"** ! param `{name}` found in spec, but not in doc")
@@ -201,8 +219,9 @@ def print_cmp(name, par, spec, doc):
                     return
                 if spec != doc:
                     print(f"** ! param `{name}`.`{par}`: spec `{spec}` vs doc `{doc}`")
+            spec_sch = spec_param.get('schema', {})
             print_cmp(name, 'required', spec_param.get('required'), doc_param.required)
-            print_cmp(name, 'type', spec_param.get('schema', {}).get('type'), doc_param.typ)
+            print_cmp(name, 'type', spec_sch.get('format', spec_sch.get('type')), doc_param.typ)
             print_cmp(name, 'in', spec_param.get('in'), doc_param.where)
 
         spec_req_sch = scm.get('requestBody', {}).get('content', {}).get('application/json', {}).get('schema')

android/.openapi-generator/FILES

@@ -206,7 +206,6 @@ Class | Method | HTTP request | Description
  - [AnalyzeRecipeInstructions200ResponseParsedInstructionsInnerStepsInnerIngredientsInner](docs/AnalyzeRecipeInstructions200ResponseParsedInstructionsInnerStepsInnerIngredientsInner.md)
  - [AnalyzeRecipeRequest](docs/AnalyzeRecipeRequest.md)
  - [AutocompleteIngredientSearch200ResponseInner](docs/AutocompleteIngredientSearch200ResponseInner.md)
- - [AutocompleteMenuItemSearch200Response](docs/AutocompleteMenuItemSearch200Response.md)
  - [AutocompleteProductSearch200Response](docs/AutocompleteProductSearch200Response.md)
  - [AutocompleteProductSearch200ResponseResultsInner](docs/AutocompleteProductSearch200ResponseResultsInner.md)
  - [AutocompleteRecipeSearch200ResponseInner](docs/AutocompleteRecipeSearch200ResponseInner.md)
@@ -215,6 +214,7 @@ Class | Method | HTTP request | Description
  - [ClassifyGroceryProductBulk200ResponseInner](docs/ClassifyGroceryProductBulk200ResponseInner.md)
  - [ClassifyGroceryProductBulkRequestInner](docs/ClassifyGroceryProductBulkRequestInner.md)
  - [ClassifyGroceryProductRequest](docs/ClassifyGroceryProductRequest.md)
+ - [ComparableProduct](docs/ComparableProduct.md)
  - [ComputeGlycemicLoad200Response](docs/ComputeGlycemicLoad200Response.md)
  - [ComputeGlycemicLoad200ResponseIngredientsInner](docs/ComputeGlycemicLoad200ResponseIngredientsInner.md)
  - [ComputeGlycemicLoadRequest](docs/ComputeGlycemicLoadRequest.md)
@@ -227,49 +227,32 @@ Class | Method | HTTP request | Description
  - [DetectFoodInText200ResponseAnnotationsInner](docs/DetectFoodInText200ResponseAnnotationsInner.md)
  - [GenerateMealPlan200Response](docs/GenerateMealPlan200Response.md)
  - [GenerateMealPlan200ResponseNutrients](docs/GenerateMealPlan200ResponseNutrients.md)
- - [GenerateShoppingList200Response](docs/GenerateShoppingList200Response.md)
  - [GetARandomFoodJoke200Response](docs/GetARandomFoodJoke200Response.md)
- - [GetAnalyzedRecipeInstructions200Response](docs/GetAnalyzedRecipeInstructions200Response.md)
- - [GetAnalyzedRecipeInstructions200ResponseIngredientsInner](docs/GetAnalyzedRecipeInstructions200ResponseIngredientsInner.md)
- - [GetAnalyzedRecipeInstructions200ResponseParsedInstructionsInner](docs/GetAnalyzedRecipeInstructions200ResponseParsedInstructionsInner.md)
- - [GetAnalyzedRecipeInstructions200ResponseParsedInstructionsInnerStepsInner](docs/GetAnalyzedRecipeInstructions200ResponseParsedInstructionsInnerStepsInner.md)
- - [GetAnalyzedRecipeInstructions200ResponseParsedInstructionsInnerStepsInnerIngredientsInner](docs/GetAnalyzedRecipeInstructions200ResponseParsedInstructionsInnerStepsInnerIngredientsInner.md)
+ - [GetAnalyzedRecipeInstructions200ResponseInner](docs/GetAnalyzedRecipeInstructions200ResponseInner.md)
+ - [GetAnalyzedRecipeInstructions200ResponseInnerStepsInner](docs/GetAnalyzedRecipeInstructions200ResponseInnerStepsInner.md)
+ - [GetAnalyzedRecipeInstructions200ResponseInnerStepsInnerIngredientsInner](docs/GetAnalyzedRecipeInstructions200ResponseInnerStepsInnerIngredientsInner.md)
  - [GetComparableProducts200Response](docs/GetComparableProducts200Response.md)
  - [GetComparableProducts200ResponseComparableProducts](docs/GetComparableProducts200ResponseComparableProducts.md)
- - [GetComparableProducts200ResponseComparableProductsProteinInner](docs/GetComparableProducts200ResponseComparableProductsProteinInner.md)
  - [GetConversationSuggests200Response](docs/GetConversationSuggests200Response.md)
  - [GetConversationSuggests200ResponseSuggests](docs/GetConversationSuggests200ResponseSuggests.md)
  - [GetConversationSuggests200ResponseSuggestsInner](docs/GetConversationSuggests200ResponseSuggestsInner.md)
  - [GetDishPairingForWine200Response](docs/GetDishPairingForWine200Response.md)
- - [GetIngredientInformation200Response](docs/GetIngredientInformation200Response.md)
- - [GetIngredientInformation200ResponseNutrition](docs/GetIngredientInformation200ResponseNutrition.md)
  - [GetIngredientSubstitutes200Response](docs/GetIngredientSubstitutes200Response.md)
  - [GetMealPlanTemplate200Response](docs/GetMealPlanTemplate200Response.md)
  - [GetMealPlanTemplate200ResponseDaysInner](docs/GetMealPlanTemplate200ResponseDaysInner.md)
  - [GetMealPlanTemplate200ResponseDaysInnerItemsInner](docs/GetMealPlanTemplate200ResponseDaysInnerItemsInner.md)
  - [GetMealPlanTemplate200ResponseDaysInnerItemsInnerValue](docs/GetMealPlanTemplate200ResponseDaysInnerItemsInnerValue.md)
  - [GetMealPlanTemplates200Response](docs/GetMealPlanTemplates200Response.md)
+ - [GetMealPlanTemplates200ResponseTemplatesInner](docs/GetMealPlanTemplates200ResponseTemplatesInner.md)
  - [GetMealPlanWeek200Response](docs/GetMealPlanWeek200Response.md)
  - [GetMealPlanWeek200ResponseDaysInner](docs/GetMealPlanWeek200ResponseDaysInner.md)
  - [GetMealPlanWeek200ResponseDaysInnerItemsInner](docs/GetMealPlanWeek200ResponseDaysInnerItemsInner.md)
  - [GetMealPlanWeek200ResponseDaysInnerItemsInnerValue](docs/GetMealPlanWeek200ResponseDaysInnerItemsInnerValue.md)
  - [GetMealPlanWeek200ResponseDaysInnerNutritionSummary](docs/GetMealPlanWeek200ResponseDaysInnerNutritionSummary.md)
  - [GetMealPlanWeek200ResponseDaysInnerNutritionSummaryNutrientsInner](docs/GetMealPlanWeek200ResponseDaysInnerNutritionSummaryNutrientsInner.md)
- - [GetMenuItemInformation200Response](docs/GetMenuItemInformation200Response.md)
- - [GetProductInformation200Response](docs/GetProductInformation200Response.md)
- - [GetProductInformation200ResponseIngredientsInner](docs/GetProductInformation200ResponseIngredientsInner.md)
- - [GetRandomFoodTrivia200Response](docs/GetRandomFoodTrivia200Response.md)
  - [GetRandomRecipes200Response](docs/GetRandomRecipes200Response.md)
- - [GetRandomRecipes200ResponseRecipesInner](docs/GetRandomRecipes200ResponseRecipesInner.md)
  - [GetRecipeEquipmentByID200Response](docs/GetRecipeEquipmentByID200Response.md)
  - [GetRecipeEquipmentByID200ResponseEquipmentInner](docs/GetRecipeEquipmentByID200ResponseEquipmentInner.md)
- - [GetRecipeInformation200Response](docs/GetRecipeInformation200Response.md)
- - [GetRecipeInformation200ResponseExtendedIngredientsInner](docs/GetRecipeInformation200ResponseExtendedIngredientsInner.md)
- - [GetRecipeInformation200ResponseExtendedIngredientsInnerMeasures](docs/GetRecipeInformation200ResponseExtendedIngredientsInnerMeasures.md)
- - [GetRecipeInformation200ResponseExtendedIngredientsInnerMeasuresMetric](docs/GetRecipeInformation200ResponseExtendedIngredientsInnerMeasuresMetric.md)
- - [GetRecipeInformation200ResponseWinePairing](docs/GetRecipeInformation200ResponseWinePairing.md)
- - [GetRecipeInformation200ResponseWinePairingProductMatchesInner](docs/GetRecipeInformation200ResponseWinePairingProductMatchesInner.md)
- - [GetRecipeInformationBulk200ResponseInner](docs/GetRecipeInformationBulk200ResponseInner.md)
  - [GetRecipeIngredientsByID200Response](docs/GetRecipeIngredientsByID200Response.md)
  - [GetRecipeIngredientsByID200ResponseIngredientsInner](docs/GetRecipeIngredientsByID200ResponseIngredientsInner.md)
  - [GetRecipeNutritionWidgetByID200Response](docs/GetRecipeNutritionWidgetByID200Response.md)
@@ -279,11 +262,11 @@ Class | Method | HTTP request | Description
  - [GetRecipePriceBreakdownByID200ResponseIngredientsInner](docs/GetRecipePriceBreakdownByID200ResponseIngredientsInner.md)
  - [GetRecipePriceBreakdownByID200ResponseIngredientsInnerAmount](docs/GetRecipePriceBreakdownByID200ResponseIngredientsInnerAmount.md)
  - [GetRecipePriceBreakdownByID200ResponseIngredientsInnerAmountMetric](docs/GetRecipePriceBreakdownByID200ResponseIngredientsInnerAmountMetric.md)
- - [GetRecipeTasteByID200Response](docs/GetRecipeTasteByID200Response.md)
  - [GetShoppingList200Response](docs/GetShoppingList200Response.md)
  - [GetShoppingList200ResponseAislesInner](docs/GetShoppingList200ResponseAislesInner.md)
  - [GetShoppingList200ResponseAislesInnerItemsInner](docs/GetShoppingList200ResponseAislesInnerItemsInner.md)
  - [GetShoppingList200ResponseAislesInnerItemsInnerMeasures](docs/GetShoppingList200ResponseAislesInnerItemsInnerMeasures.md)
+ - [GetShoppingList200ResponseAislesInnerItemsInnerMeasuresOriginal](docs/GetShoppingList200ResponseAislesInnerItemsInnerMeasuresOriginal.md)
  - [GetSimilarRecipes200ResponseInner](docs/GetSimilarRecipes200ResponseInner.md)
  - [GetWineDescription200Response](docs/GetWineDescription200Response.md)
  - [GetWinePairing200Response](docs/GetWinePairing200Response.md)
@@ -300,33 +283,40 @@ Class | Method | HTTP request | Description
  - [ImageAnalysisByURL200ResponseNutritionCaloriesConfidenceRange95Percent](docs/ImageAnalysisByURL200ResponseNutritionCaloriesConfidenceRange95Percent.md)
  - [ImageAnalysisByURL200ResponseRecipesInner](docs/ImageAnalysisByURL200ResponseRecipesInner.md)
  - [ImageClassificationByURL200Response](docs/ImageClassificationByURL200Response.md)
+ - [IngredientBasics](docs/IngredientBasics.md)
+ - [IngredientInformation](docs/IngredientInformation.md)
+ - [IngredientInformationEstimatedCost](docs/IngredientInformationEstimatedCost.md)
+ - [IngredientInformationNutrition](docs/IngredientInformationNutrition.md)
+ - [IngredientInformationNutritionPropertiesInner](docs/IngredientInformationNutritionPropertiesInner.md)
  - [IngredientSearch200Response](docs/IngredientSearch200Response.md)
  - [IngredientSearch200ResponseResultsInner](docs/IngredientSearch200ResponseResultsInner.md)
  - [MapIngredientsToGroceryProducts200ResponseInner](docs/MapIngredientsToGroceryProducts200ResponseInner.md)
  - [MapIngredientsToGroceryProducts200ResponseInnerProductsInner](docs/MapIngredientsToGroceryProducts200ResponseInnerProductsInner.md)
  - [MapIngredientsToGroceryProductsRequest](docs/MapIngredientsToGroceryProductsRequest.md)
- - [ParseIngredients200ResponseInner](docs/ParseIngredients200ResponseInner.md)
- - [ParseIngredients200ResponseInnerEstimatedCost](docs/ParseIngredients200ResponseInnerEstimatedCost.md)
- - [ParseIngredients200ResponseInnerNutrition](docs/ParseIngredients200ResponseInnerNutrition.md)
- - [ParseIngredients200ResponseInnerNutritionCaloricBreakdown](docs/ParseIngredients200ResponseInnerNutritionCaloricBreakdown.md)
- - [ParseIngredients200ResponseInnerNutritionNutrientsInner](docs/ParseIngredients200ResponseInnerNutritionNutrientsInner.md)
- - [ParseIngredients200ResponseInnerNutritionPropertiesInner](docs/ParseIngredients200ResponseInnerNutritionPropertiesInner.md)
- - [ParseIngredients200ResponseInnerNutritionWeightPerServing](docs/ParseIngredients200ResponseInnerNutritionWeightPerServing.md)
+ - [MenuItem](docs/MenuItem.md)
+ - [MenuItemServings](docs/MenuItemServings.md)
+ - [ProductInformation](docs/ProductInformation.md)
+ - [ProductInformationCredits](docs/ProductInformationCredits.md)
  - [QuickAnswer200Response](docs/QuickAnswer200Response.md)
+ - [RecipeInformation](docs/RecipeInformation.md)
+ - [RecipeInformationExtendedIngredientsInner](docs/RecipeInformationExtendedIngredientsInner.md)
+ - [RecipeInformationExtendedIngredientsInnerMeasures](docs/RecipeInformationExtendedIngredientsInnerMeasures.md)
+ - [RecipeInformationExtendedIngredientsInnerMeasuresMetric](docs/RecipeInformationExtendedIngredientsInnerMeasuresMetric.md)
+ - [RecipeInformationWinePairing](docs/RecipeInformationWinePairing.md)
+ - [RecipeInformationWinePairingProductMatchesInner](docs/RecipeInformationWinePairingProductMatchesInner.md)
  - [SearchAllFood200Response](docs/SearchAllFood200Response.md)
  - [SearchAllFood200ResponseSearchResultsInner](docs/SearchAllFood200ResponseSearchResultsInner.md)
- - [SearchAllFood200ResponseSearchResultsInnerResultsInner](docs/SearchAllFood200ResponseSearchResultsInnerResultsInner.md)
  - [SearchCustomFoods200Response](docs/SearchCustomFoods200Response.md)
  - [SearchCustomFoods200ResponseCustomFoodsInner](docs/SearchCustomFoods200ResponseCustomFoodsInner.md)
  - [SearchFoodVideos200Response](docs/SearchFoodVideos200Response.md)
  - [SearchFoodVideos200ResponseVideosInner](docs/SearchFoodVideos200ResponseVideosInner.md)
  - [SearchGroceryProducts200Response](docs/SearchGroceryProducts200Response.md)
  - [SearchGroceryProductsByUPC200Response](docs/SearchGroceryProductsByUPC200Response.md)
- - [SearchGroceryProductsByUPC200ResponseIngredientsInner](docs/SearchGroceryProductsByUPC200ResponseIngredientsInner.md)
  - [SearchGroceryProductsByUPC200ResponseNutrition](docs/SearchGroceryProductsByUPC200ResponseNutrition.md)
+ - [SearchGroceryProductsByUPC200ResponseNutritionCaloricBreakdown](docs/SearchGroceryProductsByUPC200ResponseNutritionCaloricBreakdown.md)
+ - [SearchGroceryProductsByUPC200ResponseNutritionNutrientsInner](docs/SearchGroceryProductsByUPC200ResponseNutritionNutrientsInner.md)
  - [SearchGroceryProductsByUPC200ResponseServings](docs/SearchGroceryProductsByUPC200ResponseServings.md)
  - [SearchMenuItems200Response](docs/SearchMenuItems200Response.md)
- - [SearchMenuItems200ResponseMenuItemsInner](docs/SearchMenuItems200ResponseMenuItemsInner.md)
  - [SearchRecipes200Response](docs/SearchRecipes200Response.md)
  - [SearchRecipes200ResponseResultsInner](docs/SearchRecipes200ResponseResultsInner.md)
  - [SearchRecipesByIngredients200ResponseInner](docs/SearchRecipesByIngredients200ResponseInner.md)
@@ -337,12 +327,13 @@ Class | Method | HTTP request | Description
  - [SearchRestaurants200ResponseRestaurantsInnerAddress](docs/SearchRestaurants200ResponseRestaurantsInnerAddress.md)
  - [SearchRestaurants200ResponseRestaurantsInnerLocalHours](docs/SearchRestaurants200ResponseRestaurantsInnerLocalHours.md)
  - [SearchRestaurants200ResponseRestaurantsInnerLocalHoursOperational](docs/SearchRestaurants200ResponseRestaurantsInnerLocalHoursOperational.md)
+ - [SearchResult](docs/SearchResult.md)
+ - [SearchResultDataPointsInner](docs/SearchResultDataPointsInner.md)
  - [SearchSiteContent200Response](docs/SearchSiteContent200Response.md)
- - [SearchSiteContent200ResponseArticlesInner](docs/SearchSiteContent200ResponseArticlesInner.md)
- - [SearchSiteContent200ResponseArticlesInnerDataPointsInner](docs/SearchSiteContent200ResponseArticlesInnerDataPointsInner.md)
  - [SummarizeRecipe200Response](docs/SummarizeRecipe200Response.md)
  - [TalkToChatbot200Response](docs/TalkToChatbot200Response.md)
  - [TalkToChatbot200ResponseMediaInner](docs/TalkToChatbot200ResponseMediaInner.md)
+ - [TasteInformation](docs/TasteInformation.md)
 
 
 ## Documentation for Authorization

android/README.md

@@ -6,7 +6,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**id** | [**BigDecimal**](BigDecimal.md) |  | 
+**id** | **Integer** |  | 
 **name** | **String** |  | 
 
 

android/docs/AnalyzeRecipeInstructions200ResponseIngredientsInner.md

@@ -6,7 +6,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**id** | [**BigDecimal**](BigDecimal.md) |  | 
+**id** | **Integer** |  | 
 **name** | **String** |  | 
 **localizedName** | **String** |  | 
 **image** | **String** |  | 

android/docs/AnalyzeRecipeInstructions200ResponseParsedInstructionsInnerStepsInnerIngredientsInner.md

@@ -0,0 +1,16 @@
+
+
+# ComparableProduct
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**difference** | [**BigDecimal**](BigDecimal.md) |  | 
+**id** | **Integer** |  | 
+**image** | **String** |  | 
+**title** | **String** |  | 
+
+
+
+

android/docs/AutocompleteMenuItemSearch200Response.md

@@ -77,7 +77,7 @@ Generate a recipe card for a recipe.
 //import com.spoonacular.DefaultApi;
 
 DefaultApi apiInstance = new DefaultApi();
-BigDecimal id = 4632; // BigDecimal | The recipe id.
+Integer id = 4632; // Integer | The recipe id.
 String mask = ellipseMask; // String | The mask to put over the recipe image (\"ellipseMask\", \"diamondMask\", \"starMask\", \"heartMask\", \"potMask\", \"fishMask\").
 String backgroundImage = background1; // String | The background image (\"none\",\"background1\", or \"background2\").
 String backgroundColor = ffffff; // String | The background color for the recipe card as a hex-string.
@@ -96,7 +96,7 @@ try {
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **id** | **BigDecimal**| The recipe id. | [default to null]
+ **id** | **Integer**| The recipe id. | [default to null]
  **mask** | **String**| The mask to put over the recipe image (\"ellipseMask\", \"diamondMask\", \"starMask\", \"heartMask\", \"potMask\", \"fishMask\"). | [optional] [default to null]
  **backgroundImage** | **String**| The background image (\"none\",\"background1\", or \"background2\"). | [optional] [default to null]
  **backgroundColor** | **String**| The background color for the recipe card as a hex-string. | [optional] [default to null]