websoft9/apphub/apidocs/openapi.json

1 line
28 KiB
JSON
Raw Normal View History

2023-10-20 03:46:10 +00:00
{"openapi":"3.1.0","info":{"title":"AppManae API","description":"This documentation describes the AppManage API.","version":"0.0.1"},"paths":{"/apps/catalog/{locale}":{"get":{"tags":["apps"],"summary":"List Catalogs","description":"List all app's catalogs","operationId":"get_catalog_apps_apps_catalog__locale__get","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"locale","in":"path","required":true,"schema":{"type":"string","pattern":"^(zh|en)$","description":"Language to get catalogs from","title":"Locale"},"description":"Language to get catalogs from"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AppCatalogResponse"},"title":"Response 200 Get Catalog Apps Apps Catalog Locale Get"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad Request"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal Server Error"}}}},"/apps/available/{locale}":{"get":{"tags":["apps"],"summary":"List Available Apps","description":"List all available apps","operationId":"get_available_apps_apps_available__locale__get","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"locale","in":"path","required":true,"schema":{"type":"string","pattern":"^(zh|en)$","description":"Language to get available apps from","title":"Locale"},"description":"Language to get available apps from"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AppAvailableResponse"},"title":"Response 200 Get Available Apps Apps Available Locale Get"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad Request"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal Server Error"}}}},"/apps":{"get":{"tags":["apps"],"summary":"List Installed Apps","description":"List all installed apps","operationId":"get_apps_apps_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/AppResponse"},"type":"array","title":"Response 200 Get Apps Apps Get"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"APIKeyHeader":[]}]}},"/apps/{app_id}":{"get":{"tags":["apps"],"summary":"Inspect App","description":"Retrieve details about an app","operationId":"get_app_by_id_apps__app_id__get","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"app_id","in":"path","required":true,"schema":{"type":"string","description":"App ID to get details from","title":"App Id"},"description":"App ID to get details from"},{"name":"endpointId","in":"query","required":false,"schema":{"type":"integer","description":"Endpoint ID to get app details from. If not set, get details from the local endpoint","title":"Endpointid"},"description":"Endpoint ID to get app details from. If not set, get details from the local endpoint"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppResponse"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad Request"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal Server Error"}}}},"/apps/install":{"post":{"tags":["apps"],"summary":"Install App","description":"Install an app on an endpoint","operationId":"apps_install_apps_install_post","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"endpointId","in":"query","required":false,"schema":{"type":"integer","description":"Endpoint ID to install app on,if not s