{"openapi":"3.1.0","info":{"title":"Posti Developer Portal backend REST API","description":"Collection of endpoints and resources for managing devportal and API catalogue.","version":"0.1.0"},"paths":{"/api/v1/health":{"get":{"tags":["health"],"summary":"Health check status.","description":"Returns health status as OK (with http statusCode `200`) when application is running and healthy.","operationId":"get_health_api_v1_health_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusResponse"},"example":{"statusCode":403,"status":"FORBIDDEN","details":["Forbidden."]}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusResponse"},"example":{"statusCode":404,"status":"NOT_FOUND","details":["Not found."]}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusResponse"},"example":{"statusCode":409,"status":"EXISTS_MUST_BE_UNIQUE","details":["Already exists, must be unique."]}}}},"422":{"description":"Unprocessable entity","content":{"application/json":{"example":{"statusCode":422,"status":"ERROR","details":[{"type":"string","loc":["string","string"],"msg":"string","input":"string"}]}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusResponse"},"example":{"statusCode":500,"status":"FAILED_TO_CREATE_OR_UPDATE","details":["Failed to be created or updated."]}}}}}}},"/api/v1/history":{"post":{"tags":["history"],"summary":"Create new history entry.","description":"Create history entry in db.","operationId":"create_history_entry_api_v1_history_post","parameters":[{"name":"Session","in":"cookie","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Session"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HistoryCreate"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HistoryResponse"}}}},"403":{"content":{"application/json":{"example":{"statusCode":403,"status":"FORBIDDEN","details":["Forbidden."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"example":{"statusCode":404,"status":"NOT_FOUND","details":["Not found."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Not Found"},"409":{"content":{"application/json":{"example":{"statusCode":409,"status":"EXISTS_MUST_BE_UNIQUE","details":["Already exists, must be unique."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Conflict"},"422":{"description":"Unprocessable entity","content":{"application/json":{"example":{"statusCode":422,"status":"ERROR","details":[{"type":"string","loc":["string","string"],"msg":"string","input":"string"}]}}}},"500":{"content":{"application/json":{"example":{"statusCode":500,"status":"FAILED_TO_CREATE_OR_UPDATE","details":["Failed to be created or updated."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Internal Server Error"}}},"get":{"tags":["history"],"summary":"Get all history entries.","description":"Get all history entries as list.","operationId":"get_all_history_entries_api_v1_history_get","parameters":[{"name":"Session","in":"cookie","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Session"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/HistoryResponse"},"title":"Response Get All History Entries Api V1 History Get","$ref":"#/components/schemas/HistoryResponse"}}}},"403":{"content":{"application/json":{"example":{"statusCode":403,"status":"FORBIDDEN","details":["Forbidden."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"example":{"statusCode":404,"status":"NOT_FOUND","details":["Not found."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Not Found"},"409":{"content":{"application/json":{"example":{"statusCode":409,"status":"EXISTS_MUST_BE_UNIQUE","details":["Already exists, must be unique."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Conflict"},"422":{"description":"Unprocessable entity","content":{"application/json":{"example":{"statusCode":422,"status":"ERROR","details":[{"type":"string","loc":["string","string"],"msg":"string","input":"string"}]}}}},"500":{"content":{"application/json":{"example":{"statusCode":500,"status":"FAILED_TO_CREATE_OR_UPDATE","details":["Failed to be created or updated."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Internal Server Error"}}}},"/api/v1/history/{id}":{"get":{"tags":["history"],"summary":"Get history entry by id.","description":"Get history entry by id. If not found `404` response is returned.","operationId":"get_history_by_id_api_v1_history__id__get","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","title":"Id"}},{"name":"Session","in":"cookie","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Session"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HistoryResponse"}}}},"403":{"content":{"application/json":{"example":{"statusCode":403,"status":"FORBIDDEN","details":["Forbidden."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"example":{"statusCode":404,"status":"NOT_FOUND","details":["Not found."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Not Found"},"409":{"content":{"application/json":{"example":{"statusCode":409,"status":"EXISTS_MUST_BE_UNIQUE","details":["Already exists, must be unique."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Conflict"},"422":{"description":"Unprocessable entity","content":{"application/json":{"example":{"statusCode":422,"status":"ERROR","details":[{"type":"string","loc":["string","string"],"msg":"string","input":"string"}]}}}},"500":{"content":{"application/json":{"example":{"statusCode":500,"status":"FAILED_TO_CREATE_OR_UPDATE","details":["Failed to be created or updated."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Internal Server Error"}}}},"/api/v1/document":{"get":{"tags":["document"],"summary":"Get all documents.","description":"Get all documents. Returned as list or empty list.","operationId":"get_all_documents_api_v1_document_get","parameters":[{"name":"sort","in":"query","required":false,"schema":{"type":"boolean","title":"Sort by modification timestamp.","default":true}},{"name":"reverse","in":"query","required":false,"schema":{"type":"boolean","title":"Use reverse sorting if sorting is enabled.","default":true}},{"name":"text_search","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Full or partial text from docId or description."}},{"name":"doc_type","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/DocumentType"},{"type":"null"}],"title":"Document type."}},{"name":"created_by","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Email address."}},{"name":"modified_by","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Email address."}},{"name":"Session","in":"cookie","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Session"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentResponse"}}}},"403":{"content":{"application/json":{"example":{"statusCode":403,"status":"FORBIDDEN","details":["Forbidden."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"example":{"statusCode":404,"status":"NOT_FOUND","details":["Not found."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Not Found"},"409":{"content":{"application/json":{"example":{"statusCode":409,"status":"EXISTS_MUST_BE_UNIQUE","details":["Already exists, must be unique."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Conflict"},"422":{"description":"Unprocessable entity","content":{"application/json":{"example":{"statusCode":422,"status":"ERROR","details":[{"type":"string","loc":["string","string"],"msg":"string","input":"string"}]}}}},"500":{"content":{"application/json":{"example":{"statusCode":500,"status":"FAILED_TO_CREATE_OR_UPDATE","details":["Failed to be created or updated."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Internal Server Error"}}},"post":{"tags":["document"],"summary":"Create new document.","description":"Create document records.","operationId":"create_document_api_v1_document_post","parameters":[{"name":"Session","in":"cookie","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Session"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentCreate"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"403":{"content":{"application/json":{"example":{"statusCode":403,"status":"FORBIDDEN","details":["Forbidden."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"example":{"statusCode":404,"status":"NOT_FOUND","details":["Not found."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Not Found"},"409":{"content":{"application/json":{"example":{"statusCode":409,"status":"EXISTS_MUST_BE_UNIQUE","details":["Already exists, must be unique."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Conflict"},"422":{"description":"Unprocessable entity","content":{"application/json":{"example":{"statusCode":422,"status":"ERROR","details":[{"type":"string","loc":["string","string"],"msg":"string","input":"string"}]}}}},"500":{"content":{"application/json":{"example":{"statusCode":500,"status":"FAILED_TO_CREATE_OR_UPDATE","details":["Failed to be created or updated."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Internal Server Error"},"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentResponse"}}},"description":"OK"}}}},"/api/v1/document/{id}":{"get":{"tags":["document"],"summary":"Get document by id.","description":"Get document by id. If not found `404` response is returned.","operationId":"get_document_by_id_api_v1_document__id__get","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","title":"Id of document."}},{"name":"Session","in":"cookie","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Session"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentResponse"}}}},"403":{"content":{"application/json":{"example":{"statusCode":403,"status":"FORBIDDEN","details":["Forbidden."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"example":{"statusCode":404,"status":"NOT_FOUND","details":["Not found."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Not Found"},"409":{"content":{"application/json":{"example":{"statusCode":409,"status":"EXISTS_MUST_BE_UNIQUE","details":["Already exists, must be unique."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Conflict"},"422":{"description":"Unprocessable entity","content":{"application/json":{"example":{"statusCode":422,"status":"ERROR","details":[{"type":"string","loc":["string","string"],"msg":"string","input":"string"}]}}}},"500":{"content":{"application/json":{"example":{"statusCode":500,"status":"FAILED_TO_CREATE_OR_UPDATE","details":["Failed to be created or updated."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Internal Server Error"}}},"put":{"tags":["document"],"summary":"Update document by replacing the previous version.","description":"Update document.","operationId":"update_document_api_v1_document__id__put","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","title":"Id of document."}},{"name":"Session","in":"cookie","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Session"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentUpdate"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentResponse"}}}},"403":{"content":{"application/json":{"example":{"statusCode":403,"status":"FORBIDDEN","details":["Forbidden."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"example":{"statusCode":404,"status":"NOT_FOUND","details":["Not found."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Not Found"},"409":{"content":{"application/json":{"example":{"statusCode":409,"status":"EXISTS_MUST_BE_UNIQUE","details":["Already exists, must be unique."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Conflict"},"422":{"description":"Unprocessable entity","content":{"application/json":{"example":{"statusCode":422,"status":"ERROR","details":[{"type":"string","loc":["string","string"],"msg":"string","input":"string"}]}}}},"500":{"content":{"application/json":{"example":{"statusCode":500,"status":"FAILED_TO_CREATE_OR_UPDATE","details":["Failed to be created or updated."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Internal Server Error"}}},"delete":{"tags":["document"],"summary":"Delete document by id.","description":"Deletes document by id.","operationId":"delete_document_api_v1_document__id__delete","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","title":"Id of document."}},{"name":"Session","in":"cookie","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Session"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusResponse"},"example":{"statusCode":200,"status":"SUCCESSFULLY_DELETED","details":["Successfully deleted."]}}}},"403":{"content":{"application/json":{"example":{"statusCode":403,"status":"FORBIDDEN","details":["Forbidden."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"example":{"statusCode":404,"status":"NOT_FOUND","details":["Not found."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Not Found"},"409":{"content":{"application/json":{"example":{"statusCode":409,"status":"EXISTS_MUST_BE_UNIQUE","details":["Already exists, must be unique."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Conflict"},"422":{"description":"Unprocessable entity","content":{"application/json":{"example":{"statusCode":422,"status":"ERROR","details":[{"type":"string","loc":["string","string"],"msg":"string","input":"string"}]}}}},"500":{"content":{"application/json":{"example":{"statusCode":500,"status":"FAILED_TO_CREATE_OR_UPDATE","details":["Failed to be created or updated."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Internal Server Error"}}}},"/api/v1/document/docid/{doc_id}":{"get":{"tags":["document"],"summary":"Get document by docId.","description":"Get document by docId. If not found `404` response is returned.","operationId":"get_document_by_doc_id_api_v1_document_docid__doc_id__get","parameters":[{"name":"doc_id","in":"path","required":true,"schema":{"type":"string","title":"docId."}},{"name":"Session","in":"cookie","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Session"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentResponse"}}}},"403":{"content":{"application/json":{"example":{"statusCode":403,"status":"FORBIDDEN","details":["Forbidden."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"example":{"statusCode":404,"status":"NOT_FOUND","details":["Not found."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Not Found"},"409":{"content":{"application/json":{"example":{"statusCode":409,"status":"EXISTS_MUST_BE_UNIQUE","details":["Already exists, must be unique."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Conflict"},"422":{"description":"Unprocessable entity","content":{"application/json":{"example":{"statusCode":422,"status":"ERROR","details":[{"type":"string","loc":["string","string"],"msg":"string","input":"string"}]}}}},"500":{"content":{"application/json":{"example":{"statusCode":500,"status":"FAILED_TO_CREATE_OR_UPDATE","details":["Failed to be created or updated."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Internal Server Error"}}}},"/api/v1/authentication/azure/login":{"post":{"tags":["authentication"],"summary":"Login user.","description":"Azure user.","operationId":"azure_login_api_v1_authentication_azure_login_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AzureAuthRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusResponse"},"example":{"statusCode":403,"status":"FORBIDDEN","details":["Forbidden."]}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusResponse"},"example":{"statusCode":404,"status":"NOT_FOUND","details":["Not found."]}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusResponse"},"example":{"statusCode":409,"status":"EXISTS_MUST_BE_UNIQUE","details":["Already exists, must be unique."]}}}},"422":{"description":"Unprocessable entity","content":{"application/json":{"example":{"statusCode":422,"status":"ERROR","details":[{"type":"string","loc":["string","string"],"msg":"string","input":"string"}]}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusResponse"},"example":{"statusCode":500,"status":"FAILED_TO_CREATE_OR_UPDATE","details":["Failed to be created or updated."]}}}}}}},"/api/v1/authentication/me":{"get":{"tags":["authentication"],"summary":"Get current logged in user.","description":"Get current user.","operationId":"me_api_v1_authentication_me_get","parameters":[{"name":"Session","in":"cookie","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Session"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationResponse"}}}},"403":{"content":{"application/json":{"example":{"statusCode":403,"status":"FORBIDDEN","details":["Forbidden."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"example":{"statusCode":404,"status":"NOT_FOUND","details":["Not found."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Not Found"},"409":{"content":{"application/json":{"example":{"statusCode":409,"status":"EXISTS_MUST_BE_UNIQUE","details":["Already exists, must be unique."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Conflict"},"422":{"description":"Unprocessable entity","content":{"application/json":{"example":{"statusCode":422,"status":"ERROR","details":[{"type":"string","loc":["string","string"],"msg":"string","input":"string"}]}}}},"500":{"content":{"application/json":{"example":{"statusCode":500,"status":"FAILED_TO_CREATE_OR_UPDATE","details":["Failed to be created or updated."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Internal Server Error"}}}},"/api/v1/authentication/logout":{"post":{"tags":["authentication"],"summary":"Log out user.","description":"Logout current user.","operationId":"logout_api_v1_authentication_logout_post","parameters":[{"name":"Session","in":"cookie","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Session"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationResponse"}}}},"403":{"content":{"application/json":{"example":{"statusCode":403,"status":"FORBIDDEN","details":["Forbidden."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"example":{"statusCode":404,"status":"NOT_FOUND","details":["Not found."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Not Found"},"409":{"content":{"application/json":{"example":{"statusCode":409,"status":"EXISTS_MUST_BE_UNIQUE","details":["Already exists, must be unique."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Conflict"},"422":{"description":"Unprocessable entity","content":{"application/json":{"example":{"statusCode":422,"status":"ERROR","details":[{"type":"string","loc":["string","string"],"msg":"string","input":"string"}]}}}},"500":{"content":{"application/json":{"example":{"statusCode":500,"status":"FAILED_TO_CREATE_OR_UPDATE","details":["Failed to be created or updated."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Internal Server Error"}}}},"/api/v1/authentication/verify":{"post":{"tags":["authentication"],"summary":"Verify user by changing it's temporary password.","description":"Verify user by changing default temp password. `x-auth-session-token` must be provided as HTTP header.\nValue is retrieved from /login endpoint when first time login is attempted.","operationId":"verify_api_v1_authentication_verify_post","parameters":[{"name":"x-auth-session-token","in":"header","required":true,"schema":{"type":"string","title":"X-Auth-Session-Token"}}],"requestBody":{"required":true,"content":{"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/Body_verify_api_v1_authentication_verify_post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationResponse"}}}},"403":{"content":{"application/json":{"example":{"statusCode":403,"status":"FORBIDDEN","details":["Forbidden."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"example":{"statusCode":404,"status":"NOT_FOUND","details":["Not found."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Not Found"},"409":{"content":{"application/json":{"example":{"statusCode":409,"status":"EXISTS_MUST_BE_UNIQUE","details":["Already exists, must be unique."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Conflict"},"422":{"description":"Unprocessable entity","content":{"application/json":{"example":{"statusCode":422,"status":"ERROR","details":[{"type":"string","loc":["string","string"],"msg":"string","input":"string"}]}}}},"500":{"content":{"application/json":{"example":{"statusCode":500,"status":"FAILED_TO_CREATE_OR_UPDATE","details":["Failed to be created or updated."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Internal Server Error"}}}},"/api/v1/lifecycle":{"get":{"tags":["lifecycle"],"summary":"Get all lifecycles.","description":"Returns lifecycles.","operationId":"get_all_lifecycles_api_v1_lifecycle_get","parameters":[{"name":"Session","in":"cookie","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Session"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LifecycleResponse"}}}},"403":{"content":{"application/json":{"example":{"statusCode":403,"status":"FORBIDDEN","details":["Forbidden."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"example":{"statusCode":404,"status":"NOT_FOUND","details":["Not found."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Not Found"},"409":{"content":{"application/json":{"example":{"statusCode":409,"status":"EXISTS_MUST_BE_UNIQUE","details":["Already exists, must be unique."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Conflict"},"422":{"description":"Unprocessable entity","content":{"application/json":{"example":{"statusCode":422,"status":"ERROR","details":[{"type":"string","loc":["string","string"],"msg":"string","input":"string"}]}}}},"500":{"content":{"application/json":{"example":{"statusCode":500,"status":"FAILED_TO_CREATE_OR_UPDATE","details":["Failed to be created or updated."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Internal Server Error"}}},"post":{"tags":["lifecycle"],"summary":"Create lifecycle.","description":"Create lifecycle.","operationId":"create_lifecycle_api_v1_lifecycle_post","parameters":[{"name":"Session","in":"cookie","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Session"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LifecycleCreate"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LifecycleResponse"}}}},"403":{"content":{"application/json":{"example":{"statusCode":403,"status":"FORBIDDEN","details":["Forbidden."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"example":{"statusCode":404,"status":"NOT_FOUND","details":["Not found."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Not Found"},"409":{"content":{"application/json":{"example":{"statusCode":409,"status":"EXISTS_MUST_BE_UNIQUE","details":["Already exists, must be unique."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Conflict"},"422":{"description":"Unprocessable entity","content":{"application/json":{"example":{"statusCode":422,"status":"ERROR","details":[{"type":"string","loc":["string","string"],"msg":"string","input":"string"}]}}}},"500":{"content":{"application/json":{"example":{"statusCode":500,"status":"FAILED_TO_CREATE_OR_UPDATE","details":["Failed to be created or updated."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Internal Server Error"}}}},"/api/v1/lifecycle/{name}":{"get":{"tags":["lifecycle"],"summary":"Get lifecycle by name.","description":"Returns lifecycle by name.","operationId":"get_lifecycle_by_id_api_v1_lifecycle__name__get","parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string","title":"Name of lifecycle."}},{"name":"Session","in":"cookie","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Session"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LifecycleResponse"}}}},"403":{"content":{"application/json":{"example":{"statusCode":403,"status":"FORBIDDEN","details":["Forbidden."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"example":{"statusCode":404,"status":"NOT_FOUND","details":["Not found."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Not Found"},"409":{"content":{"application/json":{"example":{"statusCode":409,"status":"EXISTS_MUST_BE_UNIQUE","details":["Already exists, must be unique."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Conflict"},"422":{"description":"Unprocessable entity","content":{"application/json":{"example":{"statusCode":422,"status":"ERROR","details":[{"type":"string","loc":["string","string"],"msg":"string","input":"string"}]}}}},"500":{"content":{"application/json":{"example":{"statusCode":500,"status":"FAILED_TO_CREATE_OR_UPDATE","details":["Failed to be created or updated."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Internal Server Error"}}},"delete":{"tags":["lifecycle"],"summary":"Delete lifecycle.","description":"Delete lifecycle.","operationId":"delete_lifecycle_api_v1_lifecycle__name__delete","parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string","title":"Name of lifecycle."}},{"name":"Session","in":"cookie","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Session"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusResponse"},"example":{"statusCode":200,"status":"SUCCESSFULLY_DELETED","details":["Successfully deleted."]}}}},"403":{"content":{"application/json":{"example":{"statusCode":403,"status":"FORBIDDEN","details":["Forbidden."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"example":{"statusCode":404,"status":"NOT_FOUND","details":["Not found."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Not Found"},"409":{"content":{"application/json":{"example":{"statusCode":409,"status":"EXISTS_MUST_BE_UNIQUE","details":["Already exists, must be unique."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Conflict"},"422":{"description":"Unprocessable entity","content":{"application/json":{"example":{"statusCode":422,"status":"ERROR","details":[{"type":"string","loc":["string","string"],"msg":"string","input":"string"}]}}}},"500":{"content":{"application/json":{"example":{"statusCode":500,"status":"FAILED_TO_CREATE_OR_UPDATE","details":["Failed to be created or updated."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Internal Server Error"}}}},"/api/v1/apipolicy":{"get":{"tags":["apipolicy"],"summary":"Get all API policies.","description":"Get all API policies..","operationId":"get_api_policies_api_v1_apipolicy_get","parameters":[{"name":"Session","in":"cookie","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Session"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIPolicyResponse"}}}},"403":{"content":{"application/json":{"example":{"statusCode":403,"status":"FORBIDDEN","details":["Forbidden."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"example":{"statusCode":404,"status":"NOT_FOUND","details":["Not found."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Not Found"},"409":{"content":{"application/json":{"example":{"statusCode":409,"status":"EXISTS_MUST_BE_UNIQUE","details":["Already exists, must be unique."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Conflict"},"422":{"description":"Unprocessable entity","content":{"application/json":{"example":{"statusCode":422,"status":"ERROR","details":[{"type":"string","loc":["string","string"],"msg":"string","input":"string"}]}}}},"500":{"content":{"application/json":{"example":{"statusCode":500,"status":"FAILED_TO_CREATE_OR_UPDATE","details":["Failed to be created or updated."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Internal Server Error"}}},"post":{"tags":["apipolicy"],"summary":"Create API policy.","description":"Create API policy.","operationId":"create_api_policy_api_v1_apipolicy_post","parameters":[{"name":"Session","in":"cookie","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Session"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIPolicyCreate"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIPolicyResponse"}}}},"403":{"content":{"application/json":{"example":{"statusCode":403,"status":"FORBIDDEN","details":["Forbidden."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"example":{"statusCode":404,"status":"NOT_FOUND","details":["Not found."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Not Found"},"409":{"content":{"application/json":{"example":{"statusCode":409,"status":"EXISTS_MUST_BE_UNIQUE","details":["Already exists, must be unique."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Conflict"},"422":{"description":"Unprocessable entity","content":{"application/json":{"example":{"statusCode":422,"status":"ERROR","details":[{"type":"string","loc":["string","string"],"msg":"string","input":"string"}]}}}},"500":{"content":{"application/json":{"example":{"statusCode":500,"status":"FAILED_TO_CREATE_OR_UPDATE","details":["Failed to be created or updated."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Internal Server Error"}}}},"/api/v1/apipolicy/{name}":{"get":{"tags":["apipolicy"],"summary":"Get API policy by name.","description":"Returns API policy by name.","operationId":"get_api_policy_by_name_api_v1_apipolicy__name__get","parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string","title":"Name of API policy."}},{"name":"Session","in":"cookie","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Session"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIPolicyResponse"}}}},"403":{"content":{"application/json":{"example":{"statusCode":403,"status":"FORBIDDEN","details":["Forbidden."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"example":{"statusCode":404,"status":"NOT_FOUND","details":["Not found."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Not Found"},"409":{"content":{"application/json":{"example":{"statusCode":409,"status":"EXISTS_MUST_BE_UNIQUE","details":["Already exists, must be unique."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Conflict"},"422":{"description":"Unprocessable entity","content":{"application/json":{"example":{"statusCode":422,"status":"ERROR","details":[{"type":"string","loc":["string","string"],"msg":"string","input":"string"}]}}}},"500":{"content":{"application/json":{"example":{"statusCode":500,"status":"FAILED_TO_CREATE_OR_UPDATE","details":["Failed to be created or updated."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Internal Server Error"}}},"delete":{"tags":["apipolicy"],"summary":"Delete API policy.","description":"Delete API policy.","operationId":"delete_api_policy_api_v1_apipolicy__name__delete","parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string","title":"Name of API policy."}},{"name":"Session","in":"cookie","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Session"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusResponse"},"example":{"statusCode":200,"status":"SUCCESSFULLY_DELETED","details":["Successfully deleted."]}}}},"403":{"content":{"application/json":{"example":{"statusCode":403,"status":"FORBIDDEN","details":["Forbidden."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"example":{"statusCode":404,"status":"NOT_FOUND","details":["Not found."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Not Found"},"409":{"content":{"application/json":{"example":{"statusCode":409,"status":"EXISTS_MUST_BE_UNIQUE","details":["Already exists, must be unique."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Conflict"},"422":{"description":"Unprocessable entity","content":{"application/json":{"example":{"statusCode":422,"status":"ERROR","details":[{"type":"string","loc":["string","string"],"msg":"string","input":"string"}]}}}},"500":{"content":{"application/json":{"example":{"statusCode":500,"status":"FAILED_TO_CREATE_OR_UPDATE","details":["Failed to be created or updated."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Internal Server Error"}}}},"/api/v1/owner":{"get":{"tags":["owner"],"summary":"Get all owners.","description":"Get all owners.","operationId":"get_all_owners_api_v1_owner_get","parameters":[{"name":"name","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Full or partial name."}},{"name":"email","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Email address."}},{"name":"created_by","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Email address."}},{"name":"modified_by","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Email address."}},{"name":"Session","in":"cookie","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Session"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OwnerResponse"}}}},"403":{"content":{"application/json":{"example":{"statusCode":403,"status":"FORBIDDEN","details":["Forbidden."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"example":{"statusCode":404,"status":"NOT_FOUND","details":["Not found."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Not Found"},"409":{"content":{"application/json":{"example":{"statusCode":409,"status":"EXISTS_MUST_BE_UNIQUE","details":["Already exists, must be unique."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Conflict"},"422":{"description":"Unprocessable entity","content":{"application/json":{"example":{"statusCode":422,"status":"ERROR","details":[{"type":"string","loc":["string","string"],"msg":"string","input":"string"}]}}}},"500":{"content":{"application/json":{"example":{"statusCode":500,"status":"FAILED_TO_CREATE_OR_UPDATE","details":["Failed to be created or updated."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Internal Server Error"}}},"post":{"tags":["owner"],"summary":"Create new owner.","description":"Creating new owner.","operationId":"create_owner_api_v1_owner_post","parameters":[{"name":"Session","in":"cookie","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Session"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OwnerCreate"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OwnerResponse"}}}},"403":{"content":{"application/json":{"example":{"statusCode":403,"status":"FORBIDDEN","details":["Forbidden."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"example":{"statusCode":404,"status":"NOT_FOUND","details":["Not found."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Not Found"},"409":{"content":{"application/json":{"example":{"statusCode":409,"status":"EXISTS_MUST_BE_UNIQUE","details":["Already exists, must be unique."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Conflict"},"422":{"description":"Unprocessable entity","content":{"application/json":{"example":{"statusCode":422,"status":"ERROR","details":[{"type":"string","loc":["string","string"],"msg":"string","input":"string"}]}}}},"500":{"content":{"application/json":{"example":{"statusCode":500,"status":"FAILED_TO_CREATE_OR_UPDATE","details":["Failed to be created or updated."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Internal Server Error"}}}},"/api/v1/owner/{id}":{"get":{"tags":["owner"],"summary":"Get owner by id.","description":"Returns owner by id.","operationId":"get_owner_by_id_api_v1_owner__id__get","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","title":"Id of owner."}},{"name":"Session","in":"cookie","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Session"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OwnerResponse"}}}},"403":{"content":{"application/json":{"example":{"statusCode":403,"status":"FORBIDDEN","details":["Forbidden."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"example":{"statusCode":404,"status":"NOT_FOUND","details":["Not found."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Not Found"},"409":{"content":{"application/json":{"example":{"statusCode":409,"status":"EXISTS_MUST_BE_UNIQUE","details":["Already exists, must be unique."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Conflict"},"422":{"description":"Unprocessable entity","content":{"application/json":{"example":{"statusCode":422,"status":"ERROR","details":[{"type":"string","loc":["string","string"],"msg":"string","input":"string"}]}}}},"500":{"content":{"application/json":{"example":{"statusCode":500,"status":"FAILED_TO_CREATE_OR_UPDATE","details":["Failed to be created or updated."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Internal Server Error"}}},"put":{"tags":["owner"],"summary":"Update owner.","description":"Update owner.","operationId":"update_owner_api_v1_owner__id__put","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","title":"Id of owner."}},{"name":"Session","in":"cookie","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Session"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OwnerUpdate"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OwnerResponse"}}}},"403":{"content":{"application/json":{"example":{"statusCode":403,"status":"FORBIDDEN","details":["Forbidden."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"example":{"statusCode":404,"status":"NOT_FOUND","details":["Not found."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Not Found"},"409":{"content":{"application/json":{"example":{"statusCode":409,"status":"EXISTS_MUST_BE_UNIQUE","details":["Already exists, must be unique."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Conflict"},"422":{"description":"Unprocessable entity","content":{"application/json":{"example":{"statusCode":422,"status":"ERROR","details":[{"type":"string","loc":["string","string"],"msg":"string","input":"string"}]}}}},"500":{"content":{"application/json":{"example":{"statusCode":500,"status":"FAILED_TO_CREATE_OR_UPDATE","details":["Failed to be created or updated."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Internal Server Error"}}},"delete":{"tags":["owner"],"summary":"Delete owner.","description":"Delete owner.","operationId":"delete_owner_api_v1_owner__id__delete","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","title":"Owner id."}},{"name":"Session","in":"cookie","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Session"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusResponse"},"example":{"statusCode":200,"status":"SUCCESSFULLY_DELETED","details":["Successfully deleted."]}}}},"403":{"content":{"application/json":{"example":{"statusCode":403,"status":"FORBIDDEN","details":["Forbidden."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"example":{"statusCode":404,"status":"NOT_FOUND","details":["Not found."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Not Found"},"409":{"content":{"application/json":{"example":{"statusCode":409,"status":"EXISTS_MUST_BE_UNIQUE","details":["Already exists, must be unique."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Conflict"},"422":{"description":"Unprocessable entity","content":{"application/json":{"example":{"statusCode":422,"status":"ERROR","details":[{"type":"string","loc":["string","string"],"msg":"string","input":"string"}]}}}},"500":{"content":{"application/json":{"example":{"statusCode":500,"status":"FAILED_TO_CREATE_OR_UPDATE","details":["Failed to be created or updated."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Internal Server Error"}}}},"/api/v1/owner/{id}/catalogue":{"get":{"tags":["owner"],"summary":"Get all catalogue items by attached owner.","description":"Return list of catalogue items which has corresponding owner.","operationId":"get_catalogue_by_owner_api_v1_owner__id__catalogue_get","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","title":"Id of owner."}},{"name":"Session","in":"cookie","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Session"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CatalogueResponse"},"title":"Response Get Catalogue By Owner Api V1 Owner  Id  Catalogue Get","$ref":"#/components/schemas/OwnerResponse"}}}},"403":{"content":{"application/json":{"example":{"statusCode":403,"status":"FORBIDDEN","details":["Forbidden."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"example":{"statusCode":404,"status":"NOT_FOUND","details":["Not found."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Not Found"},"409":{"content":{"application/json":{"example":{"statusCode":409,"status":"EXISTS_MUST_BE_UNIQUE","details":["Already exists, must be unique."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Conflict"},"422":{"description":"Unprocessable entity","content":{"application/json":{"example":{"statusCode":422,"status":"ERROR","details":[{"type":"string","loc":["string","string"],"msg":"string","input":"string"}]}}}},"500":{"content":{"application/json":{"example":{"statusCode":500,"status":"FAILED_TO_CREATE_OR_UPDATE","details":["Failed to be created or updated."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Internal Server Error"}}}},"/api/v1/throttling":{"get":{"tags":["throttling"],"summary":"Get all throttling.","description":"Get all throttling.","operationId":"get_all_throttling_api_v1_throttling_get","parameters":[{"name":"Session","in":"cookie","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Session"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingResponse"}}}},"403":{"content":{"application/json":{"example":{"statusCode":403,"status":"FORBIDDEN","details":["Forbidden."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"example":{"statusCode":404,"status":"NOT_FOUND","details":["Not found."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Not Found"},"409":{"content":{"application/json":{"example":{"statusCode":409,"status":"EXISTS_MUST_BE_UNIQUE","details":["Already exists, must be unique."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Conflict"},"422":{"description":"Unprocessable entity","content":{"application/json":{"example":{"statusCode":422,"status":"ERROR","details":[{"type":"string","loc":["string","string"],"msg":"string","input":"string"}]}}}},"500":{"content":{"application/json":{"example":{"statusCode":500,"status":"FAILED_TO_CREATE_OR_UPDATE","details":["Failed to be created or updated."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Internal Server Error"}}},"post":{"tags":["throttling"],"summary":"Create new throttling.","description":"Creating new throttling.","operationId":"create_throttling_api_v1_throttling_post","parameters":[{"name":"Session","in":"cookie","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Session"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingCreate"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingResponse"}}}},"403":{"content":{"application/json":{"example":{"statusCode":403,"status":"FORBIDDEN","details":["Forbidden."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"example":{"statusCode":404,"status":"NOT_FOUND","details":["Not found."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Not Found"},"409":{"content":{"application/json":{"example":{"statusCode":409,"status":"EXISTS_MUST_BE_UNIQUE","details":["Already exists, must be unique."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Conflict"},"422":{"description":"Unprocessable entity","content":{"application/json":{"example":{"statusCode":422,"status":"ERROR","details":[{"type":"string","loc":["string","string"],"msg":"string","input":"string"}]}}}},"500":{"content":{"application/json":{"example":{"statusCode":500,"status":"FAILED_TO_CREATE_OR_UPDATE","details":["Failed to be created or updated."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Internal Server Error"}}}},"/api/v1/throttling/{id}":{"get":{"tags":["throttling"],"summary":"Get throttling by id.","description":"Returns throttling by id.","operationId":"get_throttling_by_id_api_v1_throttling__id__get","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","title":"Id of throttling."}},{"name":"Session","in":"cookie","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Session"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingResponse"}}}},"403":{"content":{"application/json":{"example":{"statusCode":403,"status":"FORBIDDEN","details":["Forbidden."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"example":{"statusCode":404,"status":"NOT_FOUND","details":["Not found."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Not Found"},"409":{"content":{"application/json":{"example":{"statusCode":409,"status":"EXISTS_MUST_BE_UNIQUE","details":["Already exists, must be unique."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Conflict"},"422":{"description":"Unprocessable entity","content":{"application/json":{"example":{"statusCode":422,"status":"ERROR","details":[{"type":"string","loc":["string","string"],"msg":"string","input":"string"}]}}}},"500":{"content":{"application/json":{"example":{"statusCode":500,"status":"FAILED_TO_CREATE_OR_UPDATE","details":["Failed to be created or updated."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Internal Server Error"}}},"put":{"tags":["throttling"],"summary":"Update throttling.","description":"Update throttling.","operationId":"update_throttling_api_v1_throttling__id__put","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","title":"Id of throttling."}},{"name":"Session","in":"cookie","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Session"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingUpdate"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingResponse"}}}},"403":{"content":{"application/json":{"example":{"statusCode":403,"status":"FORBIDDEN","details":["Forbidden."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"example":{"statusCode":404,"status":"NOT_FOUND","details":["Not found."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Not Found"},"409":{"content":{"application/json":{"example":{"statusCode":409,"status":"EXISTS_MUST_BE_UNIQUE","details":["Already exists, must be unique."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Conflict"},"422":{"description":"Unprocessable entity","content":{"application/json":{"example":{"statusCode":422,"status":"ERROR","details":[{"type":"string","loc":["string","string"],"msg":"string","input":"string"}]}}}},"500":{"content":{"application/json":{"example":{"statusCode":500,"status":"FAILED_TO_CREATE_OR_UPDATE","details":["Failed to be created or updated."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Internal Server Error"}}},"delete":{"tags":["throttling"],"summary":"Delete throttling.","description":"Delete throttling.","operationId":"delete_throttling_api_v1_throttling__id__delete","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","title":"Throttling id."}},{"name":"Session","in":"cookie","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Session"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusResponse"},"example":{"statusCode":200,"status":"SUCCESSFULLY_DELETED","details":["Successfully deleted."]}}}},"403":{"content":{"application/json":{"example":{"statusCode":403,"status":"FORBIDDEN","details":["Forbidden."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"example":{"statusCode":404,"status":"NOT_FOUND","details":["Not found."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Not Found"},"409":{"content":{"application/json":{"example":{"statusCode":409,"status":"EXISTS_MUST_BE_UNIQUE","details":["Already exists, must be unique."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Conflict"},"422":{"description":"Unprocessable entity","content":{"application/json":{"example":{"statusCode":422,"status":"ERROR","details":[{"type":"string","loc":["string","string"],"msg":"string","input":"string"}]}}}},"500":{"content":{"application/json":{"example":{"statusCode":500,"status":"FAILED_TO_CREATE_OR_UPDATE","details":["Failed to be created or updated."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Internal Server Error"}}}},"/api/v1/throttling/catalogue/{id}":{"get":{"tags":["throttling"],"summary":"Get throttling by catalogue id.","description":"Returns throttlings by catalogue id.","operationId":"get_throttling_by_catalogue_id_api_v1_throttling_catalogue__id__get","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","title":"Id of catalogue."}},{"name":"by_type","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/ThrottlingType"},{"type":"null"}],"description":"Filter by type.","title":"By Type"},"description":"Filter by type."},{"name":"Session","in":"cookie","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Session"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingResponse"}}}},"403":{"content":{"application/json":{"example":{"statusCode":403,"status":"FORBIDDEN","details":["Forbidden."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"example":{"statusCode":404,"status":"NOT_FOUND","details":["Not found."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Not Found"},"409":{"content":{"application/json":{"example":{"statusCode":409,"status":"EXISTS_MUST_BE_UNIQUE","details":["Already exists, must be unique."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Conflict"},"422":{"description":"Unprocessable entity","content":{"application/json":{"example":{"statusCode":422,"status":"ERROR","details":[{"type":"string","loc":["string","string"],"msg":"string","input":"string"}]}}}},"500":{"content":{"application/json":{"example":{"statusCode":500,"status":"FAILED_TO_CREATE_OR_UPDATE","details":["Failed to be created or updated."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Internal Server Error"}}}},"/api/v1/environment":{"get":{"tags":["environment"],"summary":"Get all environments.","description":"Get all environments.","operationId":"get_all_environments_api_v1_environment_get","parameters":[{"name":"Session","in":"cookie","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Session"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnvironmentResponse"}}}},"403":{"content":{"application/json":{"example":{"statusCode":403,"status":"FORBIDDEN","details":["Forbidden."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"example":{"statusCode":404,"status":"NOT_FOUND","details":["Not found."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Not Found"},"409":{"content":{"application/json":{"example":{"statusCode":409,"status":"EXISTS_MUST_BE_UNIQUE","details":["Already exists, must be unique."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Conflict"},"422":{"description":"Unprocessable entity","content":{"application/json":{"example":{"statusCode":422,"status":"ERROR","details":[{"type":"string","loc":["string","string"],"msg":"string","input":"string"}]}}}},"500":{"content":{"application/json":{"example":{"statusCode":500,"status":"FAILED_TO_CREATE_OR_UPDATE","details":["Failed to be created or updated."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Internal Server Error"}}},"post":{"tags":["environment"],"summary":"Create new environment.","description":"Creating new environment.","operationId":"create_environment_api_v1_environment_post","parameters":[{"name":"Session","in":"cookie","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Session"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnvironmentCreate"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnvironmentResponse"}}}},"403":{"content":{"application/json":{"example":{"statusCode":403,"status":"FORBIDDEN","details":["Forbidden."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"example":{"statusCode":404,"status":"NOT_FOUND","details":["Not found."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Not Found"},"409":{"content":{"application/json":{"example":{"statusCode":409,"status":"EXISTS_MUST_BE_UNIQUE","details":["Already exists, must be unique."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Conflict"},"422":{"description":"Unprocessable entity","content":{"application/json":{"example":{"statusCode":422,"status":"ERROR","details":[{"type":"string","loc":["string","string"],"msg":"string","input":"string"}]}}}},"500":{"content":{"application/json":{"example":{"statusCode":500,"status":"FAILED_TO_CREATE_OR_UPDATE","details":["Failed to be created or updated."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Internal Server Error"}}}},"/api/v1/environment/{id}":{"get":{"tags":["environment"],"summary":"Get environments by id.","description":"Returns environment by id.","operationId":"get_environment_by_id_api_v1_environment__id__get","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","title":"Id of environment."}},{"name":"Session","in":"cookie","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Session"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnvironmentResponse"}}}},"403":{"content":{"application/json":{"example":{"statusCode":403,"status":"FORBIDDEN","details":["Forbidden."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"example":{"statusCode":404,"status":"NOT_FOUND","details":["Not found."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Not Found"},"409":{"content":{"application/json":{"example":{"statusCode":409,"status":"EXISTS_MUST_BE_UNIQUE","details":["Already exists, must be unique."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Conflict"},"422":{"description":"Unprocessable entity","content":{"application/json":{"example":{"statusCode":422,"status":"ERROR","details":[{"type":"string","loc":["string","string"],"msg":"string","input":"string"}]}}}},"500":{"content":{"application/json":{"example":{"statusCode":500,"status":"FAILED_TO_CREATE_OR_UPDATE","details":["Failed to be created or updated."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Internal Server Error"}}},"put":{"tags":["environment"],"summary":"Update environment.","description":"Update environment.","operationId":"update_environment_api_v1_environment__id__put","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","title":"Id of environment."}},{"name":"Session","in":"cookie","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Session"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnvironmentUpdate"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnvironmentResponse"}}}},"403":{"content":{"application/json":{"example":{"statusCode":403,"status":"FORBIDDEN","details":["Forbidden."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"example":{"statusCode":404,"status":"NOT_FOUND","details":["Not found."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Not Found"},"409":{"content":{"application/json":{"example":{"statusCode":409,"status":"EXISTS_MUST_BE_UNIQUE","details":["Already exists, must be unique."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Conflict"},"422":{"description":"Unprocessable entity","content":{"application/json":{"example":{"statusCode":422,"status":"ERROR","details":[{"type":"string","loc":["string","string"],"msg":"string","input":"string"}]}}}},"500":{"content":{"application/json":{"example":{"statusCode":500,"status":"FAILED_TO_CREATE_OR_UPDATE","details":["Failed to be created or updated."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Internal Server Error"}}},"delete":{"tags":["environment"],"summary":"Delete environment.","description":"Delete environment.","operationId":"delete_environment_api_v1_environment__id__delete","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","title":"Environment id."}},{"name":"Session","in":"cookie","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Session"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusResponse"},"example":{"statusCode":200,"status":"SUCCESSFULLY_DELETED","details":["Successfully deleted."]}}}},"403":{"content":{"application/json":{"example":{"statusCode":403,"status":"FORBIDDEN","details":["Forbidden."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"example":{"statusCode":404,"status":"NOT_FOUND","details":["Not found."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Not Found"},"409":{"content":{"application/json":{"example":{"statusCode":409,"status":"EXISTS_MUST_BE_UNIQUE","details":["Already exists, must be unique."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Conflict"},"422":{"description":"Unprocessable entity","content":{"application/json":{"example":{"statusCode":422,"status":"ERROR","details":[{"type":"string","loc":["string","string"],"msg":"string","input":"string"}]}}}},"500":{"content":{"application/json":{"example":{"statusCode":500,"status":"FAILED_TO_CREATE_OR_UPDATE","details":["Failed to be created or updated."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Internal Server Error"}}}},"/api/v1/environment/catalogue/{id}":{"get":{"tags":["environment"],"summary":"Get environment by catalogue id.","description":"Returns environment by catalogue id.","operationId":"get_environment_by_catalogue_id_api_v1_environment_catalogue__id__get","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","title":"Id of catalogue."}},{"name":"Session","in":"cookie","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Session"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnvironmentResponse"}}}},"403":{"content":{"application/json":{"example":{"statusCode":403,"status":"FORBIDDEN","details":["Forbidden."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"example":{"statusCode":404,"status":"NOT_FOUND","details":["Not found."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Not Found"},"409":{"content":{"application/json":{"example":{"statusCode":409,"status":"EXISTS_MUST_BE_UNIQUE","details":["Already exists, must be unique."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Conflict"},"422":{"description":"Unprocessable entity","content":{"application/json":{"example":{"statusCode":422,"status":"ERROR","details":[{"type":"string","loc":["string","string"],"msg":"string","input":"string"}]}}}},"500":{"content":{"application/json":{"example":{"statusCode":500,"status":"FAILED_TO_CREATE_OR_UPDATE","details":["Failed to be created or updated."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Internal Server Error"}}}},"/api/v1/catalogue":{"get":{"tags":["catalogue"],"summary":"Get API catalogue items.","description":"Get all catalogue.","operationId":"get_catalogues_api_v1_catalogue_get","parameters":[{"name":"search","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Search term target name, user facing name or description."}},{"name":"category","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"title":"Category ID filter (multiselect)."}},{"name":"policy","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"title":"API policy name filter (multiselect)."}},{"name":"lifecycle","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"title":"Production lifecycle filter (multiselect)."}},{"name":"owner","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Owner (email) filter."}},{"name":"history","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Created by or modified by (email) filter."}},{"name":"Session","in":"cookie","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Session"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CatalogueResponse"}}}},"403":{"content":{"application/json":{"example":{"statusCode":403,"status":"FORBIDDEN","details":["Forbidden."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"example":{"statusCode":404,"status":"NOT_FOUND","details":["Not found."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Not Found"},"409":{"content":{"application/json":{"example":{"statusCode":409,"status":"EXISTS_MUST_BE_UNIQUE","details":["Already exists, must be unique."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Conflict"},"422":{"description":"Unprocessable entity","content":{"application/json":{"example":{"statusCode":422,"status":"ERROR","details":[{"type":"string","loc":["string","string"],"msg":"string","input":"string"}]}}}},"500":{"content":{"application/json":{"example":{"statusCode":500,"status":"FAILED_TO_CREATE_OR_UPDATE","details":["Failed to be created or updated."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Internal Server Error"}}},"post":{"tags":["catalogue"],"summary":"Create catalogue item.","description":"Create catalogue item.","operationId":"create_catalogue_item_api_v1_catalogue_post","parameters":[{"name":"Session","in":"cookie","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Session"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CatalogueCreate"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CatalogueResponse"}}}},"403":{"content":{"application/json":{"example":{"statusCode":403,"status":"FORBIDDEN","details":["Forbidden."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"example":{"statusCode":404,"status":"NOT_FOUND","details":["Not found."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Not Found"},"409":{"content":{"application/json":{"example":{"statusCode":409,"status":"EXISTS_MUST_BE_UNIQUE","details":["Already exists, must be unique."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Conflict"},"422":{"description":"Unprocessable entity","content":{"application/json":{"example":{"statusCode":422,"status":"ERROR","details":[{"type":"string","loc":["string","string"],"msg":"string","input":"string"}]}}}},"500":{"content":{"application/json":{"example":{"statusCode":500,"status":"FAILED_TO_CREATE_OR_UPDATE","details":["Failed to be created or updated."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Internal Server Error"}}}},"/api/v1/catalogue/{id}":{"get":{"tags":["catalogue"],"summary":"Get catalogue item by id.","description":"Returns catalogue item by id.","operationId":"get_catalogue_item_by_id_api_v1_catalogue__id__get","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","title":"Id of catalogue item."}},{"name":"Session","in":"cookie","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Session"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CatalogueResponse"}}}},"403":{"content":{"application/json":{"example":{"statusCode":403,"status":"FORBIDDEN","details":["Forbidden."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"example":{"statusCode":404,"status":"NOT_FOUND","details":["Not found."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Not Found"},"409":{"content":{"application/json":{"example":{"statusCode":409,"status":"EXISTS_MUST_BE_UNIQUE","details":["Already exists, must be unique."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Conflict"},"422":{"description":"Unprocessable entity","content":{"application/json":{"example":{"statusCode":422,"status":"ERROR","details":[{"type":"string","loc":["string","string"],"msg":"string","input":"string"}]}}}},"500":{"content":{"application/json":{"example":{"statusCode":500,"status":"FAILED_TO_CREATE_OR_UPDATE","details":["Failed to be created or updated."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Internal Server Error"}}},"patch":{"tags":["catalogue"],"summary":"Update (partial) catalogue item.","description":"Update catalogue item with PATCH.","operationId":"update_catalogue_item_patch_api_v1_catalogue__id__patch","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","title":"Id of catalogue item."}},{"name":"Session","in":"cookie","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Session"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CatalogueUpdate"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CatalogueResponse"}}}},"403":{"content":{"application/json":{"example":{"statusCode":403,"status":"FORBIDDEN","details":["Forbidden."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"example":{"statusCode":404,"status":"NOT_FOUND","details":["Not found."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Not Found"},"409":{"content":{"application/json":{"example":{"statusCode":409,"status":"EXISTS_MUST_BE_UNIQUE","details":["Already exists, must be unique."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Conflict"},"422":{"description":"Unprocessable entity","content":{"application/json":{"example":{"statusCode":422,"status":"ERROR","details":[{"type":"string","loc":["string","string"],"msg":"string","input":"string"}]}}}},"500":{"content":{"application/json":{"example":{"statusCode":500,"status":"FAILED_TO_CREATE_OR_UPDATE","details":["Failed to be created or updated."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Internal Server Error"}}},"delete":{"tags":["catalogue"],"summary":"Delete catalogue item.","description":"Delete catalogue item.","operationId":"delete_catalogue_item_api_v1_catalogue__id__delete","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","title":"Catalogue item id."}},{"name":"Session","in":"cookie","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Session"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusResponse"},"example":{"statusCode":200,"status":"SUCCESSFULLY_DELETED","details":["Successfully deleted."]}}}},"403":{"content":{"application/json":{"example":{"statusCode":403,"status":"FORBIDDEN","details":["Forbidden."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"example":{"statusCode":404,"status":"NOT_FOUND","details":["Not found."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Not Found"},"409":{"content":{"application/json":{"example":{"statusCode":409,"status":"EXISTS_MUST_BE_UNIQUE","details":["Already exists, must be unique."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Conflict"},"422":{"description":"Unprocessable entity","content":{"application/json":{"example":{"statusCode":422,"status":"ERROR","details":[{"type":"string","loc":["string","string"],"msg":"string","input":"string"}]}}}},"500":{"content":{"application/json":{"example":{"statusCode":500,"status":"FAILED_TO_CREATE_OR_UPDATE","details":["Failed to be created or updated."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Internal Server Error"}}}},"/api/v1/catalogue/targetname/{target_name}":{"get":{"tags":["catalogue"],"summary":"Get catalogue by target name.","description":"Returns catalogue item by target name.","operationId":"get_catalogue_by_target_name_api_v1_catalogue_targetname__target_name__get","parameters":[{"name":"target_name","in":"path","required":true,"schema":{"type":"string","title":"Target name catalogue item."}},{"name":"Session","in":"cookie","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Session"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CatalogueResponse"}}}},"403":{"content":{"application/json":{"example":{"statusCode":403,"status":"FORBIDDEN","details":["Forbidden."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"example":{"statusCode":404,"status":"NOT_FOUND","details":["Not found."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Not Found"},"409":{"content":{"application/json":{"example":{"statusCode":409,"status":"EXISTS_MUST_BE_UNIQUE","details":["Already exists, must be unique."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Conflict"},"422":{"description":"Unprocessable entity","content":{"application/json":{"example":{"statusCode":422,"status":"ERROR","details":[{"type":"string","loc":["string","string"],"msg":"string","input":"string"}]}}}},"500":{"content":{"application/json":{"example":{"statusCode":500,"status":"FAILED_TO_CREATE_OR_UPDATE","details":["Failed to be created or updated."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Internal Server Error"}}}},"/api/v1/public/catalogue/targetname/{target_name}/environment":{"get":{"tags":["public"],"summary":"Get environment by catalogue target name.","description":"Returns environment by catalogue target name.","operationId":"get_environment_by_catalogue_target_name_api_v1_public_catalogue_targetname__target_name__environment_get","parameters":[{"name":"target_name","in":"path","required":true,"schema":{"type":"string","title":"Target name of catalogue."}},{"name":"active_business_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Active organization of current user"}},{"name":"Session","in":"cookie","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Session"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnvironmentResponsePublic"}}}},"403":{"content":{"application/json":{"example":{"statusCode":403,"status":"FORBIDDEN","details":["Forbidden."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"example":{"statusCode":404,"status":"NOT_FOUND","details":["Not found."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Not Found"},"409":{"content":{"application/json":{"example":{"statusCode":409,"status":"EXISTS_MUST_BE_UNIQUE","details":["Already exists, must be unique."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Conflict"},"422":{"description":"Unprocessable entity","content":{"application/json":{"example":{"statusCode":422,"status":"ERROR","details":[{"type":"string","loc":["string","string"],"msg":"string","input":"string"}]}}}},"500":{"content":{"application/json":{"example":{"statusCode":500,"status":"FAILED_TO_CREATE_OR_UPDATE","details":["Failed to be created or updated."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Internal Server Error"}}}},"/api/v1/public/catalogue/{id}/environment":{"get":{"tags":["public"],"summary":"Get environment by catalogue id.","description":"Returns environment by catalogue id.","operationId":"get_environment_by_catalogue_id_api_v1_public_catalogue__id__environment_get","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","title":"Id of catalogue."}},{"name":"active_business_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Active organization of current user"}},{"name":"Session","in":"cookie","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Session"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnvironmentResponsePublic"}}}},"403":{"content":{"application/json":{"example":{"statusCode":403,"status":"FORBIDDEN","details":["Forbidden."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"example":{"statusCode":404,"status":"NOT_FOUND","details":["Not found."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Not Found"},"409":{"content":{"application/json":{"example":{"statusCode":409,"status":"EXISTS_MUST_BE_UNIQUE","details":["Already exists, must be unique."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Conflict"},"422":{"description":"Unprocessable entity","content":{"application/json":{"example":{"statusCode":422,"status":"ERROR","details":[{"type":"string","loc":["string","string"],"msg":"string","input":"string"}]}}}},"500":{"content":{"application/json":{"example":{"statusCode":500,"status":"FAILED_TO_CREATE_OR_UPDATE","details":["Failed to be created or updated."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Internal Server Error"}}}},"/api/v1/public/catalogue":{"get":{"tags":["public"],"summary":"Get API catalogue.","description":"Get all catalogue.","operationId":"get_catalogue_api_v1_public_catalogue_get","parameters":[{"name":"active_business_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Active organization of current user"}},{"name":"Session","in":"cookie","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Session"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CatalogueResponsePublic"},"title":"Response Get Catalogue Api V1 Public Catalogue Get"}}}},"403":{"content":{"application/json":{"example":{"statusCode":403,"status":"FORBIDDEN","details":["Forbidden."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"example":{"statusCode":404,"status":"NOT_FOUND","details":["Not found."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Not Found"},"409":{"content":{"application/json":{"example":{"statusCode":409,"status":"EXISTS_MUST_BE_UNIQUE","details":["Already exists, must be unique."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Conflict"},"422":{"description":"Unprocessable entity","content":{"application/json":{"example":{"statusCode":422,"status":"ERROR","details":[{"type":"string","loc":["string","string"],"msg":"string","input":"string"}]}}}},"500":{"content":{"application/json":{"example":{"statusCode":500,"status":"FAILED_TO_CREATE_OR_UPDATE","details":["Failed to be created or updated."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Internal Server Error"}}}},"/api/v1/public/catalogue/targetname/{target_name}":{"get":{"tags":["public"],"summary":"Get catalogue item by target name.","description":"Returns catalogue item by id.","operationId":"get_catalogue_item_by_target_name_api_v1_public_catalogue_targetname__target_name__get","parameters":[{"name":"target_name","in":"path","required":true,"schema":{"type":"string","title":"Target name of catalogue item."}},{"name":"active_business_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Active organization of current user"}},{"name":"Session","in":"cookie","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Session"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CatalogueResponsePublic"}}}},"403":{"content":{"application/json":{"example":{"statusCode":403,"status":"FORBIDDEN","details":["Forbidden."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"example":{"statusCode":404,"status":"NOT_FOUND","details":["Not found."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Not Found"},"409":{"content":{"application/json":{"example":{"statusCode":409,"status":"EXISTS_MUST_BE_UNIQUE","details":["Already exists, must be unique."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Conflict"},"422":{"description":"Unprocessable entity","content":{"application/json":{"example":{"statusCode":422,"status":"ERROR","details":[{"type":"string","loc":["string","string"],"msg":"string","input":"string"}]}}}},"500":{"content":{"application/json":{"example":{"statusCode":500,"status":"FAILED_TO_CREATE_OR_UPDATE","details":["Failed to be created or updated."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Internal Server Error"}}}},"/api/v1/public/catalogue/{id}":{"get":{"tags":["public"],"summary":"Get catalogue item by id.","description":"Returns catalogue item by id.","operationId":"get_catalogue_item_by_id_api_v1_public_catalogue__id__get","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","title":"Id of catalogue item."}},{"name":"active_business_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Active organization of current user"}},{"name":"Session","in":"cookie","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Session"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CatalogueResponsePublic"}}}},"403":{"content":{"application/json":{"example":{"statusCode":403,"status":"FORBIDDEN","details":["Forbidden."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"example":{"statusCode":404,"status":"NOT_FOUND","details":["Not found."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Not Found"},"409":{"content":{"application/json":{"example":{"statusCode":409,"status":"EXISTS_MUST_BE_UNIQUE","details":["Already exists, must be unique."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Conflict"},"422":{"description":"Unprocessable entity","content":{"application/json":{"example":{"statusCode":422,"status":"ERROR","details":[{"type":"string","loc":["string","string"],"msg":"string","input":"string"}]}}}},"500":{"content":{"application/json":{"example":{"statusCode":500,"status":"FAILED_TO_CREATE_OR_UPDATE","details":["Failed to be created or updated."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Internal Server Error"}}}},"/api/v1/public/pages":{"get":{"tags":["public"],"summary":"Get pages.","description":"Get all pages.","operationId":"get_pages_api_v1_public_pages_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/PageResponsePublic"},"type":"array","title":"Response Get Pages Api V1 Public Pages Get"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusResponse"},"example":{"statusCode":403,"status":"FORBIDDEN","details":["Forbidden."]}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusResponse"},"example":{"statusCode":404,"status":"NOT_FOUND","details":["Not found."]}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusResponse"},"example":{"statusCode":409,"status":"EXISTS_MUST_BE_UNIQUE","details":["Already exists, must be unique."]}}}},"422":{"description":"Unprocessable entity","content":{"application/json":{"example":{"statusCode":422,"status":"ERROR","details":[{"type":"string","loc":["string","string"],"msg":"string","input":"string"}]}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusResponse"},"example":{"statusCode":500,"status":"FAILED_TO_CREATE_OR_UPDATE","details":["Failed to be created or updated."]}}}}}}},"/api/v1/public/page-parent":{"get":{"tags":["public"],"summary":"Get page parents with relevant child pages.","description":"Get parents with child pages.","operationId":"get_parents_with_child_pages_api_v1_public_page_parent_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/PageParentWithChildrenResponsePublic"},"type":"array","title":"Response Get Parents With Child Pages Api V1 Public Page Parent Get"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusResponse"},"example":{"statusCode":403,"status":"FORBIDDEN","details":["Forbidden."]}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusResponse"},"example":{"statusCode":404,"status":"NOT_FOUND","details":["Not found."]}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusResponse"},"example":{"statusCode":409,"status":"EXISTS_MUST_BE_UNIQUE","details":["Already exists, must be unique."]}}}},"422":{"description":"Unprocessable entity","content":{"application/json":{"example":{"statusCode":422,"status":"ERROR","details":[{"type":"string","loc":["string","string"],"msg":"string","input":"string"}]}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusResponse"},"example":{"statusCode":500,"status":"FAILED_TO_CREATE_OR_UPDATE","details":["Failed to be created or updated."]}}}}}}},"/api/v1/public/pages/{id}":{"get":{"tags":["public"],"summary":"Get page by id.","description":"Get page by id.","operationId":"get_page_by_id_api_v1_public_pages__id__get","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","title":"Page id."}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageResponseWithDocumentPublic"}}}},"403":{"content":{"application/json":{"example":{"statusCode":403,"status":"FORBIDDEN","details":["Forbidden."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"example":{"statusCode":404,"status":"NOT_FOUND","details":["Not found."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Not Found"},"409":{"content":{"application/json":{"example":{"statusCode":409,"status":"EXISTS_MUST_BE_UNIQUE","details":["Already exists, must be unique."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Conflict"},"422":{"description":"Unprocessable entity","content":{"application/json":{"example":{"statusCode":422,"status":"ERROR","details":[{"type":"string","loc":["string","string"],"msg":"string","input":"string"}]}}}},"500":{"content":{"application/json":{"example":{"statusCode":500,"status":"FAILED_TO_CREATE_OR_UPDATE","details":["Failed to be created or updated."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Internal Server Error"}}}},"/api/v1/public/pages/docref/{doc_ref}":{"get":{"tags":["public"],"summary":"Get page for doc_ref.","description":"Get document model by doc_ref.","operationId":"get_page_by_doc_ref_api_v1_public_pages_docref__doc_ref__get","parameters":[{"name":"doc_ref","in":"path","required":true,"schema":{"type":"string","title":"Doc Ref"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageResponseWithDocumentPublic"}}}},"403":{"content":{"application/json":{"example":{"statusCode":403,"status":"FORBIDDEN","details":["Forbidden."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"example":{"statusCode":404,"status":"NOT_FOUND","details":["Not found."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Not Found"},"409":{"content":{"application/json":{"example":{"statusCode":409,"status":"EXISTS_MUST_BE_UNIQUE","details":["Already exists, must be unique."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Conflict"},"422":{"description":"Unprocessable entity","content":{"application/json":{"example":{"statusCode":422,"status":"ERROR","details":[{"type":"string","loc":["string","string"],"msg":"string","input":"string"}]}}}},"500":{"content":{"application/json":{"example":{"statusCode":500,"status":"FAILED_TO_CREATE_OR_UPDATE","details":["Failed to be created or updated."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Internal Server Error"}}}},"/api/v1/public/category-catalogue":{"get":{"tags":["public"],"summary":"Get categories with mapped catalogue.","description":"Get categories with catalogue.","operationId":"get_categories_with_catalogue_api_v1_public_category_catalogue_get","parameters":[{"name":"active_business_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Active organization of current user"}},{"name":"Session","in":"cookie","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Session"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CategoryCatalogueMap"},"title":"Response Get Categories With Catalogue Api V1 Public Category Catalogue Get"}}}},"403":{"content":{"application/json":{"example":{"statusCode":403,"status":"FORBIDDEN","details":["Forbidden."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"example":{"statusCode":404,"status":"NOT_FOUND","details":["Not found."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Not Found"},"409":{"content":{"application/json":{"example":{"statusCode":409,"status":"EXISTS_MUST_BE_UNIQUE","details":["Already exists, must be unique."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Conflict"},"422":{"description":"Unprocessable entity","content":{"application/json":{"example":{"statusCode":422,"status":"ERROR","details":[{"type":"string","loc":["string","string"],"msg":"string","input":"string"}]}}}},"500":{"content":{"application/json":{"example":{"statusCode":500,"status":"FAILED_TO_CREATE_OR_UPDATE","details":["Failed to be created or updated."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Internal Server Error"}}}},"/api/v1/category":{"get":{"tags":["category"],"summary":"Get all categories.","description":"Get all categories.","operationId":"get_all_categories_api_v1_category_get","parameters":[{"name":"Session","in":"cookie","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Session"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CategoryResponse"},"title":"Response Get All Categories Api V1 Category Get"}}}},"403":{"content":{"application/json":{"example":{"statusCode":403,"status":"FORBIDDEN","details":["Forbidden."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"example":{"statusCode":404,"status":"NOT_FOUND","details":["Not found."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Not Found"},"409":{"content":{"application/json":{"example":{"statusCode":409,"status":"EXISTS_MUST_BE_UNIQUE","details":["Already exists, must be unique."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Conflict"},"422":{"description":"Unprocessable entity","content":{"application/json":{"example":{"statusCode":422,"status":"ERROR","details":[{"type":"string","loc":["string","string"],"msg":"string","input":"string"}]}}}},"500":{"content":{"application/json":{"example":{"statusCode":500,"status":"FAILED_TO_CREATE_OR_UPDATE","details":["Failed to be created or updated."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Internal Server Error"}}},"post":{"tags":["category"],"summary":"Create new category.","description":"Creating new category.","operationId":"create_category_api_v1_category_post","parameters":[{"name":"Session","in":"cookie","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Session"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CategoryCreate"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CategoryResponse"}}}},"403":{"content":{"application/json":{"example":{"statusCode":403,"status":"FORBIDDEN","details":["Forbidden."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"example":{"statusCode":404,"status":"NOT_FOUND","details":["Not found."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Not Found"},"409":{"content":{"application/json":{"example":{"statusCode":409,"status":"EXISTS_MUST_BE_UNIQUE","details":["Already exists, must be unique."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Conflict"},"422":{"description":"Unprocessable entity","content":{"application/json":{"example":{"statusCode":422,"status":"ERROR","details":[{"type":"string","loc":["string","string"],"msg":"string","input":"string"}]}}}},"500":{"content":{"application/json":{"example":{"statusCode":500,"status":"FAILED_TO_CREATE_OR_UPDATE","details":["Failed to be created or updated."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Internal Server Error"}}}},"/api/v1/category/{id}":{"get":{"tags":["category"],"summary":"Get category by id.","description":"Get category by id.","operationId":"get_category_by_id_api_v1_category__id__get","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","title":"Category id."}},{"name":"Session","in":"cookie","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Session"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CategoryResponse"}}}},"403":{"content":{"application/json":{"example":{"statusCode":403,"status":"FORBIDDEN","details":["Forbidden."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"example":{"statusCode":404,"status":"NOT_FOUND","details":["Not found."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Not Found"},"409":{"content":{"application/json":{"example":{"statusCode":409,"status":"EXISTS_MUST_BE_UNIQUE","details":["Already exists, must be unique."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Conflict"},"422":{"description":"Unprocessable entity","content":{"application/json":{"example":{"statusCode":422,"status":"ERROR","details":[{"type":"string","loc":["string","string"],"msg":"string","input":"string"}]}}}},"500":{"content":{"application/json":{"example":{"statusCode":500,"status":"FAILED_TO_CREATE_OR_UPDATE","details":["Failed to be created or updated."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Internal Server Error"}}},"put":{"tags":["category"],"summary":"Update category.","description":"Update category.","operationId":"update_environment_api_v1_category__id__put","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","title":"Category id."}},{"name":"Session","in":"cookie","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Session"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CategoryUpdate"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CategoryResponse"}}}},"403":{"content":{"application/json":{"example":{"statusCode":403,"status":"FORBIDDEN","details":["Forbidden."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"example":{"statusCode":404,"status":"NOT_FOUND","details":["Not found."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Not Found"},"409":{"content":{"application/json":{"example":{"statusCode":409,"status":"EXISTS_MUST_BE_UNIQUE","details":["Already exists, must be unique."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Conflict"},"422":{"description":"Unprocessable entity","content":{"application/json":{"example":{"statusCode":422,"status":"ERROR","details":[{"type":"string","loc":["string","string"],"msg":"string","input":"string"}]}}}},"500":{"content":{"application/json":{"example":{"statusCode":500,"status":"FAILED_TO_CREATE_OR_UPDATE","details":["Failed to be created or updated."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Internal Server Error"}}},"delete":{"tags":["category"],"summary":"Delete category.","description":"Delete category.","operationId":"delete_category_api_v1_category__id__delete","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","title":"Category id."}},{"name":"Session","in":"cookie","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Session"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusResponse"},"example":{"statusCode":200,"status":"SUCCESSFULLY_DELETED","details":["Successfully deleted."]}}}},"403":{"content":{"application/json":{"example":{"statusCode":403,"status":"FORBIDDEN","details":["Forbidden."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"example":{"statusCode":404,"status":"NOT_FOUND","details":["Not found."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Not Found"},"409":{"content":{"application/json":{"example":{"statusCode":409,"status":"EXISTS_MUST_BE_UNIQUE","details":["Already exists, must be unique."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Conflict"},"422":{"description":"Unprocessable entity","content":{"application/json":{"example":{"statusCode":422,"status":"ERROR","details":[{"type":"string","loc":["string","string"],"msg":"string","input":"string"}]}}}},"500":{"content":{"application/json":{"example":{"statusCode":500,"status":"FAILED_TO_CREATE_OR_UPDATE","details":["Failed to be created or updated."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Internal Server Error"}}}},"/api/v1/page":{"get":{"tags":["page"],"summary":"Get pages.","description":"Get all pages.","operationId":"get_pages_api_v1_page_get","parameters":[{"name":"Session","in":"cookie","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Session"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PageResponse"},"title":"Response Get Pages Api V1 Page Get"}}}},"403":{"content":{"application/json":{"example":{"statusCode":403,"status":"FORBIDDEN","details":["Forbidden."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"example":{"statusCode":404,"status":"NOT_FOUND","details":["Not found."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Not Found"},"409":{"content":{"application/json":{"example":{"statusCode":409,"status":"EXISTS_MUST_BE_UNIQUE","details":["Already exists, must be unique."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Conflict"},"422":{"description":"Unprocessable entity","content":{"application/json":{"example":{"statusCode":422,"status":"ERROR","details":[{"type":"string","loc":["string","string"],"msg":"string","input":"string"}]}}}},"500":{"content":{"application/json":{"example":{"statusCode":500,"status":"FAILED_TO_CREATE_OR_UPDATE","details":["Failed to be created or updated."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Internal Server Error"}}},"post":{"tags":["page"],"summary":"Create new page.","description":"Creating new page.","operationId":"create_page_api_v1_page_post","parameters":[{"name":"Session","in":"cookie","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Session"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PageCreate"},"title":"New Pages"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PageResponse"},"title":"Response Create Page Api V1 Page Post"}}}},"403":{"content":{"application/json":{"example":{"statusCode":403,"status":"FORBIDDEN","details":["Forbidden."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"example":{"statusCode":404,"status":"NOT_FOUND","details":["Not found."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Not Found"},"409":{"content":{"application/json":{"example":{"statusCode":409,"status":"EXISTS_MUST_BE_UNIQUE","details":["Already exists, must be unique."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Conflict"},"422":{"description":"Unprocessable entity","content":{"application/json":{"example":{"statusCode":422,"status":"ERROR","details":[{"type":"string","loc":["string","string"],"msg":"string","input":"string"}]}}}},"500":{"content":{"application/json":{"example":{"statusCode":500,"status":"FAILED_TO_CREATE_OR_UPDATE","details":["Failed to be created or updated."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Internal Server Error"}}},"put":{"tags":["page"],"summary":"Update page.","description":"Update page.","operationId":"update_page_api_v1_page_put","parameters":[{"name":"Session","in":"cookie","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Session"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PageUpdate"},"title":"Pages Update"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PageResponse"},"title":"Response Update Page Api V1 Page Put"}}}},"403":{"content":{"application/json":{"example":{"statusCode":403,"status":"FORBIDDEN","details":["Forbidden."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"example":{"statusCode":404,"status":"NOT_FOUND","details":["Not found."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Not Found"},"409":{"content":{"application/json":{"example":{"statusCode":409,"status":"EXISTS_MUST_BE_UNIQUE","details":["Already exists, must be unique."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Conflict"},"422":{"description":"Unprocessable entity","content":{"application/json":{"example":{"statusCode":422,"status":"ERROR","details":[{"type":"string","loc":["string","string"],"msg":"string","input":"string"}]}}}},"500":{"content":{"application/json":{"example":{"statusCode":500,"status":"FAILED_TO_CREATE_OR_UPDATE","details":["Failed to be created or updated."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Internal Server Error"}}}},"/api/v1/page/parent":{"get":{"tags":["page"],"summary":"Get all page parents.","description":"Returns page parents.","operationId":"get_all_page_parents_api_v1_page_parent_get","parameters":[{"name":"Session","in":"cookie","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Session"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PageParentResponse"},"title":"Response Get All Page Parents Api V1 Page Parent Get"}}}},"403":{"content":{"application/json":{"example":{"statusCode":403,"status":"FORBIDDEN","details":["Forbidden."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"example":{"statusCode":404,"status":"NOT_FOUND","details":["Not found."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Not Found"},"409":{"content":{"application/json":{"example":{"statusCode":409,"status":"EXISTS_MUST_BE_UNIQUE","details":["Already exists, must be unique."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Conflict"},"422":{"description":"Unprocessable entity","content":{"application/json":{"example":{"statusCode":422,"status":"ERROR","details":[{"type":"string","loc":["string","string"],"msg":"string","input":"string"}]}}}},"500":{"content":{"application/json":{"example":{"statusCode":500,"status":"FAILED_TO_CREATE_OR_UPDATE","details":["Failed to be created or updated."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Internal Server Error"}}},"put":{"tags":["page"],"summary":"Update page parent.","description":"Update page parent.","operationId":"update_page_parent_api_v1_page_parent_put","parameters":[{"name":"Session","in":"cookie","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Session"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageParentUpdate"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageParentResponse"}}}},"403":{"content":{"application/json":{"example":{"statusCode":403,"status":"FORBIDDEN","details":["Forbidden."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"example":{"statusCode":404,"status":"NOT_FOUND","details":["Not found."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Not Found"},"409":{"content":{"application/json":{"example":{"statusCode":409,"status":"EXISTS_MUST_BE_UNIQUE","details":["Already exists, must be unique."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Conflict"},"422":{"description":"Unprocessable entity","content":{"application/json":{"example":{"statusCode":422,"status":"ERROR","details":[{"type":"string","loc":["string","string"],"msg":"string","input":"string"}]}}}},"500":{"content":{"application/json":{"example":{"statusCode":500,"status":"FAILED_TO_CREATE_OR_UPDATE","details":["Failed to be created or updated."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Internal Server Error"}}},"post":{"tags":["page"],"summary":"Create page parent.","description":"Create page parent.","operationId":"create_page_parent_api_v1_page_parent_post","parameters":[{"name":"Session","in":"cookie","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Session"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageParentCreate"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageParentResponse"}}}},"403":{"content":{"application/json":{"example":{"statusCode":403,"status":"FORBIDDEN","details":["Forbidden."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"example":{"statusCode":404,"status":"NOT_FOUND","details":["Not found."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Not Found"},"409":{"content":{"application/json":{"example":{"statusCode":409,"status":"EXISTS_MUST_BE_UNIQUE","details":["Already exists, must be unique."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Conflict"},"422":{"description":"Unprocessable entity","content":{"application/json":{"example":{"statusCode":422,"status":"ERROR","details":[{"type":"string","loc":["string","string"],"msg":"string","input":"string"}]}}}},"500":{"content":{"application/json":{"example":{"statusCode":500,"status":"FAILED_TO_CREATE_OR_UPDATE","details":["Failed to be created or updated."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Internal Server Error"}}}},"/api/v1/page/{id}":{"get":{"tags":["page"],"summary":"Get page by id.","description":"Returns page by id.","operationId":"get_page_by_id_api_v1_page__id__get","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","title":"Id of page."}},{"name":"Session","in":"cookie","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Session"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"403":{"content":{"application/json":{"example":{"statusCode":403,"status":"FORBIDDEN","details":["Forbidden."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"example":{"statusCode":404,"status":"NOT_FOUND","details":["Not found."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Not Found"},"409":{"content":{"application/json":{"example":{"statusCode":409,"status":"EXISTS_MUST_BE_UNIQUE","details":["Already exists, must be unique."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Conflict"},"422":{"description":"Unprocessable entity","content":{"application/json":{"example":{"statusCode":422,"status":"ERROR","details":[{"type":"string","loc":["string","string"],"msg":"string","input":"string"}]}}}},"500":{"content":{"application/json":{"example":{"statusCode":500,"status":"FAILED_TO_CREATE_OR_UPDATE","details":["Failed to be created or updated."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Internal Server Error"}}},"delete":{"tags":["page"],"summary":"Delete page.","description":"Delete page.","operationId":"delete_page_api_v1_page__id__delete","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","title":"Page id."}},{"name":"Session","in":"cookie","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Session"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusResponse"},"example":{"statusCode":200,"status":"SUCCESSFULLY_DELETED","details":["Successfully deleted."]}}}},"403":{"content":{"application/json":{"example":{"statusCode":403,"status":"FORBIDDEN","details":["Forbidden."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"example":{"statusCode":404,"status":"NOT_FOUND","details":["Not found."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Not Found"},"409":{"content":{"application/json":{"example":{"statusCode":409,"status":"EXISTS_MUST_BE_UNIQUE","details":["Already exists, must be unique."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Conflict"},"422":{"description":"Unprocessable entity","content":{"application/json":{"example":{"statusCode":422,"status":"ERROR","details":[{"type":"string","loc":["string","string"],"msg":"string","input":"string"}]}}}},"500":{"content":{"application/json":{"example":{"statusCode":500,"status":"FAILED_TO_CREATE_OR_UPDATE","details":["Failed to be created or updated."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Internal Server Error"}}}},"/api/v1/page/replace-all":{"post":{"tags":["page"],"summary":"Replace all pages.","description":"Replace all pages.","operationId":"replace_all_pages_api_v1_page_replace_all_post","parameters":[{"name":"Session","in":"cookie","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Session"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PageCreate"},"title":"New Pages"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PageResponse"},"title":"Response Replace All Pages Api V1 Page Replace All Post"}}}},"403":{"content":{"application/json":{"example":{"statusCode":403,"status":"FORBIDDEN","details":["Forbidden."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"example":{"statusCode":404,"status":"NOT_FOUND","details":["Not found."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Not Found"},"409":{"content":{"application/json":{"example":{"statusCode":409,"status":"EXISTS_MUST_BE_UNIQUE","details":["Already exists, must be unique."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Conflict"},"422":{"description":"Unprocessable entity","content":{"application/json":{"example":{"statusCode":422,"status":"ERROR","details":[{"type":"string","loc":["string","string"],"msg":"string","input":"string"}]}}}},"500":{"content":{"application/json":{"example":{"statusCode":500,"status":"FAILED_TO_CREATE_OR_UPDATE","details":["Failed to be created or updated."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Internal Server Error"}}}},"/api/v1/page/parent/{id}":{"get":{"tags":["page"],"summary":"Page parent by id.","description":"Returns page parent by id.","operationId":"get_page_parent_by_id_api_v1_page_parent__id__get","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","title":"Page parent."}},{"name":"Session","in":"cookie","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Session"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageParentResponse"}}}},"403":{"content":{"application/json":{"example":{"statusCode":403,"status":"FORBIDDEN","details":["Forbidden."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"example":{"statusCode":404,"status":"NOT_FOUND","details":["Not found."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Not Found"},"409":{"content":{"application/json":{"example":{"statusCode":409,"status":"EXISTS_MUST_BE_UNIQUE","details":["Already exists, must be unique."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Conflict"},"422":{"description":"Unprocessable entity","content":{"application/json":{"example":{"statusCode":422,"status":"ERROR","details":[{"type":"string","loc":["string","string"],"msg":"string","input":"string"}]}}}},"500":{"content":{"application/json":{"example":{"statusCode":500,"status":"FAILED_TO_CREATE_OR_UPDATE","details":["Failed to be created or updated."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Internal Server Error"}}},"delete":{"tags":["page"],"summary":"Delete page parent.","description":"Delete page parent.","operationId":"delete_page_parent_api_v1_page_parent__id__delete","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","title":"Page parent id."}},{"name":"Session","in":"cookie","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Session"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusResponse"},"example":{"statusCode":200,"status":"SUCCESSFULLY_DELETED","details":["Successfully deleted."]}}}},"403":{"content":{"application/json":{"example":{"statusCode":403,"status":"FORBIDDEN","details":["Forbidden."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"example":{"statusCode":404,"status":"NOT_FOUND","details":["Not found."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Not Found"},"409":{"content":{"application/json":{"example":{"statusCode":409,"status":"EXISTS_MUST_BE_UNIQUE","details":["Already exists, must be unique."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Conflict"},"422":{"description":"Unprocessable entity","content":{"application/json":{"example":{"statusCode":422,"status":"ERROR","details":[{"type":"string","loc":["string","string"],"msg":"string","input":"string"}]}}}},"500":{"content":{"application/json":{"example":{"statusCode":500,"status":"FAILED_TO_CREATE_OR_UPDATE","details":["Failed to be created or updated."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Internal Server Error"}}}},"/api/v1/page/parent/replace-all":{"post":{"tags":["page"],"summary":"Replace all page parents.","description":"Replace all page parents.","operationId":"replace_all_page_parents_api_v1_page_parent_replace_all_post","parameters":[{"name":"Session","in":"cookie","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Session"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PageParentCreate"},"title":"Page Parents"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PageParentResponse"},"title":"Response Replace All Page Parents Api V1 Page Parent Replace All Post"}}}},"403":{"content":{"application/json":{"example":{"statusCode":403,"status":"FORBIDDEN","details":["Forbidden."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"example":{"statusCode":404,"status":"NOT_FOUND","details":["Not found."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Not Found"},"409":{"content":{"application/json":{"example":{"statusCode":409,"status":"EXISTS_MUST_BE_UNIQUE","details":["Already exists, must be unique."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Conflict"},"422":{"description":"Unprocessable entity","content":{"application/json":{"example":{"statusCode":422,"status":"ERROR","details":[{"type":"string","loc":["string","string"],"msg":"string","input":"string"}]}}}},"500":{"content":{"application/json":{"example":{"statusCode":500,"status":"FAILED_TO_CREATE_OR_UPDATE","details":["Failed to be created or updated."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Internal Server Error"}}}},"/api/v1/tryout/authentication":{"post":{"tags":["tryout"],"summary":"Authenticate tryout tools.","description":"Authenticate tryout tool.","operationId":"authenticate_api_v1_tryout_authentication_post","parameters":[{"name":"Session","in":"cookie","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Session"}}],"requestBody":{"required":true,"content":{"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/Body_authenticate_api_v1_tryout_authentication_post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TryOutAuthentication"}}}},"403":{"content":{"application/json":{"example":{"statusCode":403,"status":"FORBIDDEN","details":["Forbidden."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"example":{"statusCode":404,"status":"NOT_FOUND","details":["Not found."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Not Found"},"409":{"content":{"application/json":{"example":{"statusCode":409,"status":"EXISTS_MUST_BE_UNIQUE","details":["Already exists, must be unique."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Conflict"},"422":{"description":"Unprocessable entity","content":{"application/json":{"example":{"statusCode":422,"status":"ERROR","details":[{"type":"string","loc":["string","string"],"msg":"string","input":"string"}]}}}},"500":{"content":{"application/json":{"example":{"statusCode":500,"status":"FAILED_TO_CREATE_OR_UPDATE","details":["Failed to be created or updated."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Internal Server Error"}}}},"/api/v1/tryout":{"post":{"tags":["tryout"],"summary":"Forwards tryout tool requests to corresponding api.","description":"Forward request to ext-link endpoint.","operationId":"forward_api_v1_tryout_post","parameters":[{"name":"x-posti-ext-authentication","in":"header","required":true,"schema":{"type":"string","title":"X-Posti-Ext-Authentication"}},{"name":"Session","in":"cookie","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Session"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TryOutRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TryOutResponse"}}}},"403":{"content":{"application/json":{"example":{"statusCode":403,"status":"FORBIDDEN","details":["Forbidden."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"example":{"statusCode":404,"status":"NOT_FOUND","details":["Not found."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Not Found"},"409":{"content":{"application/json":{"example":{"statusCode":409,"status":"EXISTS_MUST_BE_UNIQUE","details":["Already exists, must be unique."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Conflict"},"422":{"description":"Unprocessable entity","content":{"application/json":{"example":{"statusCode":422,"status":"ERROR","details":[{"type":"string","loc":["string","string"],"msg":"string","input":"string"}]}}}},"500":{"content":{"application/json":{"example":{"statusCode":500,"status":"FAILED_TO_CREATE_OR_UPDATE","details":["Failed to be created or updated."]},"schema":{"$ref":"#/components/schemas/StatusResponse"}}},"description":"Internal Server Error"}}}},"/api/v1/config":{"get":{"tags":["config"],"summary":"Config.","description":"Config.","operationId":"get_config_api_v1_config_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Config"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusResponse"},"example":{"statusCode":403,"status":"FORBIDDEN","details":["Forbidden."]}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusResponse"},"example":{"statusCode":404,"status":"NOT_FOUND","details":["Not found."]}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusResponse"},"example":{"statusCode":409,"status":"EXISTS_MUST_BE_UNIQUE","details":["Already exists, must be unique."]}}}},"422":{"description":"Unprocessable entity","content":{"application/json":{"example":{"statusCode":422,"status":"ERROR","details":[{"type":"string","loc":["string","string"],"msg":"string","input":"string"}]}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusResponse"},"example":{"statusCode":500,"status":"FAILED_TO_CREATE_OR_UPDATE","details":["Failed to be created or updated."]}}}}}}},"/api/v1/supportrequest":{"post":{"tags":["supportrequest"],"summary":"Create a new support request.","description":"Create a new support request.","operationId":"create_support_request_api_v1_supportrequest_post","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/SupportRequestCreate"}}},"required":true},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusResponse"},"example":{"statusCode":403,"status":"FORBIDDEN","details":["Forbidden."]}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusResponse"},"example":{"statusCode":404,"status":"NOT_FOUND","details":["Not found."]}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusResponse"},"example":{"statusCode":409,"status":"EXISTS_MUST_BE_UNIQUE","details":["Already exists, must be unique."]}}}},"422":{"description":"Unprocessable entity","content":{"application/json":{"example":{"statusCode":422,"status":"ERROR","details":[{"type":"string","loc":["string","string"],"msg":"string","input":"string"}]}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusResponse"},"example":{"statusCode":500,"status":"FAILED_TO_CREATE_OR_UPDATE","details":["Failed to be created or updated."]}}}},"424":{"description":"Failed Dependency","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusResponse"}}}}}}}},"components":{"schemas":{"APIPolicyCreate":{"properties":{"name":{"type":"string","title":"Name","description":"Policy name."},"description":{"type":"string","title":"Description","description":"Policy description."}},"type":"object","required":["name","description"],"title":"APIPolicyCreate","description":"API policy create schema."},"APIPolicyResponse":{"properties":{"name":{"type":"string","title":"Name","description":"Policy name."},"description":{"type":"string","title":"Description","description":"Policy description."},"history":{"$ref":"#/components/schemas/HistoryResponse","description":"History reference."}},"type":"object","required":["name","description","history"],"title":"APIPolicyResponse","description":"API policy response schema."},"Actions":{"type":"string","enum":["INSERT","UPDATE"],"title":"Actions","description":"Actions."},"AuthenticationResponse":{"properties":{"status":{"type":"integer","title":"Status","description":"Status code of authentication."},"account":{"type":"string","title":"Account","description":"User account."},"accessToken":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Accesstoken","description":"Access token, used ar Bearer token for accessing endpoints."},"sessionToken":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sessiontoken","description":"Session token required for account verification and password change."},"roles":{"items":{"$ref":"#/components/schemas/UserAccessRoles"},"type":"array","title":"Roles","description":"User access roles."}},"type":"object","required":["status","account","roles"],"title":"AuthenticationResponse","description":"Authentication response."},"AzureAuthRequest":{"properties":{"code":{"type":"string","title":"Code","description":"Authentication code."},"redirectUri":{"type":"string","format":"base64url","title":"Redirecturi","description":"Redirect URI."}},"type":"object","required":["code","redirectUri"],"title":"AzureAuthRequest","description":"Azure AD authentication request."},"AzureConfig":{"properties":{"url":{"type":"string","title":"Url","description":"Url of login."},"tenant":{"type":"string","title":"Tenant","description":"Tenant id."},"clientId":{"type":"string","title":"Clientid","description":"Client id."}},"type":"object","required":["url","tenant","clientId"],"title":"AzureConfig","description":"Azure config."},"Body_authenticate_api_v1_tryout_authentication_post":{"properties":{"client_id":{"type":"string","title":"Client Id"},"client_secret":{"type":"string","title":"Client Secret"},"grant_type":{"type":"string","pattern":"client_credentials","title":"Grant Type","default":"client_credentials"}},"type":"object","required":["client_id","client_secret"],"title":"Body_authenticate_api_v1_tryout_authentication_post"},"Body_verify_api_v1_authentication_verify_post":{"properties":{"grant_type":{"anyOf":[{"type":"string","pattern":"^password$"},{"type":"null"}],"title":"Grant Type"},"username":{"type":"string","title":"Username"},"password":{"type":"string","format":"password","title":"Password"},"scope":{"type":"string","title":"Scope","default":""},"client_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Client Id"},"client_secret":{"anyOf":[{"type":"string"},{"type":"null"}],"format":"password","title":"Client Secret"}},"type":"object","required":["username","password"],"title":"Body_verify_api_v1_authentication_verify_post"},"CatalogueCreate":{"properties":{"targetName":{"type":"string","maxLength":23,"minLength":2,"pattern":"^[\\w.~-]*$","title":"Targetname","description":"Target name (used as API role)."},"name":{"type":"string","maxLength":24,"minLength":2,"title":"Name","description":"User facing name."},"description":{"type":"string","maxLength":100,"minLength":10,"title":"Description","description":"Short description."},"businessOwners":{"items":{"type":"string"},"type":"array","minItems":1,"title":"Businessowners","description":"Business owner(s) as reference id(s)."},"technicalOwners":{"items":{"type":"string"},"type":"array","minItems":1,"title":"Technicalowners","description":"Technical owner(s) as reference id(s)."},"categories":{"anyOf":[{"items":{"type":"string"},"type":"array","minItems":1},{"type":"null"}],"title":"Categories","description":"List of categories"}},"type":"object","required":["targetName","name","description","businessOwners","technicalOwners"],"title":"CatalogueCreate","description":"Catalogue create model."},"CatalogueDocumentResponse":{"properties":{"document":{"$ref":"#/components/schemas/DocumentResponseNoHistory","description":"Document."},"customTitle":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Customtitle","description":"Custom document title."},"orderNumber":{"type":"integer","minimum":1.0,"title":"Ordernumber","description":"Document order number.","default":1}},"type":"object","required":["document"],"title":"CatalogueDocumentResponse","description":"Catalogue document update."},"CatalogueDocumentUpdate":{"properties":{"id":{"type":"string","title":"Id","description":"Document id."},"customTitle":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Customtitle","description":"Custom document title."},"orderNumber":{"type":"integer","minimum":1.0,"title":"Ordernumber","description":"Document order number.","default":1}},"type":"object","required":["id"],"title":"CatalogueDocumentUpdate","description":"Catalogue document update."},"CatalogueResponse":{"properties":{"id":{"type":"string","title":"Id","description":"Unique id in db."},"history":{"$ref":"#/components/schemas/HistoryResponse","description":"History reference."},"name":{"type":"string","maxLength":24,"minLength":2,"title":"Name","description":"User facing name."},"description":{"type":"string","maxLength":100,"minLength":10,"title":"Description","description":"Short description."},"targetName":{"type":"string","maxLength":23,"minLength":2,"pattern":"^[\\w.~-]*$","title":"Targetname","description":"Target name (used as API role)."},"mediation":{"$ref":"#/components/schemas/Mediation"},"appId":{"anyOf":[{"type":"string","maxLength":4,"minLength":4},{"type":"null"}],"title":"Appid","description":"App id."},"basePath":{"anyOf":[{"type":"string","maxLength":150,"minLength":5,"pattern":"^\\/[/.a-zA-Z0-9-]+$"},{"type":"null"}],"title":"Basepath","description":"Base path."},"serviceOfferingLink":{"anyOf":[{"type":"string","maxLength":2083,"minLength":1,"format":"uri"},{"type":"null"}],"title":"Serviceofferinglink","description":"Link to service offering (ex. SNOW)."},"apiPolicy":{"$ref":"#/components/schemas/CustomAttribute","description":"API Policy"},"healthCheckPath":{"anyOf":[{"type":"string","pattern":"^\\/[/.a-zA-Z0-9-]+$"},{"type":"null"}],"title":"Healthcheckpath","description":"Health check path."},"revision":{"type":"integer","exclusiveMinimum":0.0,"title":"Revision","description":"Revision."},"action":{"$ref":"#/components/schemas/Actions","description":"Action"},"documents":{"anyOf":[{"items":{"$ref":"#/components/schemas/CatalogueDocumentResponse"},"type":"array","minItems":1},{"type":"null"}],"title":"Documents","description":"Documentation."},"environments":{"anyOf":[{"items":{"$ref":"#/components/schemas/EnvironmentResponseNoHistory"},"type":"array"},{"type":"null"}],"title":"Environments","description":"Environments supported by API."},"businessOwners":{"items":{"$ref":"#/components/schemas/OwnerResponseNoHistory"},"type":"array","minItems":1,"title":"Businessowners","description":"Business owner(s) as reference id(s)."},"technicalOwners":{"items":{"$ref":"#/components/schemas/OwnerResponseNoHistory"},"type":"array","minItems":1,"title":"Technicalowners","description":"Technical owner(s) as reference id(s)."},"categories":{"items":{"$ref":"#/components/schemas/CategoryResponseNoHistory"},"type":"array","minItems":1,"title":"Categories","description":"List of categories"}},"type":"object","required":["id","history","name","description","targetName","mediation","appId","basePath","serviceOfferingLink","apiPolicy","healthCheckPath","revision","action","documents","environments","businessOwners","technicalOwners","categories"],"title":"CatalogueResponse","description":"Catalogue update response."},"CatalogueResponsePublic":{"properties":{"name":{"type":"string","maxLength":24,"minLength":2,"title":"Name","description":"User facing name."},"id":{"type":"string","title":"Id","description":"Unique id in db."},"description":{"type":"string","maxLength":100,"minLength":10,"title":"Description","description":"Short description."},"targetName":{"type":"string","maxLength":23,"minLength":2,"pattern":"^[\\w.~-]*$","title":"Targetname","description":"Target name (used as API role)."},"mediation":{"$ref":"#/components/schemas/Mediation"},"appId":{"anyOf":[{"type":"string","maxLength":4,"minLength":4},{"type":"null"}],"title":"Appid","description":"App id."},"basePath":{"anyOf":[{"type":"string","maxLength":150,"minLength":5,"pattern":"^\\/[/.a-zA-Z0-9-]+$"},{"type":"null"}],"title":"Basepath","description":"Base path."},"healthCheckPath":{"anyOf":[{"type":"string","pattern":"^\\/[/.a-zA-Z0-9-]+$"},{"type":"null"}],"title":"Healthcheckpath","description":"Health check path."},"revision":{"type":"integer","exclusiveMinimum":0.0,"title":"Revision","description":"Revision."},"action":{"$ref":"#/components/schemas/Actions","description":"Action"},"documents":{"anyOf":[{"items":{"$ref":"#/components/schemas/CatalogueDocumentResponse"},"type":"array","minItems":1},{"type":"null"}],"title":"Documents","description":"Documentation."},"environments":{"anyOf":[{"items":{"$ref":"#/components/schemas/EnvironmentResponsePublic"},"type":"array"},{"type":"null"}],"title":"Environments","description":"Environments supported by API."},"categories":{"items":{"$ref":"#/components/schemas/CategoryResponseNoHistory"},"type":"array","minItems":1,"title":"Categories","description":"List of categories"}},"type":"object","required":["name","id","description","targetName","mediation","appId","basePath","healthCheckPath","revision","action","documents","environments","categories"],"title":"CatalogueResponsePublic","description":"Catalogue response public."},"CatalogueUpdate":{"properties":{"revision":{"type":"integer","exclusiveMinimum":0.0,"title":"Revision","description":"Revision."},"name":{"anyOf":[{"type":"string","maxLength":24,"minLength":2},{"type":"null"}],"title":"Name","description":"User facing name."},"description":{"anyOf":[{"type":"string","maxLength":100,"minLength":10},{"type":"null"}],"title":"Description","description":"Short description."},"mediation":{"anyOf":[{"$ref":"#/components/schemas/Mediation"},{"type":"null"}],"description":"Mediation."},"appId":{"anyOf":[{"type":"string","maxLength":4,"minLength":4},{"type":"null"}],"title":"Appid","description":"App id."},"basePath":{"anyOf":[{"type":"string","maxLength":150,"minLength":5,"pattern":"^\\/[/.a-zA-Z0-9-]+$"},{"type":"null"}],"title":"Basepath","description":"Base path."},"serviceOfferingLink":{"anyOf":[{"type":"string","maxLength":2083,"minLength":1,"format":"uri"},{"type":"null"}],"title":"Serviceofferinglink","description":"Link to service offering (ex. SNOW)."},"apiPolicy":{"anyOf":[{"$ref":"#/components/schemas/CustomAttribute"},{"type":"null"}],"description":"API Policy"},"healthCheckPath":{"anyOf":[{"type":"string","pattern":"^\\/[/.a-zA-Z0-9-]+$"},{"type":"null"}],"title":"Healthcheckpath","description":"Health check path."},"businessOwners":{"anyOf":[{"items":{"type":"string"},"type":"array","minItems":1},{"type":"null"}],"title":"Businessowners","description":"Business owner(s) as reference id(s)."},"technicalOwners":{"anyOf":[{"items":{"type":"string"},"type":"array","minItems":1},{"type":"null"}],"title":"Technicalowners","description":"Technical owner(s) as reference id(s)."},"documents":{"anyOf":[{"items":{"$ref":"#/components/schemas/CatalogueDocumentUpdate"},"type":"array","minItems":1},{"type":"null"}],"title":"Documents","description":"Documentation."},"environments":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Environments","description":"Environments supported by API."},"categories":{"anyOf":[{"items":{"type":"string"},"type":"array","minItems":1},{"type":"null"}],"title":"Categories","description":"List of categories"}},"type":"object","required":["revision"],"title":"CatalogueUpdate","description":"Common base for catalogue update."},"CategoryCatalogueMap":{"properties":{"name":{"type":"string","title":"Name","description":"Category name."},"description":{"type":"string","title":"Description","description":"Category description."},"sequence":{"type":"integer","minimum":1.0,"title":"Sequence","description":"Category sequence id."},"catalogue":{"items":{"$ref":"#/components/schemas/MappedCatalogue"},"type":"array","title":"Catalogue","description":"Catalogue items."}},"type":"object","required":["name","description","sequence","catalogue"],"title":"CategoryCatalogueMap","description":"Category with mapped catalogue item."},"CategoryCreate":{"properties":{"name":{"type":"string","title":"Name","description":"Category name."},"description":{"type":"string","title":"Description","description":"Category description."},"sequence":{"type":"integer","minimum":1.0,"title":"Sequence","description":"Category sequence id."}},"type":"object","required":["name","description","sequence"],"title":"CategoryCreate","description":"Category create scehma."},"CategoryResponse":{"properties":{"name":{"type":"string","title":"Name","description":"Category name."},"description":{"type":"string","title":"Description","description":"Category description."},"sequence":{"type":"integer","minimum":1.0,"title":"Sequence","description":"Category sequence id."},"id":{"type":"string","title":"Id","description":"Unique id in db."},"history":{"$ref":"#/components/schemas/HistoryResponse","description":"History reference."}},"type":"object","required":["name","description","sequence","id","history"],"title":"CategoryResponse","description":"Category response schema."},"CategoryResponseNoHistory":{"properties":{"name":{"type":"string","title":"Name","description":"Category name."},"description":{"type":"string","title":"Description","description":"Category description."},"sequence":{"type":"integer","minimum":1.0,"title":"Sequence","description":"Category sequence id."},"id":{"type":"string","title":"Id","description":"Unique id in db."}},"type":"object","required":["name","description","sequence","id"],"title":"CategoryResponseNoHistory","description":"Category response without history fields."},"CategoryUpdate":{"properties":{"name":{"type":"string","title":"Name","description":"Category name."},"description":{"type":"string","title":"Description","description":"Category description."},"sequence":{"type":"integer","minimum":1.0,"title":"Sequence","description":"Category sequence id."},"revision":{"type":"integer","title":"Revision","description":"Revision for updated entry, empty for new."}},"type":"object","required":["name","description","sequence","revision"],"title":"CategoryUpdate","description":"Category update scehma."},"Config":{"properties":{"azure":{"$ref":"#/components/schemas/AzureConfig","description":"Azure configs."}},"type":"object","required":["azure"],"title":"Config","description":"Config base model."},"CustomAttribute":{"properties":{"name":{"type":"string","title":"Name","description":"Name."},"value":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Value","description":"List of values"}},"type":"object","required":["name","value"],"title":"CustomAttribute","description":"Generic value/name attribute schema."},"DocumentCreate":{"properties":{"docId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Docid","description":"Id of the document by language and description."},"description":{"type":"string","maxLength":100,"minLength":3,"title":"Description","description":"Short description of document."},"document":{"type":"string","title":"Document","description":"Document itself."},"language":{"$ref":"#/components/schemas/Language","description":"Document language."}},"type":"object","required":["description","document","language"],"title":"DocumentCreate","description":"Document create model."},"DocumentResponse":{"properties":{"docId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Docid","description":"Id of the document by language and description."},"description":{"type":"string","maxLength":100,"minLength":3,"title":"Description","description":"Short description of document."},"document":{"type":"string","title":"Document","description":"Document itself."},"language":{"$ref":"#/components/schemas/Language","description":"Document language."},"id":{"type":"string","title":"Id","description":"Unique id in db."},"history":{"$ref":"#/components/schemas/HistoryResponse","description":"History reference."}},"type":"object","required":["description","document","language","id","history"],"title":"DocumentResponse","description":"Document response model."},"DocumentResponseNoHistory":{"properties":{"docId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Docid","description":"Id of the document by language and description."},"description":{"type":"string","maxLength":100,"minLength":3,"title":"Description","description":"Short description of document."},"document":{"type":"string","title":"Document","description":"Document itself."},"language":{"$ref":"#/components/schemas/Language","description":"Document language."},"id":{"type":"string","title":"Id","description":"Unique id in db."}},"type":"object","required":["description","document","language","id"],"title":"DocumentResponseNoHistory","description":"Document response without history."},"DocumentType":{"type":"string","enum":["content","api","unassigned"],"title":"DocumentType","description":"Document types."},"DocumentUpdate":{"properties":{"docId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Docid","description":"Id of the document by language and description."},"description":{"type":"string","maxLength":100,"minLength":3,"title":"Description","description":"Short description of document."},"document":{"type":"string","title":"Document","description":"Document itself."},"language":{"$ref":"#/components/schemas/Language","description":"Document language."},"revision":{"type":"integer","title":"Revision","description":"Revision for updated entry, empty for new."}},"type":"object","required":["description","document","language","revision"],"title":"DocumentUpdate","description":"Document update model."},"EnvironmentCreate":{"properties":{"environment":{"$ref":"#/components/schemas/Environments","description":"Environment itself."},"dnsName":{"type":"string","title":"Dnsname","description":"DNS name of the environment service."},"port":{"type":"integer","title":"Port","description":"Port."},"openapiJson":{"type":"string","title":"Openapijson","description":"OpenAPI JSON as url or str (may be empty).","default":""},"version":{"type":"string","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)\\.(0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?$","title":"Version","description":"API version."},"catalogueId":{"type":"string","title":"Catalogueid","description":"Id of catalogue item to which throttling belongs."},"lifecycle":{"type":"string","title":"Lifecycle","description":"Lifecycle state.","default":"DEVELOP"},"tryOutAllow":{"type":"boolean","title":"Tryoutallow","description":"Allow try-out tool to make requests.","default":true},"targetIpPublic":{"type":"boolean","title":"Targetippublic","description":"Target ip is public.","default":false},"throttling":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Throttling","description":"Throttling options."}},"type":"object","required":["environment","dnsName","port","version","catalogueId"],"title":"EnvironmentCreate","description":"Environment create model."},"EnvironmentResponse":{"properties":{"environment":{"$ref":"#/components/schemas/Environments","description":"Environment itself."},"dnsName":{"type":"string","title":"Dnsname","description":"DNS name of the environment service."},"port":{"type":"integer","title":"Port","description":"Port."},"openapiJson":{"type":"string","title":"Openapijson","description":"OpenAPI JSON as url or str (may be empty).","default":""},"version":{"type":"string","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)\\.(0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?$","title":"Version","description":"API version."},"catalogueId":{"type":"string","title":"Catalogueid","description":"Id of catalogue item to which throttling belongs."},"lifecycle":{"type":"string","title":"Lifecycle","description":"Lifecycle state.","default":"DEVELOP"},"tryOutAllow":{"type":"boolean","title":"Tryoutallow","description":"Allow try-out tool to make requests.","default":true},"targetIpPublic":{"type":"boolean","title":"Targetippublic","description":"Target ip is public.","default":false},"id":{"type":"string","title":"Id","description":"Unique id in db."},"history":{"$ref":"#/components/schemas/HistoryResponse","description":"History reference."},"throttling":{"anyOf":[{"items":{"$ref":"#/components/schemas/ThrottlingResponseNoHistory"},"type":"array"},{"type":"null"}],"title":"Throttling","description":"Throttling options."}},"type":"object","required":["environment","dnsName","port","version","catalogueId","id","history"],"title":"EnvironmentResponse","description":"Environment response schema with history and id."},"EnvironmentResponseNoHistory":{"properties":{"environment":{"$ref":"#/components/schemas/Environments","description":"Environment itself."},"dnsName":{"type":"string","title":"Dnsname","description":"DNS name of the environment service."},"port":{"type":"integer","title":"Port","description":"Port."},"openapiJson":{"type":"string","title":"Openapijson","description":"OpenAPI JSON as url or str (may be empty).","default":""},"version":{"type":"string","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)\\.(0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?$","title":"Version","description":"API version."},"catalogueId":{"type":"string","title":"Catalogueid","description":"Id of catalogue item to which throttling belongs."},"lifecycle":{"type":"string","title":"Lifecycle","description":"Lifecycle state.","default":"DEVELOP"},"tryOutAllow":{"type":"boolean","title":"Tryoutallow","description":"Allow try-out tool to make requests.","default":true},"targetIpPublic":{"type":"boolean","title":"Targetippublic","description":"Target ip is public.","default":false},"throttling":{"anyOf":[{"items":{"$ref":"#/components/schemas/ThrottlingResponseNoHistory"},"type":"array"},{"type":"null"}],"title":"Throttling","description":"Throttling options."},"id":{"type":"string","title":"Id","description":"Unique id in db."}},"type":"object","required":["environment","dnsName","port","version","catalogueId","id"],"title":"EnvironmentResponseNoHistory","description":"Environment response without history fields."},"EnvironmentResponsePublic":{"properties":{"environment":{"$ref":"#/components/schemas/Environments","description":"Environment itself."},"dnsName":{"type":"string","title":"Dnsname","description":"DNS name of the environment service."},"port":{"type":"integer","title":"Port","description":"Port."},"openapiJson":{"type":"string","title":"Openapijson","description":"OpenAPI JSON as url or str (may be empty).","default":""},"version":{"type":"string","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)\\.(0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?$","title":"Version","description":"API version."},"catalogueId":{"type":"string","title":"Catalogueid","description":"Id of catalogue item to which throttling belongs."},"lifecycle":{"type":"string","title":"Lifecycle","description":"Lifecycle state.","default":"DEVELOP"},"tryOutAllow":{"type":"boolean","title":"Tryoutallow","description":"Allow try-out tool to make requests.","default":true},"targetIpPublic":{"type":"boolean","title":"Targetippublic","description":"Target ip is public.","default":false},"throttling":{"anyOf":[{"items":{"$ref":"#/components/schemas/ThrottlingResponseNoHistory"},"type":"array"},{"type":"null"}],"title":"Throttling","description":"Throttling options."},"id":{"type":"string","title":"Id","description":"Unique id in db."}},"type":"object","required":["environment","dnsName","port","version","catalogueId","id"],"title":"EnvironmentResponsePublic","description":"Environment public response."},"EnvironmentUpdate":{"properties":{"environment":{"$ref":"#/components/schemas/Environments","description":"Environment itself."},"dnsName":{"type":"string","title":"Dnsname","description":"DNS name of the environment service."},"port":{"type":"integer","title":"Port","description":"Port."},"openapiJson":{"type":"string","title":"Openapijson","description":"OpenAPI JSON as url or str (may be empty).","default":""},"version":{"type":"string","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)\\.(0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?$","title":"Version","description":"API version."},"catalogueId":{"type":"string","title":"Catalogueid","description":"Id of catalogue item to which throttling belongs."},"lifecycle":{"type":"string","title":"Lifecycle","description":"Lifecycle state.","default":"DEVELOP"},"tryOutAllow":{"type":"boolean","title":"Tryoutallow","description":"Allow try-out tool to make requests.","default":true},"targetIpPublic":{"type":"boolean","title":"Targetippublic","description":"Target ip is public.","default":false},"revision":{"type":"integer","title":"Revision","description":"Revision for updated entry, empty for new."},"throttling":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Throttling","description":"Throttling options."}},"type":"object","required":["environment","dnsName","port","version","catalogueId","revision"],"title":"EnvironmentUpdate","description":"Environment update model."},"Environments":{"type":"string","enum":["dev","prd","stg","tst"],"title":"Environments","description":"Supported environments."},"HistoryCreate":{"properties":{"creator":{"type":"string","maxLength":100,"minLength":3,"title":"Creator","description":"User or email of the creator."}},"additionalProperties":false,"type":"object","required":["creator"],"title":"HistoryCreate","description":"History create model."},"HistoryResponse":{"properties":{"id":{"type":"string","title":"Id","description":"Id of entry in db."},"creator":{"type":"string","maxLength":100,"minLength":3,"title":"Creator","description":"User or email of the creator."},"created":{"type":"string","format":"date-time","title":"Created","description":"Datetime when the entry has been created."},"modifier":{"type":"string","maxLength":100,"minLength":3,"title":"Modifier","description":"User or email of the modifier."},"modified":{"type":"string","format":"date-time","title":"Modified","description":"Datetime when the entry has been modified."},"revision":{"type":"number","title":"Revision","description":"Revision of entry, incremented by 1 for each update","default":1}},"additionalProperties":false,"type":"object","required":["id","creator","created","modifier","modified"],"title":"HistoryResponse","description":"History response model."},"Language":{"type":"string","enum":["EN"],"title":"Language","description":"Supported languages."},"LifecycleCreate":{"properties":{"name":{"type":"string","maxLength":100,"minLength":3,"title":"Name","description":"Name of the lifecycle."},"description":{"type":"string","title":"Description","description":"Description of lifecycle status."},"sequenceId":{"type":"integer","minimum":1.0,"title":"Sequenceid","description":"Sequence id."}},"type":"object","required":["name","description","sequenceId"],"title":"LifecycleCreate","description":"Lifecycle create schema."},"LifecycleResponse":{"properties":{"name":{"type":"string","maxLength":100,"minLength":3,"title":"Name","description":"Name of the lifecycle."},"description":{"type":"string","title":"Description","description":"Description of lifecycle status."},"sequenceId":{"type":"integer","minimum":1.0,"title":"Sequenceid","description":"Sequence id."},"history":{"$ref":"#/components/schemas/HistoryResponse","description":"History reference."}},"type":"object","required":["name","description","sequenceId","history"],"title":"LifecycleResponse","description":"Lifecycle response schema."},"MappedCatalogue":{"properties":{"id":{"type":"string","title":"Id","description":"Unique id in db."},"name":{"type":"string","title":"Name","description":"API name."},"target_name":{"type":"string","title":"Target Name","description":"Target name (used as API role)."},"description":{"type":"string","title":"Description","description":"Catalogue description."}},"type":"object","required":["id","name","target_name","description"],"title":"MappedCatalogue","description":"Mapped catalogue metadata."},"Mediation":{"properties":{"enabled":{"type":"boolean","title":"Enabled","description":"Enable mediation.","default":false}},"type":"object","title":"Mediation","description":"Mediation."},"OwnerCreate":{"properties":{"name":{"type":"string","title":"Name","description":"Owner's or unit's name."},"email":{"items":{"type":"string","format":"email"},"type":"array","title":"Email","description":"Owner's email address."}},"type":"object","required":["name","email"],"title":"OwnerCreate","description":"Owner create scehma."},"OwnerResponse":{"properties":{"name":{"type":"string","title":"Name","description":"Owner's or unit's name."},"email":{"items":{"type":"string","format":"email"},"type":"array","title":"Email","description":"Owner's email address."},"id":{"type":"string","title":"Id","description":"Unique id in db."},"history":{"$ref":"#/components/schemas/HistoryResponse","description":"History reference."}},"type":"object","required":["name","email","id","history"],"title":"OwnerResponse","description":"Owner response schema."},"OwnerResponseNoHistory":{"properties":{"name":{"type":"string","title":"Name","description":"Owner's or unit's name."},"email":{"items":{"type":"string","format":"email"},"type":"array","title":"Email","description":"Owner's email address."},"id":{"type":"string","title":"Id","description":"Unique id in db."}},"type":"object","required":["name","email","id"],"title":"OwnerResponseNoHistory","description":"Owner response without history."},"OwnerUpdate":{"properties":{"name":{"type":"string","title":"Name","description":"Owner's or unit's name."},"email":{"items":{"type":"string","format":"email"},"type":"array","title":"Email","description":"Owner's email address."},"revision":{"type":"integer","title":"Revision","description":"Revision for updated entry, empty for new."}},"type":"object","required":["name","email","revision"],"title":"OwnerUpdate","description":"Owner update scehma."},"PageCreate":{"properties":{"docId":{"type":"string","maxLength":100,"minLength":3,"title":"Docid","description":"Document id."},"titleOverride":{"anyOf":[{"type":"string","maxLength":100},{"type":"null"}],"title":"Titleoverride","description":"Custom document title."},"sequence":{"type":"integer","minimum":1.0,"title":"Sequence","description":"Document sequence number.","default":1},"parent":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Parent","description":"Parent title."}},"type":"object","required":["docId"],"title":"PageCreate","description":"Page create scehma."},"PageParentCreate":{"properties":{"parent":{"type":"string","minLength":3,"title":"Parent","description":"Parent title."},"sequence":{"type":"integer","minimum":1.0,"title":"Sequence","description":"PAge parent sequence number.","default":1}},"type":"object","required":["parent"],"title":"PageParentCreate","description":"Page parent create scehma."},"PageParentResponse":{"properties":{"parent":{"type":"string","minLength":3,"title":"Parent","description":"Parent title."},"sequence":{"type":"integer","minimum":1.0,"title":"Sequence","description":"PAge parent sequence number.","default":1},"id":{"type":"string","title":"Id","description":"Unique id in db."},"history":{"$ref":"#/components/schemas/HistoryResponse","description":"History reference."}},"type":"object","required":["parent","id","history"],"title":"PageParentResponse","description":"Page parent response schema."},"PageParentUpdate":{"properties":{"parent":{"type":"string","minLength":3,"title":"Parent","description":"Parent title."},"sequence":{"type":"integer","minimum":1.0,"title":"Sequence","description":"PAge parent sequence number.","default":1},"revision":{"type":"integer","title":"Revision","description":"Revision for updated entry, empty for new."},"id":{"type":"string","title":"Id","description":"Page parent id."}},"type":"object","required":["parent","revision","id"],"title":"PageParentUpdate","description":"Page parent update scehma."},"PageParentWithChildrenResponsePublic":{"properties":{"parent":{"type":"string","minLength":3,"title":"Parent","description":"Parent title."},"sequence":{"type":"integer","minimum":1.0,"title":"Sequence","description":"PAge parent sequence number.","default":1},"id":{"type":"string","title":"Id","description":"Page parent id."},"children":{"anyOf":[{"items":{"$ref":"#/components/schemas/PageResponsePublic"},"type":"array"},{"type":"null"}],"title":"Children","description":"Page parent children pages."}},"type":"object","required":["parent","id"],"title":"PageParentWithChildrenResponsePublic","description":"Page parent response including children pages schema."},"PageResponse":{"properties":{"docId":{"type":"string","maxLength":100,"minLength":3,"title":"Docid","description":"Document id."},"titleOverride":{"anyOf":[{"type":"string","maxLength":100},{"type":"null"}],"title":"Titleoverride","description":"Custom document title."},"sequence":{"type":"integer","minimum":1.0,"title":"Sequence","description":"Document sequence number.","default":1},"parent":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Parent","description":"Parent title."},"id":{"type":"string","title":"Id","description":"Unique id in db."},"history":{"$ref":"#/components/schemas/HistoryResponse","description":"History reference."},"title":{"type":"string","maxLength":100,"minLength":3,"title":"Title","description":"Title."},"docRef":{"type":"string","maxLength":100,"minLength":3,"title":"Docref","description":"Document reference."}},"type":"object","required":["docId","id","history","title","docRef"],"title":"PageResponse","description":"Page response schema."},"PageResponsePublic":{"properties":{"docId":{"type":"string","maxLength":100,"minLength":3,"title":"Docid","description":"Document id."},"titleOverride":{"anyOf":[{"type":"string","maxLength":100},{"type":"null"}],"title":"Titleoverride","description":"Custom document title."},"sequence":{"type":"integer","minimum":1.0,"title":"Sequence","description":"Document sequence number.","default":1},"parent":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Parent","description":"Parent title."},"id":{"type":"string","title":"Id","description":"Page id."},"title":{"type":"string","maxLength":100,"minLength":3,"title":"Title","description":"Title."},"docRef":{"type":"string","maxLength":100,"minLength":3,"title":"Docref","description":"Document reference."}},"type":"object","required":["docId","id","title","docRef"],"title":"PageResponsePublic","description":"Page response public."},"PageResponseWithDocumentPublic":{"properties":{"docId":{"type":"string","maxLength":100,"minLength":3,"title":"Docid","description":"Document id."},"titleOverride":{"anyOf":[{"type":"string","maxLength":100},{"type":"null"}],"title":"Titleoverride","description":"Custom document title."},"sequence":{"type":"integer","minimum":1.0,"title":"Sequence","description":"Document sequence number.","default":1},"parent":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Parent","description":"Parent title."},"id":{"type":"string","title":"Id","description":"Page id."},"title":{"type":"string","maxLength":100,"minLength":3,"title":"Title","description":"Title."},"document":{"type":"string","title":"Document","description":"Document content."},"docRef":{"type":"string","maxLength":100,"minLength":3,"title":"Docref","description":"Document reference."}},"type":"object","required":["docId","id","title","document","docRef"],"title":"PageResponseWithDocumentPublic","description":"Page response with document schema."},"PageUpdate":{"properties":{"docId":{"type":"string","maxLength":100,"minLength":3,"title":"Docid","description":"Document id."},"titleOverride":{"anyOf":[{"type":"string","maxLength":100},{"type":"null"}],"title":"Titleoverride","description":"Custom document title."},"sequence":{"type":"integer","minimum":1.0,"title":"Sequence","description":"Document sequence number.","default":1},"parent":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Parent","description":"Parent title."},"revision":{"type":"integer","title":"Revision","description":"Revision for updated entry, empty for new."},"id":{"type":"string","title":"Id","description":"Page id."}},"type":"object","required":["docId","revision","id"],"title":"PageUpdate","description":"Page update scehma."},"StatusMessage":{"type":"string","enum":["OK","ERROR","NOT_FOUND","EXISTS_MUST_BE_UNIQUE","FAILED_TO_CREATE_OR_UPDATE","SUCCESSFULLY_DELETED","CONFLICT_NEWER_REVISION_IN_DB","FORBIDDEN","USER_VERIFIED","USER_VERIFICATION_FAILED","USER_LOGGED_OUT","OWNER_ASSIGNED_TO_CATALOGUE","INVALID_VAT_CODES","INTERNAL_SERVER_ERROR","DOCUMENT_UNIQUE_ORDER","ONLY_ONE_ENV_THROTTLING","PARENT_ITEM_EXISTS","INVALID_JSON","DOCUMENT_ASSIGNED","DOCUMENT_ALREADY_ASSIGNED_TO_PAGE"],"title":"StatusMessage","description":"Statuses."},"StatusResponse":{"properties":{"statusCode":{"type":"integer","title":"Statuscode","description":"Status http code."},"status":{"$ref":"#/components/schemas/StatusMessage","description":"Status."},"details":{"anyOf":[{"items":{},"type":"array"},{"type":"null"}],"title":"Details","description":"Details of the response and status, ex. error message."}},"type":"object","required":["statusCode","status"],"title":"StatusResponse","description":"Status response shcema."},"SupportRequestCreate":{"properties":{"subject":{"type":"string","maxLength":100,"minLength":10,"title":"Subject"},"first_name":{"type":"string","minLength":1,"title":"First Name"},"last_name":{"type":"string","minLength":1,"title":"Last Name"},"email":{"anyOf":[{"type":"string","format":"email"},{"type":"null"}],"title":"Email"},"phone":{"anyOf":[{"type":"string","pattern":"^\\+?[0-9 -]{5,20}$"},{"type":"null"}],"title":"Phone"},"company_name":{"anyOf":[{"type":"string","maxLength":50},{"type":"null"}],"title":"Company Name"},"company_id":{"anyOf":[{"type":"string","maxLength":30},{"type":"null"}],"title":"Company Id"},"body":{"type":"string","maxLength":10000,"minLength":30,"title":"Body"}},"type":"object","required":["subject","first_name","last_name","body"],"title":"SupportRequestCreate","description":"Support request create model."},"ThrottlingCreate":{"properties":{"name":{"type":"string","title":"Name","description":"Name of the throttling set."},"tierNumber":{"anyOf":[{"type":"integer","exclusiveMinimum":0.0},{"type":"null"}],"title":"Tiernumber","description":"Tier number."},"requestsMaxAmount":{"type":"integer","exclusiveMinimum":0.0,"title":"Requestsmaxamount","description":"Max amount of requests."},"timeInterval":{"type":"integer","exclusiveMinimum":0.0,"title":"Timeinterval","description":"Time interval for requests."},"catalogueId":{"type":"string","title":"Catalogueid","description":"Id of catalogue item to which throttling belongs."},"type":{"$ref":"#/components/schemas/ThrottlingType"}},"type":"object","required":["name","requestsMaxAmount","timeInterval","catalogueId","type"],"title":"ThrottlingCreate","description":"Throttling create schema."},"ThrottlingResponse":{"properties":{"name":{"type":"string","title":"Name","description":"Name of the throttling set."},"tierNumber":{"anyOf":[{"type":"integer","exclusiveMinimum":0.0},{"type":"null"}],"title":"Tiernumber","description":"Tier number."},"requestsMaxAmount":{"type":"integer","exclusiveMinimum":0.0,"title":"Requestsmaxamount","description":"Max amount of requests."},"timeInterval":{"type":"integer","exclusiveMinimum":0.0,"title":"Timeinterval","description":"Time interval for requests."},"catalogueId":{"type":"string","title":"Catalogueid","description":"Id of catalogue item to which throttling belongs."},"type":{"$ref":"#/components/schemas/ThrottlingType"},"id":{"type":"string","title":"Id","description":"Unique id in db."},"history":{"$ref":"#/components/schemas/HistoryResponse","description":"History reference."}},"type":"object","required":["name","requestsMaxAmount","timeInterval","catalogueId","type","id","history"],"title":"ThrottlingResponse","description":"Throttling response schema."},"ThrottlingResponseNoHistory":{"properties":{"name":{"type":"string","title":"Name","description":"Name of the throttling set."},"tierNumber":{"anyOf":[{"type":"integer","exclusiveMinimum":0.0},{"type":"null"}],"title":"Tiernumber","description":"Tier number."},"requestsMaxAmount":{"type":"integer","exclusiveMinimum":0.0,"title":"Requestsmaxamount","description":"Max amount of requests."},"timeInterval":{"type":"integer","exclusiveMinimum":0.0,"title":"Timeinterval","description":"Time interval for requests."},"catalogueId":{"type":"string","title":"Catalogueid","description":"Id of catalogue item to which throttling belongs."},"type":{"$ref":"#/components/schemas/ThrottlingType"},"id":{"type":"string","title":"Id","description":"Unique id in db."}},"type":"object","required":["name","requestsMaxAmount","timeInterval","catalogueId","type","id"],"title":"ThrottlingResponseNoHistory","description":"Throttling response without historyfields."},"ThrottlingType":{"type":"string","enum":["ENV","CONSUMER"],"title":"ThrottlingType","description":"Throttling type."},"ThrottlingUpdate":{"properties":{"name":{"type":"string","title":"Name","description":"Name of the throttling set."},"tierNumber":{"anyOf":[{"type":"integer","exclusiveMinimum":0.0},{"type":"null"}],"title":"Tiernumber","description":"Tier number."},"requestsMaxAmount":{"type":"integer","exclusiveMinimum":0.0,"title":"Requestsmaxamount","description":"Max amount of requests."},"timeInterval":{"type":"integer","exclusiveMinimum":0.0,"title":"Timeinterval","description":"Time interval for requests."},"catalogueId":{"type":"string","title":"Catalogueid","description":"Id of catalogue item to which throttling belongs."},"type":{"$ref":"#/components/schemas/ThrottlingType"},"revision":{"type":"integer","title":"Revision","description":"Revision for updated entry, empty for new."}},"type":"object","required":["name","requestsMaxAmount","timeInterval","catalogueId","type","revision"],"title":"ThrottlingUpdate","description":"Throttling update schema."},"TryOutAuthentication":{"properties":{"authenticated":{"type":"boolean","title":"Authenticated","description":"Bool to indicate if the client is successfully authenticated."}},"type":"object","required":["authenticated"],"title":"TryOutAuthentication","description":"Tryout authentication."},"TryOutCustomAttribute":{"properties":{"key":{"type":"string","title":"Key","description":"Key."},"value":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Value","description":"Value"}},"type":"object","required":["key"],"title":"TryOutCustomAttribute","description":"Tryout custom attribute."},"TryOutRequest":{"properties":{"method":{"type":"string","enum":["GET","POST","DELETE","PATCH","PUT"],"title":"Method","description":"Method.","default":"GET"},"targetName":{"type":"string","title":"Targetname","description":"Target name."},"payload":{"anyOf":[{"type":"string","format":"base64"},{"type":"null"}],"title":"Payload","description":"base64 encoded json payload."},"resource":{"type":"string","title":"Resource","description":"Resource path."},"queryParameters":{"anyOf":[{"items":{"$ref":"#/components/schemas/TryOutCustomAttribute"},"type":"array"},{"type":"null"}],"title":"Queryparameters","description":"Query parameters."},"headers":{"anyOf":[{"items":{"$ref":"#/components/schemas/TryOutCustomAttribute"},"type":"array"},{"type":"null"}],"title":"Headers","description":"Headers."},"cookies":{"anyOf":[{"items":{"$ref":"#/components/schemas/TryOutCustomAttribute"},"type":"array"},{"type":"null"}],"title":"Cookies","description":"Cookies."}},"type":"object","required":["targetName","resource"],"title":"TryOutRequest","description":"Tryout request."},"TryOutResponse":{"properties":{"payload":{"type":"string","format":"base64","title":"Payload","description":"base64 encoded json payload."},"requestUrl":{"type":"string","maxLength":2083,"minLength":1,"format":"uri","title":"Requesturl","description":"Request url."},"statusCode":{"type":"integer","title":"Statuscode","description":"Http status code for response."},"headers":{"anyOf":[{"items":{"$ref":"#/components/schemas/TryOutCustomAttribute"},"type":"array"},{"type":"null"}],"title":"Headers","description":"Headers."},"cookies":{"anyOf":[{"items":{"$ref":"#/components/schemas/TryOutCustomAttribute"},"type":"array"},{"type":"null"}],"title":"Cookies","description":"Cookies."}},"type":"object","required":["payload","requestUrl","statusCode"],"title":"TryOutResponse","description":"Tryout response."},"UserAccessRoles":{"type":"string","enum":["AdminUser","ApiTeamUser","AdminUser","ApiTeamUser"],"title":"UserAccessRoles","description":"User access roles."}}},"tags":[{"name":"health","description":"Health endpoint to monitor application status."},{"name":"history","description":"History endpoint to keep history and track activity regarding DB CRUD actions.\n\nFor new entries:\n- `created` and `modified` are set as current timestamps\n- `creator` and `modifier` as the account name (email)\n- `revision` as 1 (int)\n\nFor updated entries:\n- `modified` are set as current timestamp\n- `modifier` as as the account name (email)\n- `revision` incremented by 1\n\n**Important!** When making PUT (update) method revision is used to check if the entry to-be-updated, has not changed.\n\nIf the revision is not matching the revision from request, it will return and error `FAILED_TO_CREATE_OR_UPDATE`.\n        "},{"name":"document","description":"Document endpoint for managing documents.\n\nSpecification:\n- Documents are stored as [Markdown](https://www.markdownguide.org/) formatted strings.\n- `docId` is generated from `description` prefixed with unique identifier if not provided or then it must be unique per\nlanguage.\n- Currently supported language is only `EN`.\n\n**Important!** Document size max limit is 400KB.\n        "},{"name":"authentication","description":"Authentication endpoint for backend user management.\n\nCurrent ConfigUI users are managed through Cognito (ask development team to add when if needed).\n[How to.](https://postinext.atlassian.net/wiki/spaces/PODP/pages/2134278277/Authentication+and+user+management+with+Cognito)\n\nFor request endpoints uses FormData with mandatory `username` and `password`.\n        "},{"name":"lifecycle","description":"Lifecycle endpoint for managing API lifecycle statuses.\n\n`name` must be unique. No update action available.\n\nTODO: document all lifecycles when we have defined them\n\n**Important!** Endpoint available only for superadmins, API owners and maintainers get only READ access and can choose\nthe lifecycle.\n        "},{"name":"apipolicy","description":"API policies.\n\n`name` must be unique. No update action available.\n\nSupported API policies:\n- NONE: no policy applied\n- PUBLIC: public access\n- LOGISTICS: limited access by logistics contracts\n- VAT: limited access by VAT codes\n\n**Important!** Endpoint available only for superadmins, API owners and maintainers get only READ access and can choose\nthe API policies.\n        "},{"name":"owner","description":"Owner managing endpoint.\n\nContains owner or maintainer groups, having one or multiple emails. Which can be attached to APIs.\n        "},{"name":"throttling","description":"Throttling managing endpoint.\n\nDefines rate limiting options for API. API can contain multiple of these, where `tierNumber` as int must differ.\n\nSpecification:\n- name: for example like GOLD, SILVER, BRONZE as options for 3 tiers\n- tierNumber: int (positive and non-zero)\n- timeInterval: interval in seconds\n- requestsMaxAmount: max amount of requests that can be made in above defined `timeInterval`\n        "},{"name":"environment","description":"Environment managing endpoint.\n\nCurrently supported `PROD` and `DEMO`. `version` must be a valid [semver](https://semver.org/).\n        "},{"name":"catalogue","description":"API catalogue managing endpoint.\n\nSpecification:\n- `targetName` must be unique and is validated that no API exists with the same.\n- `businessOwners` are mandatory for initial creation only in MVP, will be removed when proper user management\nwill be in place.\n- After successful creation, lifecycle `DEVELOP` is set for API.\n\nBackground task:\n- Exports newly created API to SNS topic for further exports (ex. ext-link).\n        "},{"name":"public","description":"Publicly available resources without authentication.\n\nSpecification:\n- catalogue/environment: returns APIs where prd environment is in lifecycle PUBLISH.\n        "},{"name":"category","description":"Category management endpoint."},{"name":"page","description":"Document as pages endpoint."},{"name":"tryout","description":"Tryout tool endpoint."}]}