goose/api_clients/bash/docs/RecipeManagementApi.md

RecipeManagementApi

All URIs are relative to **

Method	HTTP request	Description
createRecipe	POST /recipes/create	Create a Recipe configuration from the current session
decodeRecipe	POST /recipes/decode
deleteRecipe	POST /recipes/delete
encodeRecipe	POST /recipes/encode
listRecipes	GET /recipes/list
scanRecipe	POST /recipes/scan

createRecipe

Create a Recipe configuration from the current session

Example

goose-api createRecipe

Parameters

Name	Type	Description	Notes
createRecipeRequest	CreateRecipeRequest

Return type

CreateRecipeResponse

Authorization

No authorization required

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

decodeRecipe

Example

goose-api decodeRecipe

Parameters

Name	Type	Description	Notes
decodeRecipeRequest	DecodeRecipeRequest

Return type

DecodeRecipeResponse

Authorization

No authorization required

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

deleteRecipe

Example

goose-api deleteRecipe

Parameters

Name	Type	Description	Notes
deleteRecipeRequest	DeleteRecipeRequest

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: application/json
• Accept: Not Applicable

[Back to top] [Back to API list] [Back to Model list] [Back to README]

encodeRecipe

Example

goose-api encodeRecipe

Parameters

Name	Type	Description	Notes
encodeRecipeRequest	EncodeRecipeRequest

Return type

EncodeRecipeResponse

Authorization

No authorization required

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

listRecipes

Example

goose-api listRecipes

Parameters

This endpoint does not need any parameter.

Return type

ListRecipeResponse

Authorization

No authorization required

HTTP request headers

• Content-Type: Not Applicable
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

scanRecipe

Example

goose-api scanRecipe

Parameters

Name	Type	Description	Notes
scanRecipeRequest	ScanRecipeRequest

Return type

ScanRecipeResponse

Authorization

No authorization required

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]