{"openapi":"3.0.0","paths":{"/api/v1/apikeys":{"post":{"operationId":"createOneBaseApiKeyControllerApiKey","x-access":"write","summary":"Create ApiKey","description":"Create a new ApiKey.\n\nNote that `applicationId`, 'createdAt' and 'updatedAt' are set automatically and will be overwritten if supplied.\n","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKey"}}}},"responses":{"201":{"description":"Create ApiKey response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKey"}}}},"401":{"description":"Unauthorized"}},"tags":["API Keys"],"security":[{"headerApiKey":[]},{"queryApiKey":[]}]},"get":{"operationId":"getManyBaseApiKeyControllerApiKey","x-access":"read","summary":"Get ApiKeys","description":"\nRetrieve an array of ApiKeys.\nSpecify query parameters to:\n\n- Select fields to retrieve.\n- Filter retrieved ApiKeys by field values.\n- Sort retrieved ApiKeys by field values.\n- Join related resources.\n- Limit the number of ApiKeys retrieved.\n- Offset the ApiKeys retrieved.\n","parameters":[{"name":"fields","description":"Select resource fields","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true,"example":["id","description"]},{"name":"filter","description":"Filter by resource fields","required":false,"in":"query","schema":{"type":"object","additionalProperties":{"type":"string"}},"style":"deepObject","explode":true,"example":{"name":"~air"}},{"name":"sort","description":"Select sort by field","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true,"example":["-updatedAt"]},{"name":"join","description":"Join related resources","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true,"example":["application","database"]},{"name":"limit","description":"Limit number of resources","required":false,"in":"query","schema":{"type":"integer"},"example":10},{"name":"offset","description":"Offset resources","required":false,"in":"query","schema":{"type":"integer"},"example":0}],"responses":{"200":{"description":"Get ApiKeys response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ApiKey"}}}}},"401":{"description":"Unauthorized"}},"tags":["API Keys"],"security":[{"headerApiKey":[]},{"queryApiKey":[]}]}},"/api/v1/apikeys/{id}":{"get":{"operationId":"getOneBaseApiKeyControllerApiKey","x-access":"read","summary":"Get ApiKey","description":"\nRetrieve the specified ApiKey. Specify query parameters to:\n\n- Select fields to retrieve.\n- Join related resources.\n","parameters":[{"name":"id","required":true,"in":"path","description":"ApiKey ID","example":"apikey-id","schema":{"type":"string"}},{"name":"fields","description":"Select resource fields","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false},{"name":"join","description":"Join related resources","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true}],"responses":{"200":{"description":"Get ApiKey response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKey"}}}},"401":{"description":"Unauthorized"},"404":{"description":"Resource not found"}},"tags":["API Keys"],"security":[{"headerApiKey":[]},{"queryApiKey":[]}]},"delete":{"operationId":"deleteOneBaseApiKeyControllerApiKey","x-access":"write","summary":"Delete ApiKey","description":"Delete the specified ApiKey.","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"Delete ApiKey response"},"401":{"description":"Unauthorized"},"404":{"description":"Resource not found"}},"tags":["API Keys"],"security":[{"headerApiKey":[]},{"queryApiKey":[]}]}},"/api/v1/apikeys/{id}/metadata":{"get":{"operationId":"ApiKeyController_getMetadata","summary":"Get metadata","description":"Get the complete metadata object for a resource.","parameters":[{"name":"id","required":true,"in":"path","description":"Resource ID","schema":{"type":"string"}}],"responses":{"200":{"description":"Metadata response","content":{"application/json":{"schema":{"type":"object","example":{"key1":{},"key2":{}}}}}}},"tags":["API Keys"],"security":[{"headerApiKey":[]},{"queryApiKey":[]},{"headerApiKey":[]},{"queryApiKey":[]}]},"put":{"operationId":"ApiKeyController_updateMetadata","summary":"Update metadata","description":"Update metadata object for a resource. Supplied object is merged with existing metadata.","parameters":[{"name":"id","required":true,"in":"path","description":"Resource ID","schema":{"type":"string"}}],"responses":{"200":{"description":"Metadata response","content":{"application/json":{"schema":{"type":"object","example":{"key1":{},"key2":{}}}}}}},"tags":["API Keys"],"security":[{"headerApiKey":[]},{"queryApiKey":[]},{"headerApiKey":[]},{"queryApiKey":[]}]}},"/api/v1/apikeys/{id}/metadata/{key}":{"get":{"operationId":"ApiKeyController_getMetadataKey","summary":"Get metadata by key","description":"Get resource metadata by key.","parameters":[{"name":"id","required":true,"in":"path","description":"Resource ID","schema":{"type":"string"}},{"name":"key","required":true,"in":"path","description":"Metadata key","schema":{"type":"string"}}],"responses":{"200":{"description":"Metadata by key response","content":{"application/json":{"schema":{"type":"object","example":{"prop1":{},"prop2":{}}}}}}},"tags":["API Keys"],"security":[{"headerApiKey":[]},{"queryApiKey":[]},{"headerApiKey":[]},{"queryApiKey":[]}]},"put":{"operationId":"ApiKeyController_setMetadataKey","summary":"Set metadata by key","description":"Set resource metadata by key.","parameters":[{"name":"id","required":true,"in":"path","description":"Resource ID","schema":{"type":"string"}},{"name":"key","required":true,"in":"path","description":"Metadata key","schema":{"type":"string"}}],"requestBody":{"required":true,"description":"Metadata value","content":{"application/json":{"schema":{"type":"object"}}}},"responses":{"200":{"description":"Metadata response","content":{"application/json":{"schema":{"type":"object","example":{"key1":{},"key2":{}}}}}}},"tags":["API Keys"],"security":[{"headerApiKey":[]},{"queryApiKey":[]},{"headerApiKey":[]},{"queryApiKey":[]}]},"delete":{"operationId":"ApiKeyController_deleteMetadataKey","summary":"Delete metadata by key","description":"Delete resource metadata by key.","parameters":[{"name":"id","required":true,"in":"path","description":"Resource ID","schema":{"type":"string"}},{"name":"key","required":true,"in":"path","description":"Metadata key","schema":{"type":"string"}}],"responses":{"200":{"description":"Resource metadata response","content":{"application/json":{"schema":{"type":"object","example":{"key1":{},"key2":{}}}}}}},"tags":["API Keys"],"security":[{"headerApiKey":[]},{"queryApiKey":[]},{"headerApiKey":[]},{"queryApiKey":[]}]}},"/api/v1/appconfig":{"get":{"operationId":"AppConfigController_getConfig","x-access":"execute","summary":"Get current AppConfig","description":"Returns configuration for the application associated with the supplied API key.","parameters":[],"responses":{"200":{"description":"Current AppConfig response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"flow":{"$ref":"#/components/schemas/ConfigDto"}},"example":{"key1":{},"key2":{},"flow":{"key1":{},"key2":{},"version":{"tag":"v1.0.48","hash":"9d9aa13","timestamp":1603280031}}}}}}},"401":{"description":"Unauthorized"}},"tags":["Application Configuration"],"security":[{"headerApiKey":[]},{"queryApiKey":[]}]},"put":{"operationId":"AppConfigController_setConfig","summary":"Set AppConfig","description":"Set entire application config value","parameters":[],"requestBody":{"required":true,"description":"AppConfig value","content":{"application/json":{"schema":{"type":"object"}}}},"responses":{"200":{"description":"AppConfig response","content":{"application/json":{"schema":{"type":"object","example":{"key1":{},"key2":{}}}}}}},"tags":["Application Configuration"],"security":[{"headerApiKey":[]},{"queryApiKey":[]},{"headerApiKey":[]},{"queryApiKey":[]}]}},"/api/v1/appconfig/{id}":{"get":{"operationId":"AppConfigController_getKey","x-access":"execute","summary":"Get AppConfig value by key","description":"Returns config value for the application associated with the supplied API key.","parameters":[{"name":"id","required":true,"in":"path","description":"AppConfig key (supports dotted notation)","schema":{"type":"string"}}],"responses":{"200":{"description":"Current AppConfig response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"flow":{"$ref":"#/components/schemas/ConfigDto"}},"example":{"key1":{},"key2":{},"flow":{"key1":{},"key2":{},"version":{"tag":"v1.0.48","hash":"9d9aa13","timestamp":1603280031}}}}}}},"401":{"description":"Unauthorized"}},"tags":["Application Configuration"],"security":[{"headerApiKey":[]},{"queryApiKey":[]}]},"put":{"operationId":"AppConfigController_setKey","summary":"Set AppConfig by key","description":"Set application config value by key.","parameters":[{"name":"id","required":true,"in":"path","description":"AppConfig key (supports dotted notation)","schema":{"type":"string"}}],"requestBody":{"required":true,"description":"AppConfig key value","content":{"application/json":{"schema":{"type":"object"}}}},"responses":{"200":{"description":"AppConfig response","content":{"application/json":{"schema":{"type":"object","example":{"key1":{},"key2":{}}}}}}},"tags":["Application Configuration"],"security":[{"headerApiKey":[]},{"queryApiKey":[]},{"headerApiKey":[]},{"queryApiKey":[]}]},"delete":{"operationId":"AppConfigController_deleteKey","summary":"Delete config value by key","description":"Delete AppConfig value by key.","parameters":[{"name":"id","required":true,"in":"path","description":"AppConfig key (supports dotted notation)","schema":{"type":"string"}}],"responses":{"200":{"description":"AppConfig response","content":{"application/json":{"schema":{"type":"object","example":{"key1":{},"key2":{}}}}}}},"tags":["Application Configuration"],"security":[{"headerApiKey":[]},{"queryApiKey":[]},{"headerApiKey":[]},{"queryApiKey":[]}]}},"/api/v1/applications/{id}":{"get":{"operationId":"getOneBaseApplicationControllerApplication","x-access":"read","summary":"Get Application","description":"\nRetrieve the specified Application. Specify query parameters to:\n\n- Select fields to retrieve.\n- Join related resources.\n","parameters":[{"name":"id","required":true,"in":"path","description":"Application ID","example":"application-id","schema":{"type":"string"}},{"name":"fields","description":"Select resource fields","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false},{"name":"join","description":"Join related resources","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true}],"responses":{"200":{"description":"Get Application response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Application"}}}},"401":{"description":"Unauthorized"},"404":{"description":"Resource not found"}},"tags":["Applications"],"security":[{"headerApiKey":[]},{"queryApiKey":[]}]},"put":{"operationId":"replaceOneBaseApplicationControllerApplication","x-access":"write","summary":"Update Application","description":"Update the specified Application using the body of the request. Partial updates are supported.\n\nNote that `id`, `applicationId`, 'createdAt' and 'updatedAt' are set automatically and will be overwritten if supplied.\n    ","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Application"}}}},"responses":{"200":{"description":"Update Application response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Application"}}}},"401":{"description":"Unauthorized"},"404":{"description":"Resource not found"}},"tags":["Applications"],"security":[{"headerApiKey":[]},{"queryApiKey":[]}]},"delete":{"operationId":"deleteOneBaseApplicationControllerApplication","x-access":"write","summary":"Delete Application","description":"Delete the specified Application.","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"Delete Application response"},"401":{"description":"Unauthorized"},"404":{"description":"Resource not found"}},"tags":["Applications"],"security":[{"headerApiKey":[]},{"queryApiKey":[]}]}},"/api/v1/applications":{"get":{"operationId":"getManyBaseApplicationControllerApplication","x-access":"read","summary":"Get Applications","description":"\nRetrieve an array of Applications.\nSpecify query parameters to:\n\n- Select fields to retrieve.\n- Filter retrieved Applications by field values.\n- Sort retrieved Applications by field values.\n- Join related resources.\n- Limit the number of Applications retrieved.\n- Offset the Applications retrieved.\n","parameters":[{"name":"fields","description":"Select resource fields","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true,"example":["id","description"]},{"name":"filter","description":"Filter by resource fields","required":false,"in":"query","schema":{"type":"object","additionalProperties":{"type":"string"}},"style":"deepObject","explode":true,"example":{"name":"~air"}},{"name":"sort","description":"Select sort by field","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true,"example":["-updatedAt"]},{"name":"join","description":"Join related resources","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true,"example":["application","database"]},{"name":"limit","description":"Limit number of resources","required":false,"in":"query","schema":{"type":"integer"},"example":10},{"name":"offset","description":"Offset resources","required":false,"in":"query","schema":{"type":"integer"},"example":0}],"responses":{"200":{"description":"Get Applications response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Application"}}}}},"401":{"description":"Unauthorized"}},"tags":["Applications"],"security":[{"headerApiKey":[]},{"queryApiKey":[]}]},"post":{"operationId":"createOneBaseApplicationControllerApplication","x-access":"write","summary":"Create Application","description":"Create a new Application.\n\nNote that `applicationId`, 'createdAt' and 'updatedAt' are set automatically and will be overwritten if supplied.\n","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Application"}}}},"responses":{"201":{"description":"Create Application response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Application"}}}},"401":{"description":"Unauthorized"}},"tags":["Applications"],"security":[{"headerApiKey":[]},{"queryApiKey":[]}]}},"/api/v1/applications/{id}/metadata":{"get":{"operationId":"ApplicationController_getMetadata","summary":"Get metadata","description":"Get the complete metadata object for a resource.","parameters":[{"name":"id","required":true,"in":"path","description":"Resource ID","schema":{"type":"string"}}],"responses":{"200":{"description":"Metadata response","content":{"application/json":{"schema":{"type":"object","example":{"key1":{},"key2":{}}}}}}},"tags":["Applications"],"security":[{"headerApiKey":[]},{"queryApiKey":[]},{"headerApiKey":[]},{"queryApiKey":[]}]},"put":{"operationId":"ApplicationController_updateMetadata","summary":"Update metadata","description":"Update metadata object for a resource. Supplied object is merged with existing metadata.","parameters":[{"name":"id","required":true,"in":"path","description":"Resource ID","schema":{"type":"string"}}],"responses":{"200":{"description":"Metadata response","content":{"application/json":{"schema":{"type":"object","example":{"key1":{},"key2":{}}}}}}},"tags":["Applications"],"security":[{"headerApiKey":[]},{"queryApiKey":[]},{"headerApiKey":[]},{"queryApiKey":[]}]}},"/api/v1/applications/{id}/metadata/{key}":{"get":{"operationId":"ApplicationController_getMetadataKey","summary":"Get metadata by key","description":"Get resource metadata by key.","parameters":[{"name":"id","required":true,"in":"path","description":"Resource ID","schema":{"type":"string"}},{"name":"key","required":true,"in":"path","description":"Metadata key","schema":{"type":"string"}}],"responses":{"200":{"description":"Metadata by key response","content":{"application/json":{"schema":{"type":"object","example":{"prop1":{},"prop2":{}}}}}}},"tags":["Applications"],"security":[{"headerApiKey":[]},{"queryApiKey":[]},{"headerApiKey":[]},{"queryApiKey":[]}]},"put":{"operationId":"ApplicationController_setMetadataKey","summary":"Set metadata by key","description":"Set resource metadata by key.","parameters":[{"name":"id","required":true,"in":"path","description":"Resource ID","schema":{"type":"string"}},{"name":"key","required":true,"in":"path","description":"Metadata key","schema":{"type":"string"}}],"requestBody":{"required":true,"description":"Metadata value","content":{"application/json":{"schema":{"type":"object"}}}},"responses":{"200":{"description":"Metadata response","content":{"application/json":{"schema":{"type":"object","example":{"key1":{},"key2":{}}}}}}},"tags":["Applications"],"security":[{"headerApiKey":[]},{"queryApiKey":[]},{"headerApiKey":[]},{"queryApiKey":[]}]},"delete":{"operationId":"ApplicationController_deleteMetadataKey","summary":"Delete metadata by key","description":"Delete resource metadata by key.","parameters":[{"name":"id","required":true,"in":"path","description":"Resource ID","schema":{"type":"string"}},{"name":"key","required":true,"in":"path","description":"Metadata key","schema":{"type":"string"}}],"responses":{"200":{"description":"Resource metadata response","content":{"application/json":{"schema":{"type":"object","example":{"key1":{},"key2":{}}}}}}},"tags":["Applications"],"security":[{"headerApiKey":[]},{"queryApiKey":[]},{"headerApiKey":[]},{"queryApiKey":[]}]}},"/api/v1/auth/login":{"post":{"operationId":"AuthController_login","summary":"Log In","description":"Log in using the supplied credentials.","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LoginDto"}}}},"responses":{"200":{"description":"Current User response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthLoginResponse"}}}},"401":{"description":"Unauthorized"}},"tags":["Authentication"]}},"/api/v1/auth/logout":{"post":{"operationId":"AuthController_logout","x-access":"execute","summary":"Log Out","description":"Log out and invalidate the associated refresh token.","parameters":[{"name":"Authentication","in":"header","description":"Authorization bearer token","required":true,"schema":{"type":"string","example":"Bearer <jwt token>"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"refreshToken":{"type":"string","description":"Refresh token to invalidate"}}}}}},"responses":{"204":{"description":"Log Out response"},"401":{"description":"Unauthorized"}},"tags":["Authentication"],"security":[{"headerApiKey":[]},{"queryApiKey":[]}]}},"/api/v1/auth/refresh":{"post":{"operationId":"AuthController_refresh","summary":"Refresh authentication token","description":"Supply a valid refresh token to retrieve a refreshed JWT authentication token.","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"refreshToken":{"type":"string"},"applicationId":{"type":"string"}}}}}},"responses":{"200":{"description":"Refreshed JWT authentication token","content":{"application/json":{"schema":{"type":"string"}}}}},"tags":["Authentication"]}},"/api/v1/auth/changepassword":{"post":{"operationId":"AuthController_changePassword","x-access":"execute","summary":"Change password","description":"Change the password of the User identified by the supplied Authorization token.","parameters":[{"name":"Authentication","in":"header","description":"Authorization bearer token","required":true,"schema":{"type":"string","example":"Bearer <jwt token>"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChangePasswordDto"}}}},"responses":{"204":{"description":"Change Password response"}},"tags":["Authentication"],"security":[{"headerApiKey":[]},{"queryApiKey":[]}]}},"/api/v1/auth/signup":{"post":{"operationId":"AuthController_signUp","summary":"Sign up new user","description":"Creates a new User. Note that the supplied email address must be approved for sign-up.","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignupDto"}}}},"responses":{"200":{"description":"Sign Up response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}}},"401":{"description":"Unauthorized"}},"tags":["Authentication"]}},"/api/v1/auth/confirmsignup":{"get":{"operationId":"AuthController_confirmSignUp","summary":"Confirm sign-up","description":"This endpoint is supplied in the sign-up confirmation email sent to new users.","parameters":[{"name":"email","required":true,"in":"query","schema":{"type":"string"}},{"name":"redirect","required":true,"in":"path","description":"Redirection URL","schema":{"type":"string"}},{"name":"token","required":true,"in":"path","description":"Sign-up verification token","schema":{"type":"string"}}],"responses":{"302":{"description":"Redirect to specified URL on successful sign-up"},"401":{"description":"Unauthorized"}},"tags":["Authentication"]}},"/api/v1/auth/requestpasswordreset":{"post":{"operationId":"AuthController_requestPasswordReset","summary":"Request password reset","description":"Request a password reset email.","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RequestPasswordResetDto"}}}},"responses":{"204":{"description":"Request password reset response"},"401":{"description":"Unauthorized"}},"tags":["Authentication"]}},"/api/v1/auth/resetpassword":{"post":{"operationId":"AuthController_resetPassword","summary":"Reset password","description":"Reset a password in response to a password-reset request. This endpoint is supplied in the password-reset email sent to a user.","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResetPasswordDto"}}}},"responses":{"204":{"description":"Reset password response"},"401":{"description":"Unauthorized"}},"tags":["Authentication"]}},"/api/v1/config":{"get":{"operationId":"ConfigController_getConfig","summary":"Get server configuration","parameters":[],"responses":{"200":{"description":"Configuration response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfigDto"},"example":{"key1":{},"key2":{},"version":{"tag":"v1.0.48","hash":"9d9aa13","timestamp":1603280031}}}}},"401":{"description":"Unauthorized"}},"tags":["Server Configuration"],"security":[{"headerApiKey":[]},{"queryApiKey":[]}]}},"/api/v1/contactpoints/{id}/send":{"post":{"operationId":"ContactPointController_send","x-access":"execute","summary":"Send a notification to the contact point","description":"Send a notification to the contact point.","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContactPointSendRequestDto"}}}},"responses":{"202":{"description":"Notification accepted for delivery"}},"tags":["Contact Points"],"security":[{"headerApiKey":[]},{"queryApiKey":[]}]}},"/api/v1/contactpoints/drivers":{"get":{"operationId":"ContactPointController_getDrivers","x-access":"read","summary":"Get drivers","description":"Returns a list of available contact point drivers.","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}}},"tags":["Contact Points"],"security":[{"headerApiKey":[]},{"queryApiKey":[]}]}},"/api/v1/contactpoints/{id}":{"get":{"operationId":"getOneBaseContactPointControllerContactPoint","x-access":"read","summary":"Get ContactPoint","description":"\nRetrieve the specified ContactPoint. Specify query parameters to:\n\n- Select fields to retrieve.\n- Join related resources.\n","parameters":[{"name":"id","required":true,"in":"path","description":"ContactPoint ID","example":"contactpoint-id","schema":{"type":"string"}},{"name":"fields","description":"Select resource fields","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false},{"name":"join","description":"Join related resources","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true}],"responses":{"200":{"description":"Get ContactPoint response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContactPoint"}}}},"401":{"description":"Unauthorized"},"404":{"description":"Resource not found"}},"tags":["Contact Points"],"security":[{"headerApiKey":[]},{"queryApiKey":[]}]},"put":{"operationId":"replaceOneBaseContactPointControllerContactPoint","x-access":"write","summary":"Update ContactPoint","description":"Update the specified ContactPoint using the body of the request. Partial updates are supported.\n\nNote that `id`, `applicationId`, 'createdAt' and 'updatedAt' are set automatically and will be overwritten if supplied.\n    ","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContactPoint"}}}},"responses":{"200":{"description":"Update ContactPoint response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContactPoint"}}}},"401":{"description":"Unauthorized"},"404":{"description":"Resource not found"}},"tags":["Contact Points"],"security":[{"headerApiKey":[]},{"queryApiKey":[]}]},"delete":{"operationId":"deleteOneBaseContactPointControllerContactPoint","x-access":"write","summary":"Delete ContactPoint","description":"Delete the specified ContactPoint.","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"Delete ContactPoint response"},"401":{"description":"Unauthorized"},"404":{"description":"Resource not found"}},"tags":["Contact Points"],"security":[{"headerApiKey":[]},{"queryApiKey":[]}]}},"/api/v1/contactpoints":{"get":{"operationId":"getManyBaseContactPointControllerContactPoint","x-access":"read","summary":"Get ContactPoints","description":"\nRetrieve an array of ContactPoints.\nSpecify query parameters to:\n\n- Select fields to retrieve.\n- Filter retrieved ContactPoints by field values.\n- Sort retrieved ContactPoints by field values.\n- Join related resources.\n- Limit the number of ContactPoints retrieved.\n- Offset the ContactPoints retrieved.\n","parameters":[{"name":"fields","description":"Select resource fields","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true,"example":["id","description"]},{"name":"filter","description":"Filter by resource fields","required":false,"in":"query","schema":{"type":"object","additionalProperties":{"type":"string"}},"style":"deepObject","explode":true,"example":{"name":"~air"}},{"name":"sort","description":"Select sort by field","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true,"example":["-updatedAt"]},{"name":"join","description":"Join related resources","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true,"example":["application","database"]},{"name":"limit","description":"Limit number of resources","required":false,"in":"query","schema":{"type":"integer"},"example":10},{"name":"offset","description":"Offset resources","required":false,"in":"query","schema":{"type":"integer"},"example":0}],"responses":{"200":{"description":"Get ContactPoints response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ContactPoint"}}}}},"401":{"description":"Unauthorized"}},"tags":["Contact Points"],"security":[{"headerApiKey":[]},{"queryApiKey":[]}]},"post":{"operationId":"createOneBaseContactPointControllerContactPoint","x-access":"write","summary":"Create ContactPoint","description":"Create a new ContactPoint.\n\nNote that `applicationId`, 'createdAt' and 'updatedAt' are set automatically and will be overwritten if supplied.\n","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContactPoint"}}}},"responses":{"201":{"description":"Create ContactPoint response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContactPoint"}}}},"401":{"description":"Unauthorized"}},"tags":["Contact Points"],"security":[{"headerApiKey":[]},{"queryApiKey":[]}]}},"/api/v1/contactpoints/{id}/metadata":{"get":{"operationId":"ContactPointController_getMetadata","summary":"Get metadata","description":"Get the complete metadata object for a resource.","parameters":[{"name":"id","required":true,"in":"path","description":"Resource ID","schema":{"type":"string"}}],"responses":{"200":{"description":"Metadata response","content":{"application/json":{"schema":{"type":"object","example":{"key1":{},"key2":{}}}}}}},"tags":["Contact Points"],"security":[{"headerApiKey":[]},{"queryApiKey":[]},{"headerApiKey":[]},{"queryApiKey":[]}]},"put":{"operationId":"ContactPointController_updateMetadata","summary":"Update metadata","description":"Update metadata object for a resource. Supplied object is merged with existing metadata.","parameters":[{"name":"id","required":true,"in":"path","description":"Resource ID","schema":{"type":"string"}}],"responses":{"200":{"description":"Metadata response","content":{"application/json":{"schema":{"type":"object","example":{"key1":{},"key2":{}}}}}}},"tags":["Contact Points"],"security":[{"headerApiKey":[]},{"queryApiKey":[]},{"headerApiKey":[]},{"queryApiKey":[]}]}},"/api/v1/contactpoints/{id}/metadata/{key}":{"get":{"operationId":"ContactPointController_getMetadataKey","summary":"Get metadata by key","description":"Get resource metadata by key.","parameters":[{"name":"id","required":true,"in":"path","description":"Resource ID","schema":{"type":"string"}},{"name":"key","required":true,"in":"path","description":"Metadata key","schema":{"type":"string"}}],"responses":{"200":{"description":"Metadata by key response","content":{"application/json":{"schema":{"type":"object","example":{"prop1":{},"prop2":{}}}}}}},"tags":["Contact Points"],"security":[{"headerApiKey":[]},{"queryApiKey":[]},{"headerApiKey":[]},{"queryApiKey":[]}]},"put":{"operationId":"ContactPointController_setMetadataKey","summary":"Set metadata by key","description":"Set resource metadata by key.","parameters":[{"name":"id","required":true,"in":"path","description":"Resource ID","schema":{"type":"string"}},{"name":"key","required":true,"in":"path","description":"Metadata key","schema":{"type":"string"}}],"requestBody":{"required":true,"description":"Metadata value","content":{"application/json":{"schema":{"type":"object"}}}},"responses":{"200":{"description":"Metadata response","content":{"application/json":{"schema":{"type":"object","example":{"key1":{},"key2":{}}}}}}},"tags":["Contact Points"],"security":[{"headerApiKey":[]},{"queryApiKey":[]},{"headerApiKey":[]},{"queryApiKey":[]}]},"delete":{"operationId":"ContactPointController_deleteMetadataKey","summary":"Delete metadata by key","description":"Delete resource metadata by key.","parameters":[{"name":"id","required":true,"in":"path","description":"Resource ID","schema":{"type":"string"}},{"name":"key","required":true,"in":"path","description":"Metadata key","schema":{"type":"string"}}],"responses":{"200":{"description":"Resource metadata response","content":{"application/json":{"schema":{"type":"object","example":{"key1":{},"key2":{}}}}}}},"tags":["Contact Points"],"security":[{"headerApiKey":[]},{"queryApiKey":[]},{"headerApiKey":[]},{"queryApiKey":[]}]}},"/api/v1/databases/drivers":{"get":{"operationId":"DatasbaseController_getDrivers","x-access":"execute","summary":"Get drivers","description":"Returns a list of available database drivers.","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}}},"tags":["Databases"],"security":[{"headerApiKey":[]},{"queryApiKey":[]}]}},"/api/v1/databases/{id}":{"get":{"operationId":"getOneBaseDatasbaseControllerDatabase","x-access":"read","summary":"Get Database","description":"\nRetrieve the specified Database. Specify query parameters to:\n\n- Select fields to retrieve.\n- Join related resources.\n","parameters":[{"name":"id","required":true,"in":"path","description":"Database ID","example":"database-id","schema":{"type":"string"}},{"name":"fields","description":"Select resource fields","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false},{"name":"join","description":"Join related resources","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true}],"responses":{"200":{"description":"Get Database response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Database"}}}},"401":{"description":"Unauthorized"},"404":{"description":"Resource not found"}},"tags":["Databases"],"security":[{"headerApiKey":[]},{"queryApiKey":[]}]},"put":{"operationId":"replaceOneBaseDatasbaseControllerDatabase","x-access":"write","summary":"Update Database","description":"Update the specified Database using the body of the request. Partial updates are supported.\n\nNote that `id`, `applicationId`, 'createdAt' and 'updatedAt' are set automatically and will be overwritten if supplied.\n    ","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Database"}}}},"responses":{"200":{"description":"Update Database response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Database"}}}},"401":{"description":"Unauthorized"},"404":{"description":"Resource not found"}},"tags":["Databases"],"security":[{"headerApiKey":[]},{"queryApiKey":[]}]},"delete":{"operationId":"deleteOneBaseDatasbaseControllerDatabase","x-access":"write","summary":"Delete Database","description":"Delete the specified Database.","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"Delete Database response"},"401":{"description":"Unauthorized"},"404":{"description":"Resource not found"}},"tags":["Databases"],"security":[{"headerApiKey":[]},{"queryApiKey":[]}]}},"/api/v1/databases":{"get":{"operationId":"getManyBaseDatasbaseControllerDatabase","x-access":"read","summary":"Get Databases","description":"\nRetrieve an array of Databases.\nSpecify query parameters to:\n\n- Select fields to retrieve.\n- Filter retrieved Databases by field values.\n- Sort retrieved Databases by field values.\n- Join related resources.\n- Limit the number of Databases retrieved.\n- Offset the Databases retrieved.\n","parameters":[{"name":"fields","description":"Select resource fields","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true,"example":["id","description"]},{"name":"filter","description":"Filter by resource fields","required":false,"in":"query","schema":{"type":"object","additionalProperties":{"type":"string"}},"style":"deepObject","explode":true,"example":{"name":"~air"}},{"name":"sort","description":"Select sort by field","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true,"example":["-updatedAt"]},{"name":"join","description":"Join related resources","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true,"example":["application","database"]},{"name":"limit","description":"Limit number of resources","required":false,"in":"query","schema":{"type":"integer"},"example":10},{"name":"offset","description":"Offset resources","required":false,"in":"query","schema":{"type":"integer"},"example":0}],"responses":{"200":{"description":"Get Databases response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Database"}}}}},"401":{"description":"Unauthorized"}},"tags":["Databases"],"security":[{"headerApiKey":[]},{"queryApiKey":[]}]},"post":{"operationId":"createOneBaseDatasbaseControllerDatabase","x-access":"write","summary":"Create Database","description":"Create a new Database.\n\nNote that `applicationId`, 'createdAt' and 'updatedAt' are set automatically and will be overwritten if supplied.\n","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Database"}}}},"responses":{"201":{"description":"Create Database response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Database"}}}},"401":{"description":"Unauthorized"}},"tags":["Databases"],"security":[{"headerApiKey":[]},{"queryApiKey":[]}]}},"/api/v1/datasets":{"get":{"operationId":"getManyBaseDatasetControllerDataset","x-access":"read","summary":"Get Datasets","description":"\nRetrieve an array of Datasets.\nSpecify query parameters to:\n\n- Select fields to retrieve.\n- Filter retrieved Datasets by field values.\n- Sort retrieved Datasets by field values.\n- Join related resources.\n- Limit the number of Datasets retrieved.\n- Offset the Datasets retrieved.\n","parameters":[{"name":"tags","required":true,"in":"query","schema":{"type":"string"}},{"name":"fields","description":"Select resource fields","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true,"example":["id","description"]},{"name":"filter","description":"Filter by resource fields","required":false,"in":"query","schema":{"type":"object","additionalProperties":{"type":"string"}},"style":"deepObject","explode":true,"example":{"name":"~air"}},{"name":"sort","description":"Select sort by field","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true,"example":["-updatedAt"]},{"name":"join","description":"Join related resources","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true,"example":["application","database"]},{"name":"limit","description":"Limit number of resources","required":false,"in":"query","schema":{"type":"integer"},"example":10},{"name":"offset","description":"Offset resources","required":false,"in":"query","schema":{"type":"integer"},"example":0}],"responses":{"200":{"description":"Get Datasets response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Dataset"}}}}},"401":{"description":"Unauthorized"}},"tags":["Datasets"],"security":[{"headerApiKey":[]},{"queryApiKey":[]}]},"post":{"operationId":"createOneBaseDatasetControllerDataset","x-access":"write","summary":"Create Dataset","description":"Create a new Dataset.\n\nNote that `applicationId`, 'createdAt' and 'updatedAt' are set automatically and will be overwritten if supplied.\n","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Dataset"}}}},"responses":{"201":{"description":"Create Dataset response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Dataset"}}}},"401":{"description":"Unauthorized"}},"tags":["Datasets"],"security":[{"headerApiKey":[]},{"queryApiKey":[]}]}},"/api/v1/datasets/{id}":{"put":{"operationId":"replaceOneBaseDatasetControllerDataset","x-access":"write","summary":"Update Dataset","description":"Update the specified Dataset using the body of the request. Partial updates are supported.\n\nNote that `id`, `applicationId`, 'createdAt' and 'updatedAt' are set automatically and will be overwritten if supplied.\n    ","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Dataset"}}}},"responses":{"200":{"description":"Update Dataset response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Dataset"}}}},"401":{"description":"Unauthorized"},"404":{"description":"Resource not found"}},"tags":["Datasets"],"security":[{"headerApiKey":[]},{"queryApiKey":[]}]},"get":{"operationId":"getOneBaseDatasetControllerDataset","x-access":"read","summary":"Get Dataset","description":"\nRetrieve the specified Dataset. Specify query parameters to:\n\n- Select fields to retrieve.\n- Join related resources.\n","parameters":[{"name":"id","required":true,"in":"path","description":"Dataset ID","example":"dataset-id","schema":{"type":"string"}},{"name":"fields","description":"Select resource fields","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false},{"name":"join","description":"Join related resources","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true}],"responses":{"200":{"description":"Get Dataset response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Dataset"}}}},"401":{"description":"Unauthorized"},"404":{"description":"Resource not found"}},"tags":["Datasets"],"security":[{"headerApiKey":[]},{"queryApiKey":[]}]},"delete":{"operationId":"deleteOneBaseDatasetControllerDataset","x-access":"write","summary":"Delete Dataset","description":"Delete the specified Dataset.","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"Delete Dataset response"},"401":{"description":"Unauthorized"},"404":{"description":"Resource not found"}},"tags":["Datasets"],"security":[{"headerApiKey":[]},{"queryApiKey":[]}]}},"/api/v1/datasets/{id}/query":{"get":{"operationId":"DatasetController_querySimple","x-access":"execute","summary":"Query Dataset (simple)","description":"Query the specified dataset using simplified query string syntax.\n\nSpecify query parameters to:\n\n- Select attributes to retrieve.\n- Filter results by attribute values.\n- Supply query parameters.\n- Sort results.\n- Limit the number of results retrieved.\n- Offset the results retrieved.\n\nSee [Simplified Query Syntax](./datasets/dataset-queries.md#simplified-query-syntax).\n  ","parameters":[{"name":"id","required":true,"in":"path","description":"Dataset ID","example":"dataset-id","schema":{"type":"string"}},{"name":"format","required":false,"in":"query","description":"Response format","example":"json","schema":{"default":"json","enum":["json","geojson","csv"],"type":"string"}},{"name":"attributes","required":false,"in":"query","description":"Select attributes to return","explode":true,"style":"form","schema":{"type":"array","items":{"type":"string"}}},{"name":"filter","required":false,"in":"query","description":"Filter results","explode":true,"style":"deepObject","schema":{"additionalProperties":true,"type":"object"}},{"name":"sort","required":false,"in":"query","description":"Sort by attributes","explode":true,"style":"form","schema":{"type":"array","items":{"type":"string"}}},{"name":"limit","required":false,"in":"query","description":"Limit number of results","example":10,"schema":{"type":"number"}},{"name":"offset","required":false,"in":"query","description":"Offset results","example":0,"schema":{"type":"number"}},{"name":"filename","required":false,"in":"query","description":"Specify download file name\n\nAdds a `Content-Disposition: attachment; filename=\"<filename>\"` header to the response.\nThis hints that the response should be downloaded when the request is issued from a browser.\n  ","schema":{"type":"string"}}],"responses":{"200":{"description":"Query results","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/"}}},"text/csv":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/"}}}}},"404":{"description":"Dataset not found"}},"tags":["Datasets"],"security":[{"headerApiKey":[]},{"queryApiKey":[]}]},"post":{"operationId":"DatasetController_queryAdvanced","x-access":"execute","summary":"Query Dataset (advanced)","description":"Query the specified dataset using advanced post body syntax.\n\nSpecify query parameters to:\n\n- Select attributes to retrieve.\n- Filter results by attribute values.\n- Perform grouping and aggregation.\n- Sort results.\n- Limit the number of results retrieved.\n- Offset the results retrieved.\n\nSee [Dataset Query Definitions](./datasets/dataset-queries.md#flo-w-query-definitions).\n  ","parameters":[{"name":"id","required":true,"in":"path","description":"Dataset ID","example":"dataset-id","schema":{"type":"string"}},{"name":"format","required":false,"in":"query","description":"Response format","schema":{"default":"json","enum":["json","geojson","csv"],"type":"string"}},{"name":"timeout","required":false,"in":"query","description":"Query timeout (ms)","schema":{"default":null,"type":"number"}},{"name":"filename","required":false,"in":"query","description":"Specify download file name\n\nAdds a `Content-Disposition: attachment; filename=\"<filename>\"` header to the response.\nThis hints that the response should be downloaded when the request is issued from a browser.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdvancedQueryBodyDto"}}}},"responses":{"200":{"description":"Query results","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/"}}},"text/csv":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/"}}}}},"404":{"description":"Dataset not found"}},"tags":["Datasets"],"security":[{"headerApiKey":[]},{"queryApiKey":[]}]}},"/api/v1/datasets/{id}/export":{"get":{"operationId":"DatasetController_export","x-access":"read","summary":"Export Dataset","description":"Export the specified dataset\n    ","parameters":[{"name":"id","required":true,"in":"path","description":"Dataset ID","example":"dataset-id","schema":{"type":"string"}},{"name":"format","required":true,"in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Query results","content":{"application/binary":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/"}}}}},"404":{"description":"Dataset not found"}},"tags":["Datasets"],"security":[{"headerApiKey":[]},{"queryApiKey":[]}]}},"/api/v1/datasets/{id}/ingest":{"post":{"operationId":"DatasetController_ingest","x-access":"write","summary":"Ingest data to dataset","description":"insert, upsert and delete dataset records","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":""}},"tags":["Datasets"],"security":[{"headerApiKey":[]},{"queryApiKey":[]}]}},"/api/v1/datasets/{id}/metadata":{"get":{"operationId":"DatasetController_getMetadata","summary":"Get metadata","description":"Get the complete metadata object for a resource.","parameters":[{"name":"id","required":true,"in":"path","description":"Resource ID","schema":{"type":"string"}}],"responses":{"200":{"description":"Metadata response","content":{"application/json":{"schema":{"type":"object","example":{"key1":{},"key2":{}}}}}}},"tags":["Datasets"],"security":[{"headerApiKey":[]},{"queryApiKey":[]},{"headerApiKey":[]},{"queryApiKey":[]}]},"put":{"operationId":"DatasetController_updateMetadata","summary":"Update metadata","description":"Update metadata object for a resource. Supplied object is merged with existing metadata.","parameters":[{"name":"id","required":true,"in":"path","description":"Resource ID","schema":{"type":"string"}}],"responses":{"200":{"description":"Metadata response","content":{"application/json":{"schema":{"type":"object","example":{"key1":{},"key2":{}}}}}}},"tags":["Datasets"],"security":[{"headerApiKey":[]},{"queryApiKey":[]},{"headerApiKey":[]},{"queryApiKey":[]}]}},"/api/v1/datasets/{id}/metadata/{key}":{"get":{"operationId":"DatasetController_getMetadataKey","summary":"Get metadata by key","description":"Get resource metadata by key.","parameters":[{"name":"id","required":true,"in":"path","description":"Resource ID","schema":{"type":"string"}},{"name":"key","required":true,"in":"path","description":"Metadata key","schema":{"type":"string"}}],"responses":{"200":{"description":"Metadata by key response","content":{"application/json":{"schema":{"type":"object","example":{"prop1":{},"prop2":{}}}}}}},"tags":["Datasets"],"security":[{"headerApiKey":[]},{"queryApiKey":[]},{"headerApiKey":[]},{"queryApiKey":[]}]},"put":{"operationId":"DatasetController_setMetadataKey","summary":"Set metadata by key","description":"Set resource metadata by key.","parameters":[{"name":"id","required":true,"in":"path","description":"Resource ID","schema":{"type":"string"}},{"name":"key","required":true,"in":"path","description":"Metadata key","schema":{"type":"string"}}],"requestBody":{"required":true,"description":"Metadata value","content":{"application/json":{"schema":{"type":"object"}}}},"responses":{"200":{"description":"Metadata response","content":{"application/json":{"schema":{"type":"object","example":{"key1":{},"key2":{}}}}}}},"tags":["Datasets"],"security":[{"headerApiKey":[]},{"queryApiKey":[]},{"headerApiKey":[]},{"queryApiKey":[]}]},"delete":{"operationId":"DatasetController_deleteMetadataKey","summary":"Delete metadata by key","description":"Delete resource metadata by key.","parameters":[{"name":"id","required":true,"in":"path","description":"Resource ID","schema":{"type":"string"}},{"name":"key","required":true,"in":"path","description":"Metadata key","schema":{"type":"string"}}],"responses":{"200":{"description":"Resource metadata response","content":{"application/json":{"schema":{"type":"object","example":{"key1":{},"key2":{}}}}}}},"tags":["Datasets"],"security":[{"headerApiKey":[]},{"queryApiKey":[]},{"headerApiKey":[]},{"queryApiKey":[]}]}},"/fonts.json":{"get":{"operationId":"FontController_getFontIndex","summary":"Get installed map fonts","description":"Returns a list of installed map fonts.","parameters":[],"responses":{"200":{"description":"Installed font list","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}}},"tags":["Map Endpoints"]}},"/fonts/{fontstack}/{range}.pbf":{"get":{"operationId":"FontController_getFont","summary":"Get map font","description":"Returns the specified map font.","parameters":[{"name":"fontstack","required":true,"in":"path","description":"Font stack","example":"Metropolis Regular,Noto Sans Regular","schema":{"type":"string"}},{"name":"range","required":true,"in":"path","description":"Range","example":"0-255","schema":{"type":"string"}}],"responses":{"200":{"description":"Requested map font","content":{"application/protobuf":{"schema":{"type":"binary"}}}}},"tags":["Map Endpoints"]}},"/api/v1/healthcheck":{"get":{"operationId":"HealthCheckController_getHealthcheck","summary":"Get server healthcheck","parameters":[],"responses":{"200":{"description":"Healthcheck response","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string"}}},"example":{"status":"OK"}}}}},"tags":["Healthcheck","Healthcheck"]}},"/api/v1/jobs/submit":{"post":{"operationId":"JobController_submit","x-access":"execute","summary":"Submit a new job","description":"Submit a new processing job.","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobSubmitDto"}}}},"responses":{"200":{"description":"Submitted job","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Job"}}}}},"tags":["Jobs"],"security":[{"headerApiKey":[]},{"queryApiKey":[]}]}},"/api/v1/jobs/{id}/status":{"get":{"operationId":"JobController_getStatus","x-access":"read","summary":"Get status of a job","description":"Get the current status of a job.","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"Job status","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobStatusDto"}}}}},"tags":["Jobs"],"security":[{"headerApiKey":[]},{"queryApiKey":[]}]},"post":{"operationId":"JobController_setStatus","x-access":"write","summary":"Update status of a job","description":"Update the current status of a job.","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobStatusDto"}}}},"responses":{"200":{"description":"Updated Job","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Job"}}}}},"tags":["Jobs"],"security":[{"headerApiKey":[]},{"queryApiKey":[]}]}},"/api/v1/jobs/{id}/cancel":{"post":{"operationId":"JobController_cancelJob","x-access":"execute","summary":"Cancel a job","description":"Cancel a job.","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"Job status","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Job"}}}}},"tags":["Jobs"],"security":[{"headerApiKey":[]},{"queryApiKey":[]}]}},"/api/v1/jobs/{id}":{"delete":{"operationId":"JobController_deleteJob","x-access":"execute","summary":"Delete a job","description":"Delete a job.","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"204":{"description":"Delete Job"}},"tags":["Jobs"],"security":[{"headerApiKey":[]},{"queryApiKey":[]}]},"get":{"operationId":"getOneBaseJobControllerJob","x-access":"read","summary":"Get Job","description":"\nRetrieve the specified Job. Specify query parameters to:\n\n- Select fields to retrieve.\n- Join related resources.\n","parameters":[{"name":"id","required":true,"in":"path","description":"Job ID","example":"job-id","schema":{"type":"string"}},{"name":"fields","description":"Select resource fields","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false},{"name":"join","description":"Join related resources","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true}],"responses":{"200":{"description":"Get Job response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Job"}}}},"401":{"description":"Unauthorized"},"404":{"description":"Resource not found"}},"tags":["Jobs"],"security":[{"headerApiKey":[]},{"queryApiKey":[]}]},"patch":{"operationId":"updateOneBaseJobControllerJob","summary":"Update a single Job","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Job"}}}},"responses":{"200":{"description":"Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Job"}}}}},"tags":["Jobs"],"security":[{"headerApiKey":[]},{"queryApiKey":[]}]},"put":{"operationId":"replaceOneBaseJobControllerJob","x-access":"write","summary":"Update Job","description":"Update the specified Job using the body of the request. Partial updates are supported.\n\nNote that `id`, `applicationId`, 'createdAt' and 'updatedAt' are set automatically and will be overwritten if supplied.\n    ","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Job"}}}},"responses":{"200":{"description":"Update Job response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Job"}}}},"401":{"description":"Unauthorized"},"404":{"description":"Resource not found"}},"tags":["Jobs"],"security":[{"headerApiKey":[]},{"queryApiKey":[]}]}},"/api/v1/jobs/request":{"post":{"operationId":"JobController_requestJob","x-access":"write","summary":"Request a job","description":"Request a job.","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobRequestDto"}}}},"responses":{"204":{"description":"Request a pending Job for processing"}},"tags":["Jobs"],"security":[{"headerApiKey":[]},{"queryApiKey":[]}]}},"/api/v1/jobs":{"get":{"operationId":"getManyBaseJobControllerJob","x-access":"read","summary":"Get Jobs","description":"\nRetrieve an array of Jobs.\nSpecify query parameters to:\n\n- Select fields to retrieve.\n- Filter retrieved Jobs by field values.\n- Sort retrieved Jobs by field values.\n- Join related resources.\n- Limit the number of Jobs retrieved.\n- Offset the Jobs retrieved.\n","parameters":[{"name":"fields","description":"Select resource fields","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true,"example":["id","description"]},{"name":"filter","description":"Filter by resource fields","required":false,"in":"query","schema":{"type":"object","additionalProperties":{"type":"string"}},"style":"deepObject","explode":true,"example":{"name":"~air"}},{"name":"sort","description":"Select sort by field","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true,"example":["-updatedAt"]},{"name":"join","description":"Join related resources","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true,"example":["application","database"]},{"name":"limit","description":"Limit number of resources","required":false,"in":"query","schema":{"type":"integer"},"example":10},{"name":"offset","description":"Offset resources","required":false,"in":"query","schema":{"type":"integer"},"example":0}],"responses":{"200":{"description":"Get Jobs response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Job"}}}}},"401":{"description":"Unauthorized"}},"tags":["Jobs"],"security":[{"headerApiKey":[]},{"queryApiKey":[]}]},"post":{"operationId":"createOneBaseJobControllerJob","x-access":"write","summary":"Create Job","description":"Create a new Job.\n\nNote that `applicationId`, 'createdAt' and 'updatedAt' are set automatically and will be overwritten if supplied.\n","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Job"}}}},"responses":{"201":{"description":"Create Job response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Job"}}}},"401":{"description":"Unauthorized"}},"tags":["Jobs"],"security":[{"headerApiKey":[]},{"queryApiKey":[]}]}},"/api/v1/jobs/bulk":{"post":{"operationId":"createManyBaseJobControllerJob","summary":"Create multiple Jobs","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateManyJobDto"}}}},"responses":{"201":{"description":"Get create many base response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Job"}}}}}},"tags":["Jobs"],"security":[{"headerApiKey":[]},{"queryApiKey":[]}]}},"/api/v1/jobs/{id}/metadata":{"get":{"operationId":"JobController_getMetadata","summary":"Get metadata","description":"Get the complete metadata object for a resource.","parameters":[{"name":"id","required":true,"in":"path","description":"Resource ID","schema":{"type":"string"}}],"responses":{"200":{"description":"Metadata response","content":{"application/json":{"schema":{"type":"object","example":{"key1":{},"key2":{}}}}}}},"tags":["Jobs"],"security":[{"headerApiKey":[]},{"queryApiKey":[]},{"headerApiKey":[]},{"queryApiKey":[]}]},"put":{"operationId":"JobController_updateMetadata","summary":"Update metadata","description":"Update metadata object for a resource. Supplied object is merged with existing metadata.","parameters":[{"name":"id","required":true,"in":"path","description":"Resource ID","schema":{"type":"string"}}],"responses":{"200":{"description":"Metadata response","content":{"application/json":{"schema":{"type":"object","example":{"key1":{},"key2":{}}}}}}},"tags":["Jobs"],"security":[{"headerApiKey":[]},{"queryApiKey":[]},{"headerApiKey":[]},{"queryApiKey":[]}]}},"/api/v1/jobs/{id}/metadata/{key}":{"get":{"operationId":"JobController_getMetadataKey","summary":"Get metadata by key","description":"Get resource metadata by key.","parameters":[{"name":"id","required":true,"in":"path","description":"Resource ID","schema":{"type":"string"}},{"name":"key","required":true,"in":"path","description":"Metadata key","schema":{"type":"string"}}],"responses":{"200":{"description":"Metadata by key response","content":{"application/json":{"schema":{"type":"object","example":{"prop1":{},"prop2":{}}}}}}},"tags":["Jobs"],"security":[{"headerApiKey":[]},{"queryApiKey":[]},{"headerApiKey":[]},{"queryApiKey":[]}]},"put":{"operationId":"JobController_setMetadataKey","summary":"Set metadata by key","description":"Set resource metadata by key.","parameters":[{"name":"id","required":true,"in":"path","description":"Resource ID","schema":{"type":"string"}},{"name":"key","required":true,"in":"path","description":"Metadata key","schema":{"type":"string"}}],"requestBody":{"required":true,"description":"Metadata value","content":{"application/json":{"schema":{"type":"object"}}}},"responses":{"200":{"description":"Metadata response","content":{"application/json":{"schema":{"type":"object","example":{"key1":{},"key2":{}}}}}}},"tags":["Jobs"],"security":[{"headerApiKey":[]},{"queryApiKey":[]},{"headerApiKey":[]},{"queryApiKey":[]}]},"delete":{"operationId":"JobController_deleteMetadataKey","summary":"Delete metadata by key","description":"Delete resource metadata by key.","parameters":[{"name":"id","required":true,"in":"path","description":"Resource ID","schema":{"type":"string"}},{"name":"key","required":true,"in":"path","description":"Metadata key","schema":{"type":"string"}}],"responses":{"200":{"description":"Resource metadata response","content":{"application/json":{"schema":{"type":"object","example":{"key1":{},"key2":{}}}}}}},"tags":["Jobs"],"security":[{"headerApiKey":[]},{"queryApiKey":[]},{"headerApiKey":[]},{"queryApiKey":[]}]}},"/maps/{id}.json":{"get":{"operationId":"MapController_getMapStyle","x-access":"execute","summary":"Get map style","description":"Retrieve the MapboxGL map style specification for the specified Style.","parameters":[{"name":"id","required":true,"in":"path","description":"Map Style ID","example":"style-id","schema":{"type":"string"}}],"responses":{"200":{"description":"Requested map style","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}}},"tags":["Map Endpoints"],"security":[{"headerApiKey":[]},{"queryApiKey":[]}]}},"/api/v1/maplayers":{"post":{"operationId":"createOneBaseMapLayerControllerMapLayer","x-access":"write","summary":"Create MapLayer","description":"Create a new MapLayer.\n\nNote that `applicationId`, 'createdAt' and 'updatedAt' are set automatically and will be overwritten if supplied.\n","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MapLayer"}}}},"responses":{"201":{"description":"Create MapLayer response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MapLayer"}}}},"401":{"description":"Unauthorized"}},"tags":["Map Layers"],"security":[{"headerApiKey":[]},{"queryApiKey":[]}]},"get":{"operationId":"getManyBaseMapLayerControllerMapLayer","x-access":"read","summary":"Get MapLayers","description":"\nRetrieve an array of MapLayers.\nSpecify query parameters to:\n\n- Select fields to retrieve.\n- Filter retrieved MapLayers by field values.\n- Sort retrieved MapLayers by field values.\n- Join related resources.\n- Limit the number of MapLayers retrieved.\n- Offset the MapLayers retrieved.\n","parameters":[{"name":"fields","description":"Select resource fields","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true,"example":["id","description"]},{"name":"filter","description":"Filter by resource fields","required":false,"in":"query","schema":{"type":"object","additionalProperties":{"type":"string"}},"style":"deepObject","explode":true,"example":{"name":"~air"}},{"name":"sort","description":"Select sort by field","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true,"example":["-updatedAt"]},{"name":"join","description":"Join related resources","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true,"example":["application","database"]},{"name":"limit","description":"Limit number of resources","required":false,"in":"query","schema":{"type":"integer"},"example":10},{"name":"offset","description":"Offset resources","required":false,"in":"query","schema":{"type":"integer"},"example":0}],"responses":{"200":{"description":"Get MapLayers response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MapLayer"}}}}},"401":{"description":"Unauthorized"}},"tags":["Map Layers"],"security":[{"headerApiKey":[]},{"queryApiKey":[]}]}},"/api/v1/maplayers/{id}":{"put":{"operationId":"replaceOneBaseMapLayerControllerMapLayer","x-access":"write","summary":"Update MapLayer","description":"Update the specified MapLayer using the body of the request. Partial updates are supported.\n\nNote that `id`, `applicationId`, 'createdAt' and 'updatedAt' are set automatically and will be overwritten if supplied.\n    ","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MapLayer"}}}},"responses":{"200":{"description":"Update MapLayer response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MapLayer"}}}},"401":{"description":"Unauthorized"},"404":{"description":"Resource not found"}},"tags":["Map Layers"],"security":[{"headerApiKey":[]},{"queryApiKey":[]}]},"delete":{"operationId":"deleteOneBaseMapLayerControllerMapLayer","x-access":"write","summary":"Delete MapLayer","description":"Delete the specified MapLayer.","parameters":[{"name":"deleteDatasets","required":true,"in":"query","schema":{"type":"string"}},{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"Delete MapLayer response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MapLayer"}}}},"401":{"description":"Unauthorized"},"404":{"description":"Resource not found"}},"tags":["Map Layers"],"security":[{"headerApiKey":[]},{"queryApiKey":[]}]},"get":{"operationId":"getOneBaseMapLayerControllerMapLayer","x-access":"read","summary":"Get MapLayer","description":"\nRetrieve the specified MapLayer. Specify query parameters to:\n\n- Select fields to retrieve.\n- Join related resources.\n","parameters":[{"name":"id","required":true,"in":"path","description":"MapLayer ID","example":"maplayer-id","schema":{"type":"string"}},{"name":"fields","description":"Select resource fields","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false},{"name":"join","description":"Join related resources","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true}],"responses":{"200":{"description":"Get MapLayer response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MapLayer"}}}},"401":{"description":"Unauthorized"},"404":{"description":"Resource not found"}},"tags":["Map Layers"],"security":[{"headerApiKey":[]},{"queryApiKey":[]}]}},"/api/v1/maplayers/{id}/metadata":{"get":{"operationId":"MapLayerController_getMetadata","summary":"Get metadata","description":"Get the complete metadata object for a resource.","parameters":[{"name":"id","required":true,"in":"path","description":"Resource ID","schema":{"type":"string"}}],"responses":{"200":{"description":"Metadata response","content":{"application/json":{"schema":{"type":"object","example":{"key1":{},"key2":{}}}}}}},"tags":["Map Layers"],"security":[{"headerApiKey":[]},{"queryApiKey":[]},{"headerApiKey":[]},{"queryApiKey":[]}]},"put":{"operationId":"MapLayerController_updateMetadata","summary":"Update metadata","description":"Update metadata object for a resource. Supplied object is merged with existing metadata.","parameters":[{"name":"id","required":true,"in":"path","description":"Resource ID","schema":{"type":"string"}}],"responses":{"200":{"description":"Metadata response","content":{"application/json":{"schema":{"type":"object","example":{"key1":{},"key2":{}}}}}}},"tags":["Map Layers"],"security":[{"headerApiKey":[]},{"queryApiKey":[]},{"headerApiKey":[]},{"queryApiKey":[]}]}},"/api/v1/maplayers/{id}/metadata/{key}":{"get":{"operationId":"MapLayerController_getMetadataKey","summary":"Get metadata by key","description":"Get resource metadata by key.","parameters":[{"name":"id","required":true,"in":"path","description":"Resource ID","schema":{"type":"string"}},{"name":"key","required":true,"in":"path","description":"Metadata key","schema":{"type":"string"}}],"responses":{"200":{"description":"Metadata by key response","content":{"application/json":{"schema":{"type":"object","example":{"prop1":{},"prop2":{}}}}}}},"tags":["Map Layers"],"security":[{"headerApiKey":[]},{"queryApiKey":[]},{"headerApiKey":[]},{"queryApiKey":[]}]},"put":{"operationId":"MapLayerController_setMetadataKey","summary":"Set metadata by key","description":"Set resource metadata by key.","parameters":[{"name":"id","required":true,"in":"path","description":"Resource ID","schema":{"type":"string"}},{"name":"key","required":true,"in":"path","description":"Metadata key","schema":{"type":"string"}}],"requestBody":{"required":true,"description":"Metadata value","content":{"application/json":{"schema":{"type":"object"}}}},"responses":{"200":{"description":"Metadata response","content":{"application/json":{"schema":{"type":"object","example":{"key1":{},"key2":{}}}}}}},"tags":["Map Layers"],"security":[{"headerApiKey":[]},{"queryApiKey":[]},{"headerApiKey":[]},{"queryApiKey":[]}]},"delete":{"operationId":"MapLayerController_deleteMetadataKey","summary":"Delete metadata by key","description":"Delete resource metadata by key.","parameters":[{"name":"id","required":true,"in":"path","description":"Resource ID","schema":{"type":"string"}},{"name":"key","required":true,"in":"path","description":"Metadata key","schema":{"type":"string"}}],"responses":{"200":{"description":"Resource metadata response","content":{"application/json":{"schema":{"type":"object","example":{"key1":{},"key2":{}}}}}}},"tags":["Map Layers"],"security":[{"headerApiKey":[]},{"queryApiKey":[]},{"headerApiKey":[]},{"queryApiKey":[]}]}},"/api/v1/media":{"post":{"operationId":"MediaController_uploadMedia","x-access":"write","summary":"Upload a media file","description":"Upload a media file. For supported formats see here.","parameters":[],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/MediaUploadDto"}}}},"responses":{"200":{"description":"Media Upload response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Media"}}}},"401":{"description":"Unauthorized"}},"tags":["Media"],"security":[{"headerApiKey":[]},{"queryApiKey":[]}]},"get":{"operationId":"getManyBaseMediaControllerMedia","x-access":"read","summary":"Get Media","description":"\nRetrieve an array of Media.\nSpecify query parameters to:\n\n- Select fields to retrieve.\n- Filter retrieved Media by field values.\n- Sort retrieved Media by field values.\n- Join related resources.\n- Limit the number of Media retrieved.\n- Offset the Media retrieved.\n","parameters":[{"name":"fields","description":"Select resource fields","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true,"example":["id","description"]},{"name":"filter","description":"Filter by resource fields","required":false,"in":"query","schema":{"type":"object","additionalProperties":{"type":"string"}},"style":"deepObject","explode":true,"example":{"name":"~air"}},{"name":"sort","description":"Select sort by field","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true,"example":["-updatedAt"]},{"name":"join","description":"Join related resources","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true,"example":["application","database"]},{"name":"limit","description":"Limit number of resources","required":false,"in":"query","schema":{"type":"integer"},"example":10},{"name":"offset","description":"Offset resources","required":false,"in":"query","schema":{"type":"integer"},"example":0}],"responses":{"200":{"description":"Get Media response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Media"}}}}},"401":{"description":"Unauthorized"}},"tags":["Media"],"security":[{"headerApiKey":[]},{"queryApiKey":[]}]}},"/api/v1/media/{id}/content":{"get":{"operationId":"MediaController_getMediaContent","x-access":"execute","summary":"Get media content","description":"Get the requested media content.","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"Requested media content"}},"tags":["Media"],"security":[{"headerApiKey":[]},{"queryApiKey":[]}]}},"/api/v1/media/{id}":{"get":{"operationId":"getOneBaseMediaControllerMedia","x-access":"read","summary":"Get Media","description":"\nRetrieve the specified Media. Specify query parameters to:\n\n- Select fields to retrieve.\n- Join related resources.\n","parameters":[{"name":"id","required":true,"in":"path","description":"Media ID","example":"media-id","schema":{"type":"string"}},{"name":"fields","description":"Select resource fields","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false},{"name":"join","description":"Join related resources","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true}],"responses":{"200":{"description":"Get Media response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Media"}}}},"401":{"description":"Unauthorized"},"404":{"description":"Resource not found"}},"tags":["Media"],"security":[{"headerApiKey":[]},{"queryApiKey":[]}]},"patch":{"operationId":"updateOneBaseMediaControllerMedia","summary":"Update a single Media","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Media"}}}},"responses":{"200":{"description":"Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Media"}}}}},"tags":["Media"],"security":[{"headerApiKey":[]},{"queryApiKey":[]}]},"put":{"operationId":"replaceOneBaseMediaControllerMedia","x-access":"write","summary":"Update Media","description":"Update the specified Media using the body of the request. Partial updates are supported.\n\nNote that `id`, `applicationId`, 'createdAt' and 'updatedAt' are set automatically and will be overwritten if supplied.\n    ","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Media"}}}},"responses":{"200":{"description":"Update Media response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Media"}}}},"401":{"description":"Unauthorized"},"404":{"description":"Resource not found"}},"tags":["Media"],"security":[{"headerApiKey":[]},{"queryApiKey":[]}]},"delete":{"operationId":"deleteOneBaseMediaControllerMedia","x-access":"write","summary":"Delete Media","description":"Delete the specified Media.","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"Delete Media response"},"401":{"description":"Unauthorized"},"404":{"description":"Resource not found"}},"tags":["Media"],"security":[{"headerApiKey":[]},{"queryApiKey":[]}]}},"/api/v1/media/{id}/metadata":{"get":{"operationId":"MediaController_getMetadata","summary":"Get metadata","description":"Get the complete metadata object for a resource.","parameters":[{"name":"id","required":true,"in":"path","description":"Resource ID","schema":{"type":"string"}}],"responses":{"200":{"description":"Metadata response","content":{"application/json":{"schema":{"type":"object","example":{"key1":{},"key2":{}}}}}}},"tags":["Media"],"security":[{"headerApiKey":[]},{"queryApiKey":[]},{"headerApiKey":[]},{"queryApiKey":[]}]},"put":{"operationId":"MediaController_updateMetadata","summary":"Update metadata","description":"Update metadata object for a resource. Supplied object is merged with existing metadata.","parameters":[{"name":"id","required":true,"in":"path","description":"Resource ID","schema":{"type":"string"}}],"responses":{"200":{"description":"Metadata response","content":{"application/json":{"schema":{"type":"object","example":{"key1":{},"key2":{}}}}}}},"tags":["Media"],"security":[{"headerApiKey":[]},{"queryApiKey":[]},{"headerApiKey":[]},{"queryApiKey":[]}]}},"/api/v1/media/{id}/metadata/{key}":{"get":{"operationId":"MediaController_getMetadataKey","summary":"Get metadata by key","description":"Get resource metadata by key.","parameters":[{"name":"id","required":true,"in":"path","description":"Resource ID","schema":{"type":"string"}},{"name":"key","required":true,"in":"path","description":"Metadata key","schema":{"type":"string"}}],"responses":{"200":{"description":"Metadata by key response","content":{"application/json":{"schema":{"type":"object","example":{"prop1":{},"prop2":{}}}}}}},"tags":["Media"],"security":[{"headerApiKey":[]},{"queryApiKey":[]},{"headerApiKey":[]},{"queryApiKey":[]}]},"put":{"operationId":"MediaController_setMetadataKey","summary":"Set metadata by key","description":"Set resource metadata by key.","parameters":[{"name":"id","required":true,"in":"path","description":"Resource ID","schema":{"type":"string"}},{"name":"key","required":true,"in":"path","description":"Metadata key","schema":{"type":"string"}}],"requestBody":{"required":true,"description":"Metadata value","content":{"application/json":{"schema":{"type":"object"}}}},"responses":{"200":{"description":"Metadata response","content":{"application/json":{"schema":{"type":"object","example":{"key1":{},"key2":{}}}}}}},"tags":["Media"],"security":[{"headerApiKey":[]},{"queryApiKey":[]},{"headerApiKey":[]},{"queryApiKey":[]}]},"delete":{"operationId":"MediaController_deleteMetadataKey","summary":"Delete metadata by key","description":"Delete resource metadata by key.","parameters":[{"name":"id","required":true,"in":"path","description":"Resource ID","schema":{"type":"string"}},{"name":"key","required":true,"in":"path","description":"Metadata key","schema":{"type":"string"}}],"responses":{"200":{"description":"Resource metadata response","content":{"application/json":{"schema":{"type":"object","example":{"key1":{},"key2":{}}}}}}},"tags":["Media"],"security":[{"headerApiKey":[]},{"queryApiKey":[]},{"headerApiKey":[]},{"queryApiKey":[]}]}},"/metrics":{"get":{"operationId":"MetricsController_getMetrics","summary":"Get server metrics","parameters":[],"responses":{"200":{"description":""}},"tags":["Server Metrics"],"security":[{"headerApiKey":[]},{"queryApiKey":[]}]}},"/metrics/pipelines":{"get":{"operationId":"MetricsController_getPipelineMetrics","summary":"Get pipeline metrics","parameters":[],"responses":{"200":{"description":""}},"tags":["Server Metrics"],"security":[{"headerApiKey":[]},{"queryApiKey":[]}]}},"/api/v1/pipelines/{id}/heartbeat":{"post":{"operationId":"PipelineController_heartbeat","x-access":"write","summary":"Send pipeline heartbeat","description":"This endpoint should be called periodically by a running pipeline to indicate that it is still operational.\nThe heartbeatAt timestamp for the resource is updated to the current time.\n  ","parameters":[{"name":"id","required":true,"in":"path","description":"Pipeline ID","example":"pipeline-id","schema":{"type":"string"}}],"responses":{"204":{"description":"Heartbeat updated successfully"},"404":{"description":"Piepline not found"}},"tags":["Pipelines"],"security":[{"headerApiKey":[]},{"queryApiKey":[]}]}},"/api/v1/pipelines/publish-metrics":{"post":{"operationId":"PipelineController_publishMetrics","x-access":"write","summary":"Publish pipeline metrics","description":"This endpoint should be called periodically by a running pipeline to register metrics.","parameters":[],"requestBody":{"required":true,"description":"Metrics to be published","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PipelineMetric"}},"examples":{"example1":{"description":"Example of publishing an array of metrics","value":[{"pipelineId":"pipeline-id","componentId":"component-1","environment":"prod","name":"metric1","timestamp":"2026-05-14T15:47:49.719Z","value":123.45},{"pipelineId":"pipeline-id","componentId":"component-2","environment":"prod","name":"metric2","timestamp":"2026-05-14T15:47:49.719Z","value":123.45}]}}}}},"responses":{"204":{"description":"Metrics published successfully"}},"tags":["Pipelines"],"security":[{"headerApiKey":[]},{"queryApiKey":[]}]}},"/api/v1/pipelines/{id}":{"get":{"operationId":"getOneBasePipelineControllerPipeline","x-access":"read","summary":"Get Pipeline","description":"\nRetrieve the specified Pipeline. Specify query parameters to:\n\n- Select fields to retrieve.\n- Join related resources.\n","parameters":[{"name":"id","required":true,"in":"path","description":"Pipeline ID","example":"pipeline-id","schema":{"type":"string"}},{"name":"fields","description":"Select resource fields","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false},{"name":"join","description":"Join related resources","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true}],"responses":{"200":{"description":"Get Pipeline response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Pipeline"}}}},"401":{"description":"Unauthorized"},"404":{"description":"Resource not found"}},"tags":["Pipelines"],"security":[{"headerApiKey":[]},{"queryApiKey":[]}]},"put":{"operationId":"replaceOneBasePipelineControllerPipeline","x-access":"write","summary":"Update Pipeline","description":"Update the specified Pipeline using the body of the request. Partial updates are supported.\n\nNote that `id`, `applicationId`, 'createdAt' and 'updatedAt' are set automatically and will be overwritten if supplied.\n    ","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Pipeline"}}}},"responses":{"200":{"description":"Update Pipeline response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Pipeline"}}}},"401":{"description":"Unauthorized"},"404":{"description":"Resource not found"}},"tags":["Pipelines"],"security":[{"headerApiKey":[]},{"queryApiKey":[]}]},"delete":{"operationId":"deleteOneBasePipelineControllerPipeline","x-access":"write","summary":"Delete Pipeline","description":"Delete the specified Pipeline.","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"Delete Pipeline response"},"401":{"description":"Unauthorized"},"404":{"description":"Resource not found"}},"tags":["Pipelines"],"security":[{"headerApiKey":[]},{"queryApiKey":[]}]}},"/api/v1/pipelines":{"get":{"operationId":"getManyBasePipelineControllerPipeline","x-access":"read","summary":"Get Pipelines","description":"\nRetrieve an array of Pipelines.\nSpecify query parameters to:\n\n- Select fields to retrieve.\n- Filter retrieved Pipelines by field values.\n- Sort retrieved Pipelines by field values.\n- Join related resources.\n- Limit the number of Pipelines retrieved.\n- Offset the Pipelines retrieved.\n","parameters":[{"name":"fields","description":"Select resource fields","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true,"example":["id","description"]},{"name":"filter","description":"Filter by resource fields","required":false,"in":"query","schema":{"type":"object","additionalProperties":{"type":"string"}},"style":"deepObject","explode":true,"example":{"name":"~air"}},{"name":"sort","description":"Select sort by field","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true,"example":["-updatedAt"]},{"name":"join","description":"Join related resources","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true,"example":["application","database"]},{"name":"limit","description":"Limit number of resources","required":false,"in":"query","schema":{"type":"integer"},"example":10},{"name":"offset","description":"Offset resources","required":false,"in":"query","schema":{"type":"integer"},"example":0}],"responses":{"200":{"description":"Get Pipelines response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Pipeline"}}}}},"401":{"description":"Unauthorized"}},"tags":["Pipelines"],"security":[{"headerApiKey":[]},{"queryApiKey":[]}]},"post":{"operationId":"createOneBasePipelineControllerPipeline","x-access":"write","summary":"Create Pipeline","description":"Create a new Pipeline.\n\nNote that `applicationId`, 'createdAt' and 'updatedAt' are set automatically and will be overwritten if supplied.\n","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Pipeline"}}}},"responses":{"201":{"description":"Create Pipeline response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Pipeline"}}}},"401":{"description":"Unauthorized"}},"tags":["Pipelines"],"security":[{"headerApiKey":[]},{"queryApiKey":[]}]}},"/api/v1/pipelines/{id}/metadata":{"get":{"operationId":"PipelineController_getMetadata","summary":"Get metadata","description":"Get the complete metadata object for a resource.","parameters":[{"name":"id","required":true,"in":"path","description":"Resource ID","schema":{"type":"string"}}],"responses":{"200":{"description":"Metadata response","content":{"application/json":{"schema":{"type":"object","example":{"key1":{},"key2":{}}}}}}},"tags":["Pipelines"],"security":[{"headerApiKey":[]},{"queryApiKey":[]},{"headerApiKey":[]},{"queryApiKey":[]}]},"put":{"operationId":"PipelineController_updateMetadata","summary":"Update metadata","description":"Update metadata object for a resource. Supplied object is merged with existing metadata.","parameters":[{"name":"id","required":true,"in":"path","description":"Resource ID","schema":{"type":"string"}}],"responses":{"200":{"description":"Metadata response","content":{"application/json":{"schema":{"type":"object","example":{"key1":{},"key2":{}}}}}}},"tags":["Pipelines"],"security":[{"headerApiKey":[]},{"queryApiKey":[]},{"headerApiKey":[]},{"queryApiKey":[]}]}},"/api/v1/pipelines/{id}/metadata/{key}":{"get":{"operationId":"PipelineController_getMetadataKey","summary":"Get metadata by key","description":"Get resource metadata by key.","parameters":[{"name":"id","required":true,"in":"path","description":"Resource ID","schema":{"type":"string"}},{"name":"key","required":true,"in":"path","description":"Metadata key","schema":{"type":"string"}}],"responses":{"200":{"description":"Metadata by key response","content":{"application/json":{"schema":{"type":"object","example":{"prop1":{},"prop2":{}}}}}}},"tags":["Pipelines"],"security":[{"headerApiKey":[]},{"queryApiKey":[]},{"headerApiKey":[]},{"queryApiKey":[]}]},"put":{"operationId":"PipelineController_setMetadataKey","summary":"Set metadata by key","description":"Set resource metadata by key.","parameters":[{"name":"id","required":true,"in":"path","description":"Resource ID","schema":{"type":"string"}},{"name":"key","required":true,"in":"path","description":"Metadata key","schema":{"type":"string"}}],"requestBody":{"required":true,"description":"Metadata value","content":{"application/json":{"schema":{"type":"object"}}}},"responses":{"200":{"description":"Metadata response","content":{"application/json":{"schema":{"type":"object","example":{"key1":{},"key2":{}}}}}}},"tags":["Pipelines"],"security":[{"headerApiKey":[]},{"queryApiKey":[]},{"headerApiKey":[]},{"queryApiKey":[]}]},"delete":{"operationId":"PipelineController_deleteMetadataKey","summary":"Delete metadata by key","description":"Delete resource metadata by key.","parameters":[{"name":"id","required":true,"in":"path","description":"Resource ID","schema":{"type":"string"}},{"name":"key","required":true,"in":"path","description":"Metadata key","schema":{"type":"string"}}],"responses":{"200":{"description":"Resource metadata response","content":{"application/json":{"schema":{"type":"object","example":{"key1":{},"key2":{}}}}}}},"tags":["Pipelines"],"security":[{"headerApiKey":[]},{"queryApiKey":[]},{"headerApiKey":[]},{"queryApiKey":[]}]}},"/api/v1/pipelines/{pipelineId}/components/{id}":{"get":{"operationId":"getOneBasePipelineComponentControllerPipelineComponent","x-access":"read","summary":"Get PipelineComponent","description":"\nRetrieve the specified PipelineComponent. Specify query parameters to:\n\n- Select fields to retrieve.\n- Join related resources.\n","parameters":[{"name":"id","required":true,"in":"path","description":"PipelineComponent ID","example":"pipelinecomponent-id","schema":{"type":"string"}},{"name":"fields","description":"Select resource fields","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false},{"name":"join","description":"Join related resources","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true}],"responses":{"200":{"description":"Get PipelineComponent response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PipelineComponent"}}}},"401":{"description":"Unauthorized"},"404":{"description":"Resource not found"}},"tags":["Pipelines Components"],"security":[{"headerApiKey":[]},{"queryApiKey":[]}]},"put":{"operationId":"replaceOneBasePipelineComponentControllerPipelineComponent","x-access":"write","summary":"Update PipelineComponent","description":"Update the specified PipelineComponent using the body of the request. Partial updates are supported.\n\nNote that `id`, `applicationId`, 'createdAt' and 'updatedAt' are set automatically and will be overwritten if supplied.\n    ","parameters":[{"name":"pipelineId","required":true,"in":"path","schema":{"type":"string"}},{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PipelineComponent"}}}},"responses":{"200":{"description":"Update PipelineComponent response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PipelineComponent"}}}},"401":{"description":"Unauthorized"},"404":{"description":"Resource not found"}},"tags":["Pipelines Components"],"security":[{"headerApiKey":[]},{"queryApiKey":[]}]},"delete":{"operationId":"deleteOneBasePipelineComponentControllerPipelineComponent","x-access":"write","summary":"Delete PipelineComponent","description":"Delete the specified PipelineComponent.","parameters":[{"name":"pipelineId","required":true,"in":"path","schema":{"type":"string"}},{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"Delete PipelineComponent response"},"401":{"description":"Unauthorized"},"404":{"description":"Resource not found"}},"tags":["Pipelines Components"],"security":[{"headerApiKey":[]},{"queryApiKey":[]}]}},"/api/v1/pipelines/{pipelineId}/components":{"get":{"operationId":"getManyBasePipelineComponentControllerPipelineComponent","x-access":"read","summary":"Get PipelineComponents","description":"\nRetrieve an array of PipelineComponents.\nSpecify query parameters to:\n\n- Select fields to retrieve.\n- Filter retrieved PipelineComponents by field values.\n- Sort retrieved PipelineComponents by field values.\n- Join related resources.\n- Limit the number of PipelineComponents retrieved.\n- Offset the PipelineComponents retrieved.\n","parameters":[{"name":"fields","description":"Select resource fields","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true,"example":["id","description"]},{"name":"filter","description":"Filter by resource fields","required":false,"in":"query","schema":{"type":"object","additionalProperties":{"type":"string"}},"style":"deepObject","explode":true,"example":{"name":"~air"}},{"name":"sort","description":"Select sort by field","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true,"example":["-updatedAt"]},{"name":"join","description":"Join related resources","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true,"example":["application","database"]},{"name":"limit","description":"Limit number of resources","required":false,"in":"query","schema":{"type":"integer"},"example":10},{"name":"offset","description":"Offset resources","required":false,"in":"query","schema":{"type":"integer"},"example":0}],"responses":{"200":{"description":"Get PipelineComponents response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PipelineComponent"}}}}},"401":{"description":"Unauthorized"}},"tags":["Pipelines Components"],"security":[{"headerApiKey":[]},{"queryApiKey":[]}]},"post":{"operationId":"createOneBasePipelineComponentControllerPipelineComponent","x-access":"write","summary":"Create PipelineComponent","description":"Create a new PipelineComponent.\n\nNote that `applicationId`, 'createdAt' and 'updatedAt' are set automatically and will be overwritten if supplied.\n","parameters":[{"name":"pipelineId","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PipelineComponent"}}}},"responses":{"201":{"description":"Create PipelineComponent response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PipelineComponent"}}}},"401":{"description":"Unauthorized"}},"tags":["Pipelines Components"],"security":[{"headerApiKey":[]},{"queryApiKey":[]}]}},"/api/v1/pipelines/{pipelineId}/components/{id}/metadata":{"get":{"operationId":"PipelineComponentController_getMetadata","summary":"Get metadata","description":"Get the complete metadata object for a resource.","parameters":[{"name":"id","required":true,"in":"path","description":"Resource ID","schema":{"type":"string"}}],"responses":{"200":{"description":"Metadata response","content":{"application/json":{"schema":{"type":"object","example":{"key1":{},"key2":{}}}}}}},"tags":["Pipelines Components"],"security":[{"headerApiKey":[]},{"queryApiKey":[]},{"headerApiKey":[]},{"queryApiKey":[]}]},"put":{"operationId":"PipelineComponentController_updateMetadata","summary":"Update metadata","description":"Update metadata object for a resource. Supplied object is merged with existing metadata.","parameters":[{"name":"id","required":true,"in":"path","description":"Resource ID","schema":{"type":"string"}}],"responses":{"200":{"description":"Metadata response","content":{"application/json":{"schema":{"type":"object","example":{"key1":{},"key2":{}}}}}}},"tags":["Pipelines Components"],"security":[{"headerApiKey":[]},{"queryApiKey":[]},{"headerApiKey":[]},{"queryApiKey":[]}]}},"/api/v1/pipelines/{pipelineId}/components/{id}/metadata/{key}":{"get":{"operationId":"PipelineComponentController_getMetadataKey","summary":"Get metadata by key","description":"Get resource metadata by key.","parameters":[{"name":"id","required":true,"in":"path","description":"Resource ID","schema":{"type":"string"}},{"name":"key","required":true,"in":"path","description":"Metadata key","schema":{"type":"string"}}],"responses":{"200":{"description":"Metadata by key response","content":{"application/json":{"schema":{"type":"object","example":{"prop1":{},"prop2":{}}}}}}},"tags":["Pipelines Components"],"security":[{"headerApiKey":[]},{"queryApiKey":[]},{"headerApiKey":[]},{"queryApiKey":[]}]},"put":{"operationId":"PipelineComponentController_setMetadataKey","summary":"Set metadata by key","description":"Set resource metadata by key.","parameters":[{"name":"id","required":true,"in":"path","description":"Resource ID","schema":{"type":"string"}},{"name":"key","required":true,"in":"path","description":"Metadata key","schema":{"type":"string"}}],"requestBody":{"required":true,"description":"Metadata value","content":{"application/json":{"schema":{"type":"object"}}}},"responses":{"200":{"description":"Metadata response","content":{"application/json":{"schema":{"type":"object","example":{"key1":{},"key2":{}}}}}}},"tags":["Pipelines Components"],"security":[{"headerApiKey":[]},{"queryApiKey":[]},{"headerApiKey":[]},{"queryApiKey":[]}]},"delete":{"operationId":"PipelineComponentController_deleteMetadataKey","summary":"Delete metadata by key","description":"Delete resource metadata by key.","parameters":[{"name":"id","required":true,"in":"path","description":"Resource ID","schema":{"type":"string"}},{"name":"key","required":true,"in":"path","description":"Metadata key","schema":{"type":"string"}}],"responses":{"200":{"description":"Resource metadata response","content":{"application/json":{"schema":{"type":"object","example":{"key1":{},"key2":{}}}}}}},"tags":["Pipelines Components"],"security":[{"headerApiKey":[]},{"queryApiKey":[]},{"headerApiKey":[]},{"queryApiKey":[]}]}},"/api/v1/pipelines/{pipelineId}/components/{componentId}/metrics/{id}":{"get":{"operationId":"getOneBasePipelineMetricControllerPipelineMetric","x-access":"read","summary":"Get PipelineMetrics","description":"\nRetrieve the specified PipelineMetrics. Specify query parameters to:\n\n- Select fields to retrieve.\n- Join related resources.\n","parameters":[{"name":"id","required":true,"in":"path","description":"PipelineMetrics ID","example":"pipelinemetrics-id","schema":{"type":"string"}},{"name":"fields","description":"Select resource fields","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false},{"name":"join","description":"Join related resources","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true}],"responses":{"200":{"description":"Get PipelineMetrics response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PipelineMetric"}}}},"401":{"description":"Unauthorized"},"404":{"description":"Resource not found"}},"tags":["Pipeline Metrics"],"security":[{"headerApiKey":[]},{"queryApiKey":[]}]},"put":{"operationId":"replaceOneBasePipelineMetricControllerPipelineMetric","x-access":"write","summary":"Update PipelineMetrics","description":"Update the specified PipelineMetrics using the body of the request. Partial updates are supported.\n\nNote that `id`, `applicationId`, 'createdAt' and 'updatedAt' are set automatically and will be overwritten if supplied.\n    ","parameters":[{"name":"pipelineId","required":true,"in":"path","schema":{"type":"string"}},{"name":"componentId","required":true,"in":"path","schema":{"type":"string"}},{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PipelineMetric"}}}},"responses":{"200":{"description":"Update PipelineMetrics response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PipelineMetric"}}}},"401":{"description":"Unauthorized"},"404":{"description":"Resource not found"}},"tags":["Pipeline Metrics"],"security":[{"headerApiKey":[]},{"queryApiKey":[]}]},"delete":{"operationId":"deleteOneBasePipelineMetricControllerPipelineMetric","x-access":"write","summary":"Delete PipelineMetrics","description":"Delete the specified PipelineMetrics.","parameters":[{"name":"pipelineId","required":true,"in":"path","schema":{"type":"string"}},{"name":"componentId","required":true,"in":"path","schema":{"type":"string"}},{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"Delete PipelineMetrics response"},"401":{"description":"Unauthorized"},"404":{"description":"Resource not found"}},"tags":["Pipeline Metrics"],"security":[{"headerApiKey":[]},{"queryApiKey":[]}]}},"/api/v1/pipelines/{pipelineId}/components/{componentId}/metrics":{"get":{"operationId":"getManyBasePipelineMetricControllerPipelineMetric","x-access":"read","summary":"Get PipelineMetrics","description":"\nRetrieve an array of PipelineMetrics.\nSpecify query parameters to:\n\n- Select fields to retrieve.\n- Filter retrieved PipelineMetrics by field values.\n- Sort retrieved PipelineMetrics by field values.\n- Join related resources.\n- Limit the number of PipelineMetrics retrieved.\n- Offset the PipelineMetrics retrieved.\n","parameters":[{"name":"fields","description":"Select resource fields","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true,"example":["id","description"]},{"name":"filter","description":"Filter by resource fields","required":false,"in":"query","schema":{"type":"object","additionalProperties":{"type":"string"}},"style":"deepObject","explode":true,"example":{"name":"~air"}},{"name":"sort","description":"Select sort by field","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true,"example":["-updatedAt"]},{"name":"join","description":"Join related resources","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true,"example":["application","database"]},{"name":"limit","description":"Limit number of resources","required":false,"in":"query","schema":{"type":"integer"},"example":10},{"name":"offset","description":"Offset resources","required":false,"in":"query","schema":{"type":"integer"},"example":0}],"responses":{"200":{"description":"Get PipelineMetrics response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PipelineMetric"}}}}},"401":{"description":"Unauthorized"}},"tags":["Pipeline Metrics"],"security":[{"headerApiKey":[]},{"queryApiKey":[]}]},"post":{"operationId":"createOneBasePipelineMetricControllerPipelineMetric","x-access":"write","summary":"Create PipelineMetrics","description":"Create a new PipelineMetrics.\n\nNote that `applicationId`, 'createdAt' and 'updatedAt' are set automatically and will be overwritten if supplied.\n","parameters":[{"name":"pipelineId","required":true,"in":"path","schema":{"type":"string"}},{"name":"componentId","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PipelineMetric"}}}},"responses":{"201":{"description":"Create PipelineMetrics response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PipelineMetric"}}}},"401":{"description":"Unauthorized"}},"tags":["Pipeline Metrics"],"security":[{"headerApiKey":[]},{"queryApiKey":[]}]}},"/sprites/{path}":{"get":{"operationId":"SpriteController_getSprites","summary":"Get map sprite file","description":"Get a map sprite file.","parameters":[{"name":"path","required":true,"in":"path","description":"Path to sprite file","example":"sprite-file","schema":{"type":"string"}}],"responses":{"200":{"description":"Requested sprite file","content":{"application/json":{"schema":{"type":"binary"}}}}},"tags":["Map Endpoints"]}},"/api/v1/styles/{id}":{"get":{"operationId":"getOneBaseStyleControllerStyle","x-access":"read","summary":"Get Style","description":"\nRetrieve the specified Style. Specify query parameters to:\n\n- Select fields to retrieve.\n- Join related resources.\n","parameters":[{"name":"id","required":true,"in":"path","description":"Style ID","example":"style-id","schema":{"type":"string"}},{"name":"fields","description":"Select resource fields","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false},{"name":"join","description":"Join related resources","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true}],"responses":{"200":{"description":"Get Style response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Style"}}}},"401":{"description":"Unauthorized"},"404":{"description":"Resource not found"}},"tags":["Map Styles"],"security":[{"headerApiKey":[]},{"queryApiKey":[]}]},"put":{"operationId":"replaceOneBaseStyleControllerStyle","x-access":"write","summary":"Update Style","description":"Update the specified Style using the body of the request. Partial updates are supported.\n\nNote that `id`, `applicationId`, 'createdAt' and 'updatedAt' are set automatically and will be overwritten if supplied.\n    ","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Style"}}}},"responses":{"200":{"description":"Update Style response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Style"}}}},"401":{"description":"Unauthorized"},"404":{"description":"Resource not found"}},"tags":["Map Styles"],"security":[{"headerApiKey":[]},{"queryApiKey":[]}]},"delete":{"operationId":"deleteOneBaseStyleControllerStyle","x-access":"write","summary":"Delete Style","description":"Delete the specified Style.","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"Delete Style response"},"401":{"description":"Unauthorized"},"404":{"description":"Resource not found"}},"tags":["Map Styles"],"security":[{"headerApiKey":[]},{"queryApiKey":[]}]}},"/api/v1/styles":{"get":{"operationId":"getManyBaseStyleControllerStyle","x-access":"read","summary":"Get Styles","description":"\nRetrieve an array of Styles.\nSpecify query parameters to:\n\n- Select fields to retrieve.\n- Filter retrieved Styles by field values.\n- Sort retrieved Styles by field values.\n- Join related resources.\n- Limit the number of Styles retrieved.\n- Offset the Styles retrieved.\n","parameters":[{"name":"fields","description":"Select resource fields","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true,"example":["id","description"]},{"name":"filter","description":"Filter by resource fields","required":false,"in":"query","schema":{"type":"object","additionalProperties":{"type":"string"}},"style":"deepObject","explode":true,"example":{"name":"~air"}},{"name":"sort","description":"Select sort by field","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true,"example":["-updatedAt"]},{"name":"join","description":"Join related resources","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true,"example":["application","database"]},{"name":"limit","description":"Limit number of resources","required":false,"in":"query","schema":{"type":"integer"},"example":10},{"name":"offset","description":"Offset resources","required":false,"in":"query","schema":{"type":"integer"},"example":0}],"responses":{"200":{"description":"Get Styles response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Style"}}}}},"401":{"description":"Unauthorized"}},"tags":["Map Styles"],"security":[{"headerApiKey":[]},{"queryApiKey":[]}]},"post":{"operationId":"createOneBaseStyleControllerStyle","x-access":"write","summary":"Create Style","description":"Create a new Style.\n\nNote that `applicationId`, 'createdAt' and 'updatedAt' are set automatically and will be overwritten if supplied.\n","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Style"}}}},"responses":{"201":{"description":"Create Style response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Style"}}}},"401":{"description":"Unauthorized"}},"tags":["Map Styles"],"security":[{"headerApiKey":[]},{"queryApiKey":[]}]}},"/tiles/{id}/{z}/{x}/{y}.{ext}":{"get":{"operationId":"TileController_getTile","x-access":"execute","summary":"Get map tile","description":"Get the requested map tile.","parameters":[{"name":"id","required":true,"in":"path","description":"Tile Source ID","example":"tile-source-id","schema":{"type":"string"}},{"name":"x","required":true,"in":"path","description":"X coordinate","example":"x","schema":{"type":"number"}},{"name":"y","required":true,"in":"path","description":"Y coordinate","example":"y","schema":{"type":"number"}},{"name":"z","required":true,"in":"path","description":"Z coordinate","example":"z","schema":{"type":"number"}},{"name":"ext","required":true,"in":"path","description":"Tile extension","example":"ext","schema":{"type":"string"}},{"name":"explain","required":true,"in":"query","description":"Explain tile query","example":"false","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Requested map tile","content":{"application/x-protobuf":{"schema":{"type":"binary"}},"application/json":{"schema":{"type":"binary"}},"image/png":{"schema":{"type":"binary"}},"image/jpeg":{"schema":{"type":"binary"}}}}},"tags":["Map Endpoints"],"security":[{"headerApiKey":[]},{"queryApiKey":[]}]}},"/tiles/{id}/index.json":{"get":{"operationId":"TileController_getTileJson","x-access":"execute","summary":"Get Tile Source TileJSON","description":"Get the TileJSON specification for the specified Tile Source.","parameters":[{"name":"id","required":true,"in":"path","description":"Tile Source ID","example":"tile-source-id","schema":{"type":"string"}}],"responses":{"200":{"description":"Requested TileJSON specification","content":{"application/json":{"schema":{"type":"object"}}}}},"tags":["Map Endpoints"],"security":[{"headerApiKey":[]},{"queryApiKey":[]}]}},"/tiles/{id}/style.json":{"get":{"operationId":"TileController_getPreview","x-access":"execute","summary":"Get preview map style","description":"Retrieves a preview map style for the specified Tile Source.","parameters":[{"name":"id","required":true,"in":"path","description":"Tile Source ID","example":"tile-source-id","schema":{"type":"string"}}],"responses":{"200":{"description":"MapboxGL style specification","content":{"application/json":{"schema":{"type":"object"}}}}},"tags":["Map Endpoints"],"security":[{"headerApiKey":[]},{"queryApiKey":[]}]}},"/api/v1/tilesources/drivers":{"get":{"operationId":"TileSourceController_getDrivers","x-access":"execute","summary":"Get drivers","description":"Returns a list of available tile drivers.","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}}},"tags":["Map Tile Sources"],"security":[{"headerApiKey":[]},{"queryApiKey":[]}]}},"/api/v1/tilesources/{id}":{"get":{"operationId":"getOneBaseTileSourceControllerTileSource","x-access":"read","summary":"Get TileSource","description":"\nRetrieve the specified TileSource. Specify query parameters to:\n\n- Select fields to retrieve.\n- Join related resources.\n","parameters":[{"name":"id","required":true,"in":"path","description":"TileSource ID","example":"tilesource-id","schema":{"type":"string"}},{"name":"fields","description":"Select resource fields","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false},{"name":"join","description":"Join related resources","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true}],"responses":{"200":{"description":"Get TileSource response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TileSource"}}}},"401":{"description":"Unauthorized"},"404":{"description":"Resource not found"}},"tags":["Map Tile Sources"],"security":[{"headerApiKey":[]},{"queryApiKey":[]}]},"put":{"operationId":"replaceOneBaseTileSourceControllerTileSource","x-access":"write","summary":"Update TileSource","description":"Update the specified TileSource using the body of the request. Partial updates are supported.\n\nNote that `id`, `applicationId`, 'createdAt' and 'updatedAt' are set automatically and will be overwritten if supplied.\n    ","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TileSource"}}}},"responses":{"200":{"description":"Update TileSource response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TileSource"}}}},"401":{"description":"Unauthorized"},"404":{"description":"Resource not found"}},"tags":["Map Tile Sources"],"security":[{"headerApiKey":[]},{"queryApiKey":[]}]},"delete":{"operationId":"deleteOneBaseTileSourceControllerTileSource","x-access":"write","summary":"Delete TileSource","description":"Delete the specified TileSource.","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"Delete TileSource response"},"401":{"description":"Unauthorized"},"404":{"description":"Resource not found"}},"tags":["Map Tile Sources"],"security":[{"headerApiKey":[]},{"queryApiKey":[]}]}},"/api/v1/tilesources":{"get":{"operationId":"getManyBaseTileSourceControllerTileSource","x-access":"read","summary":"Get TileSources","description":"\nRetrieve an array of TileSources.\nSpecify query parameters to:\n\n- Select fields to retrieve.\n- Filter retrieved TileSources by field values.\n- Sort retrieved TileSources by field values.\n- Join related resources.\n- Limit the number of TileSources retrieved.\n- Offset the TileSources retrieved.\n","parameters":[{"name":"fields","description":"Select resource fields","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true,"example":["id","description"]},{"name":"filter","description":"Filter by resource fields","required":false,"in":"query","schema":{"type":"object","additionalProperties":{"type":"string"}},"style":"deepObject","explode":true,"example":{"name":"~air"}},{"name":"sort","description":"Select sort by field","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true,"example":["-updatedAt"]},{"name":"join","description":"Join related resources","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true,"example":["application","database"]},{"name":"limit","description":"Limit number of resources","required":false,"in":"query","schema":{"type":"integer"},"example":10},{"name":"offset","description":"Offset resources","required":false,"in":"query","schema":{"type":"integer"},"example":0}],"responses":{"200":{"description":"Get TileSources response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TileSource"}}}}},"401":{"description":"Unauthorized"}},"tags":["Map Tile Sources"],"security":[{"headerApiKey":[]},{"queryApiKey":[]}]},"post":{"operationId":"createOneBaseTileSourceControllerTileSource","x-access":"write","summary":"Create TileSource","description":"Create a new TileSource.\n\nNote that `applicationId`, 'createdAt' and 'updatedAt' are set automatically and will be overwritten if supplied.\n","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TileSource"}}}},"responses":{"201":{"description":"Create TileSource response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TileSource"}}}},"401":{"description":"Unauthorized"}},"tags":["Map Tile Sources"],"security":[{"headerApiKey":[]},{"queryApiKey":[]}]}},"/api/v1/tilesources/{id}/metadata":{"get":{"operationId":"TileSourceController_getMetadata","summary":"Get metadata","description":"Get the complete metadata object for a resource.","parameters":[{"name":"id","required":true,"in":"path","description":"Resource ID","schema":{"type":"string"}}],"responses":{"200":{"description":"Metadata response","content":{"application/json":{"schema":{"type":"object","example":{"key1":{},"key2":{}}}}}}},"tags":["Map Tile Sources"],"security":[{"headerApiKey":[]},{"queryApiKey":[]},{"headerApiKey":[]},{"queryApiKey":[]}]},"put":{"operationId":"TileSourceController_updateMetadata","summary":"Update metadata","description":"Update metadata object for a resource. Supplied object is merged with existing metadata.","parameters":[{"name":"id","required":true,"in":"path","description":"Resource ID","schema":{"type":"string"}}],"responses":{"200":{"description":"Metadata response","content":{"application/json":{"schema":{"type":"object","example":{"key1":{},"key2":{}}}}}}},"tags":["Map Tile Sources"],"security":[{"headerApiKey":[]},{"queryApiKey":[]},{"headerApiKey":[]},{"queryApiKey":[]}]}},"/api/v1/tilesources/{id}/metadata/{key}":{"get":{"operationId":"TileSourceController_getMetadataKey","summary":"Get metadata by key","description":"Get resource metadata by key.","parameters":[{"name":"id","required":true,"in":"path","description":"Resource ID","schema":{"type":"string"}},{"name":"key","required":true,"in":"path","description":"Metadata key","schema":{"type":"string"}}],"responses":{"200":{"description":"Metadata by key response","content":{"application/json":{"schema":{"type":"object","example":{"prop1":{},"prop2":{}}}}}}},"tags":["Map Tile Sources"],"security":[{"headerApiKey":[]},{"queryApiKey":[]},{"headerApiKey":[]},{"queryApiKey":[]}]},"put":{"operationId":"TileSourceController_setMetadataKey","summary":"Set metadata by key","description":"Set resource metadata by key.","parameters":[{"name":"id","required":true,"in":"path","description":"Resource ID","schema":{"type":"string"}},{"name":"key","required":true,"in":"path","description":"Metadata key","schema":{"type":"string"}}],"requestBody":{"required":true,"description":"Metadata value","content":{"application/json":{"schema":{"type":"object"}}}},"responses":{"200":{"description":"Metadata response","content":{"application/json":{"schema":{"type":"object","example":{"key1":{},"key2":{}}}}}}},"tags":["Map Tile Sources"],"security":[{"headerApiKey":[]},{"queryApiKey":[]},{"headerApiKey":[]},{"queryApiKey":[]}]},"delete":{"operationId":"TileSourceController_deleteMetadataKey","summary":"Delete metadata by key","description":"Delete resource metadata by key.","parameters":[{"name":"id","required":true,"in":"path","description":"Resource ID","schema":{"type":"string"}},{"name":"key","required":true,"in":"path","description":"Metadata key","schema":{"type":"string"}}],"responses":{"200":{"description":"Resource metadata response","content":{"application/json":{"schema":{"type":"object","example":{"key1":{},"key2":{}}}}}}},"tags":["Map Tile Sources"],"security":[{"headerApiKey":[]},{"queryApiKey":[]},{"headerApiKey":[]},{"queryApiKey":[]}]}},"/api/v1/uploads":{"post":{"operationId":"UploadController_uploadFile","x-access":"execute","summary":"Upload data file","description":"Upload a geospatial data file. For supported formats see here.\n\n  A response will be sent when the file has been uploaded but before\n  it has been processed. Use the returned upload ID to track progress by calling the [Get Upload](#get-upload) operation.\n    ","parameters":[],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/UploadDto"}},"application/json":{"schema":{"$ref":"#/components/schemas/UploadDto"}}}},"responses":{"200":{"description":"Data Upload response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Upload"}}}},"401":{"description":"Unauthorized"}},"tags":["Data Upload"],"security":[{"headerApiKey":[]},{"queryApiKey":[]}]},"get":{"operationId":"getManyBaseUploadControllerUpload","x-access":"read","summary":"Get Uploads","description":"\nRetrieve an array of Uploads.\nSpecify query parameters to:\n\n- Select fields to retrieve.\n- Filter retrieved Uploads by field values.\n- Sort retrieved Uploads by field values.\n- Join related resources.\n- Limit the number of Uploads retrieved.\n- Offset the Uploads retrieved.\n","parameters":[{"name":"fields","description":"Select resource fields","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true,"example":["id","description"]},{"name":"filter","description":"Filter by resource fields","required":false,"in":"query","schema":{"type":"object","additionalProperties":{"type":"string"}},"style":"deepObject","explode":true,"example":{"name":"~air"}},{"name":"sort","description":"Select sort by field","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true,"example":["-updatedAt"]},{"name":"join","description":"Join related resources","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true,"example":["application","database"]},{"name":"limit","description":"Limit number of resources","required":false,"in":"query","schema":{"type":"integer"},"example":10},{"name":"offset","description":"Offset resources","required":false,"in":"query","schema":{"type":"integer"},"example":0}],"responses":{"200":{"description":"Get Uploads response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Upload"}}}}},"401":{"description":"Unauthorized"}},"tags":["Data Upload"],"security":[{"headerApiKey":[]},{"queryApiKey":[]}]}},"/api/v1/uploads/{id}":{"get":{"operationId":"getOneBaseUploadControllerUpload","x-access":"read","summary":"Get Upload","description":"\nRetrieve the specified Upload. Specify query parameters to:\n\n- Select fields to retrieve.\n- Join related resources.\n","parameters":[{"name":"id","required":true,"in":"path","description":"Upload ID","example":"upload-id","schema":{"type":"string"}},{"name":"fields","description":"Select resource fields","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false},{"name":"join","description":"Join related resources","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true}],"responses":{"200":{"description":"Get Upload response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Upload"}}}},"401":{"description":"Unauthorized"},"404":{"description":"Resource not found"}},"tags":["Data Upload"],"security":[{"headerApiKey":[]},{"queryApiKey":[]}]}},"/api/v1/auth/users/me":{"get":{"operationId":"UserController_currentUser","x-access":"execute","summary":"Get current User","description":"Returns the User associated with the supplied Authorization bearer token.","parameters":[{"name":"Authentication","in":"header","description":"Authorization bearer token","required":true,"schema":{"type":"string","example":"Bearer <jwt token>"}}],"responses":{"200":{"description":"Current User response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}}},"401":{"description":"Unauthorized"}},"tags":["Users"],"security":[{"headerApiKey":[]},{"queryApiKey":[]}]}},"/api/v1/auth/users/{id}":{"get":{"operationId":"getOneBaseUserControllerUser","x-access":"read","summary":"Get User","description":"\nRetrieve the specified User. Specify query parameters to:\n\n- Select fields to retrieve.\n- Join related resources.\n","parameters":[{"name":"id","required":true,"in":"path","description":"User ID","example":"user-id","schema":{"type":"string"}},{"name":"fields","description":"Select resource fields","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false},{"name":"join","description":"Join related resources","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true}],"responses":{"200":{"description":"Get User response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}}},"401":{"description":"Unauthorized"},"404":{"description":"Resource not found"}},"tags":["Users"],"security":[{"headerApiKey":[]},{"queryApiKey":[]}]},"put":{"operationId":"replaceOneBaseUserControllerUser","x-access":"write","summary":"Update User","description":"Update the specified User using the body of the request. Partial updates are supported.\n\nNote that `id`, `applicationId`, 'createdAt' and 'updatedAt' are set automatically and will be overwritten if supplied.\n    ","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}}},"responses":{"200":{"description":"Update User response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}}},"401":{"description":"Unauthorized"},"404":{"description":"Resource not found"}},"tags":["Users"],"security":[{"headerApiKey":[]},{"queryApiKey":[]}]},"delete":{"operationId":"deleteOneBaseUserControllerUser","x-access":"write","summary":"Delete User","description":"Delete the specified User.","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"Delete User response"},"401":{"description":"Unauthorized"},"404":{"description":"Resource not found"}},"tags":["Users"],"security":[{"headerApiKey":[]},{"queryApiKey":[]}]}},"/api/v1/auth/users":{"get":{"operationId":"getManyBaseUserControllerUser","x-access":"read","summary":"Get Users","description":"\nRetrieve an array of Users.\nSpecify query parameters to:\n\n- Select fields to retrieve.\n- Filter retrieved Users by field values.\n- Sort retrieved Users by field values.\n- Join related resources.\n- Limit the number of Users retrieved.\n- Offset the Users retrieved.\n","parameters":[{"name":"fields","description":"Select resource fields","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true,"example":["id","description"]},{"name":"filter","description":"Filter by resource fields","required":false,"in":"query","schema":{"type":"object","additionalProperties":{"type":"string"}},"style":"deepObject","explode":true,"example":{"name":"~air"}},{"name":"sort","description":"Select sort by field","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true,"example":["-updatedAt"]},{"name":"join","description":"Join related resources","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true,"example":["application","database"]},{"name":"limit","description":"Limit number of resources","required":false,"in":"query","schema":{"type":"integer"},"example":10},{"name":"offset","description":"Offset resources","required":false,"in":"query","schema":{"type":"integer"},"example":0}],"responses":{"200":{"description":"Get Users response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/User"}}}}},"401":{"description":"Unauthorized"}},"tags":["Users"],"security":[{"headerApiKey":[]},{"queryApiKey":[]}]},"post":{"operationId":"createOneBaseUserControllerUser","x-access":"write","summary":"Create User","description":"Create a new User.\n\nNote that `applicationId`, 'createdAt' and 'updatedAt' are set automatically and will be overwritten if supplied.\n","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}}},"responses":{"201":{"description":"Create User response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}}},"401":{"description":"Unauthorized"}},"tags":["Users"],"security":[{"headerApiKey":[]},{"queryApiKey":[]}]}},"/api/v1/auth/users/{id}/metadata":{"get":{"operationId":"UserController_getMetadata","summary":"Get metadata","description":"Get the complete metadata object for a resource.","parameters":[{"name":"id","required":true,"in":"path","description":"Resource ID","schema":{"type":"string"}}],"responses":{"200":{"description":"Metadata response","content":{"application/json":{"schema":{"type":"object","example":{"key1":{},"key2":{}}}}}}},"tags":["Users"],"security":[{"headerApiKey":[]},{"queryApiKey":[]},{"headerApiKey":[]},{"queryApiKey":[]}]},"put":{"operationId":"UserController_updateMetadata","summary":"Update metadata","description":"Update metadata object for a resource. Supplied object is merged with existing metadata.","parameters":[{"name":"id","required":true,"in":"path","description":"Resource ID","schema":{"type":"string"}}],"responses":{"200":{"description":"Metadata response","content":{"application/json":{"schema":{"type":"object","example":{"key1":{},"key2":{}}}}}}},"tags":["Users"],"security":[{"headerApiKey":[]},{"queryApiKey":[]},{"headerApiKey":[]},{"queryApiKey":[]}]}},"/api/v1/auth/users/{id}/metadata/{key}":{"get":{"operationId":"UserController_getMetadataKey","summary":"Get metadata by key","description":"Get resource metadata by key.","parameters":[{"name":"id","required":true,"in":"path","description":"Resource ID","schema":{"type":"string"}},{"name":"key","required":true,"in":"path","description":"Metadata key","schema":{"type":"string"}}],"responses":{"200":{"description":"Metadata by key response","content":{"application/json":{"schema":{"type":"object","example":{"prop1":{},"prop2":{}}}}}}},"tags":["Users"],"security":[{"headerApiKey":[]},{"queryApiKey":[]},{"headerApiKey":[]},{"queryApiKey":[]}]},"put":{"operationId":"UserController_setMetadataKey","summary":"Set metadata by key","description":"Set resource metadata by key.","parameters":[{"name":"id","required":true,"in":"path","description":"Resource ID","schema":{"type":"string"}},{"name":"key","required":true,"in":"path","description":"Metadata key","schema":{"type":"string"}}],"requestBody":{"required":true,"description":"Metadata value","content":{"application/json":{"schema":{"type":"object"}}}},"responses":{"200":{"description":"Metadata response","content":{"application/json":{"schema":{"type":"object","example":{"key1":{},"key2":{}}}}}}},"tags":["Users"],"security":[{"headerApiKey":[]},{"queryApiKey":[]},{"headerApiKey":[]},{"queryApiKey":[]}]},"delete":{"operationId":"UserController_deleteMetadataKey","summary":"Delete metadata by key","description":"Delete resource metadata by key.","parameters":[{"name":"id","required":true,"in":"path","description":"Resource ID","schema":{"type":"string"}},{"name":"key","required":true,"in":"path","description":"Metadata key","schema":{"type":"string"}}],"responses":{"200":{"description":"Resource metadata response","content":{"application/json":{"schema":{"type":"object","example":{"key1":{},"key2":{}}}}}}},"tags":["Users"],"security":[{"headerApiKey":[]},{"queryApiKey":[]},{"headerApiKey":[]},{"queryApiKey":[]}]}},"/api/v1/auth/rabbitmq/user":{"post":{"operationId":"RabbitMQAuthController_authUser","parameters":[],"responses":{"201":{"description":""}}}},"/api/v1/auth/rabbitmq/vhost":{"post":{"operationId":"RabbitMQAuthController_authVhost","parameters":[],"responses":{"201":{"description":""}}}},"/api/v1/auth/rabbitmq/resource":{"post":{"operationId":"RabbitMQAuthController_authResource","parameters":[],"responses":{"201":{"description":""}}}},"/api/v1/auth/rabbitmq/topic":{"post":{"operationId":"RabbitMQAuthController_authTopic","parameters":[],"responses":{"201":{"description":""}}}}},"info":{"title":"Flo.w REST API","description":"\n\nFlo.w Engine exposes its services through a REST API. Standard CRUD (create/read/update/delete) operations\nare provided for the following resources:\n\n- [API Keys](#api-keys)\n- [Applications](#applications)\n- [Application Configuration](#application-configuration)\n- [Datasets](#datasets)\n- [Databases](#databases)\n- [Map Styles](#map-styles)\n- [Map Tile Sources](#map-tile-sources)\n- [Users](#users)\n\nAdditional operations are provided for:\n\n- [Querying Datasets](#query-dataset-simple)\n- [User-based authentication](#authentication)\n- [Server configuration](#server-configuration)\n- [Server health-check](#healthcheck)\n\nMap Server [endpoints](#map-endpoints) are also provided for use by map visualizations:\n\n- Base map styles\n- Map tiles\n- Map fonts\n- Map sprites\n","version":"v2.2.5","contact":{}},"tags":[{"name":"Server Configuration","description":"\nUse the Flo.w Engine configuration endpoint to retrieve global server configuration and version\ninformation.\n"},{"name":"Healthcheck","description":"\nUse the Healthcheck endpoint to check Flo.w Engine server health.\n"},{"name":"API Keys","description":"\nAPI keys provide authenticated access to the Flo.w Engine REST API and must be supplied with most REST\nrequests. See [Authenticating REST Requests](#authenticating-rest-requests) for details of how to specify\nan API key when making a request.\n\n::: warning API keys are immutable\nAPI keys cannot be modified once created. A new API key must be generated to modify access permissions.\n:::\n\nAPI keys provide different levels of access depending on their `type` property:\n\n- `master` keys: Can access resources owned by any Flo.w application. Master keys are generally only\navailable to system administrators and are used to create, modify and delete Flo.w applications.\n- `app` keys: Can access resources owned by a single Flo.w application. App keys are used by Flo.w application\ndevelopers and systems that integrate with Flo.w Engine (for example, front-end web applications).\n- `user` keys: Can access resources owned by a specified Flo.w user (not currently used).\n\nIn addition to the broad levels of access described above, each API key also specifies an access control list (ACL)\nin its `permissions` property that provides finer grained access to classes of resources and the type of access granted\n(read, write and/or execute).\n\nAccess can be granted to the following resource classes:\n\n- `auth`: Authentication operations (log in, log out, change password etc.)\n- `apikeys`: [API key](#api-keys) CRUD operations.\n- `appconfig`: [Application Config](#application-configuration) CRUD operations.\n- `applications`: [Application](#applications) CRUD operations.\n- `users`: [User](#users) CRUD operations.\n- `databases`: [Database](#databases) CRUD operations.\n- `datasets`: [Dataset](#datasets) CRUD and query operations.\n- `uploads`: [Data Upload](#data-upload) CRUD and data ingest operations.\n- `tiles`: [Tile Source](#map-tile-sources) CRUD and Map Server operations.\n- `styles`: [Map Style](#map-styles) CRUD and Map Server operations.\n\nAccess levels:\n- `read`: CRUD get and getMany operations.\n- `write`: CRUD create, update and delete operations.\n- `execute`: Resource-specific 'extra' operations. For example, dataset querying or authentication operations.\n"},{"name":"Applications","description":"\nAn Application is a logical container for other Flo.w Engine resources and provides multi-tenancy capability.\nA separate Application is generally created for each front-end web visualization.\n\nREST requests are restricted to accessing resources 'owned' by the Application associated with the supplied API key.\nOnly master API keys can access any resource and create, modify or delete Applications.\n"},{"name":"Application Configuration","description":"\nUse Application Configuration to store arbitrary application-specific configuration JSON.\nThe configuration can be retrieved or modified by front-end applications using the operations below.\n\n::: tip\nTo prevent modification of the configuration from a front-end application, supply an API key that only has `execute`\naccess for the `appconfig` resource type and use the [Get Current AppConfig](#get-current-appconfig) endpoint.\n:::\n"},{"name":"Data Upload","description":"\nData upload operations provide the ability to upload geospatial data and monitor upload progress.\n\nUploading data creates a new [Dataset](#datasets) and associated TileSource for serving the data as vector map tiles.\n"},{"name":"Datasets","description":"\nDatasets are abstractions of geospatial and non-geospatial data that can be queried or exposed as vector map tiles.\nA dataset is typically stored as a Postgres/PostGIS database table but drivers are provided for alternative\nbacking storage.\n\nDatasets can be created directly using the [Create Dataset](#create-dataset) operation or by uploading data using the\n[Upload File](#upload-file) operation.\n\nDataset types:\n\n- `table`: A table-backed Dataset. `source` is set to a database table name.\n- `sql`: A SQL-backed Dataset analogous to a database view. `source` is set to a SQL query.\n- `rest`: A Dataset backed by a third-party REST request. `source` is set to a URL.\n- `lambda`: A Dataset backed by an AWS Lambda function. `source` is set to an AWS Lambda ARN.\n\nDatasets can be queried using a simplified syntax (GET request) or a rich syntax (POST request) that\nsupports complex filtering, grouping and ordering operations. Query output can be formatted as JSON, GeoJSON or CSV.\n"},{"name":"Databases","description":"\nA Database resource specifies a driver and connection details for connecting to an external database.\nDatabases are associated with [Datasets](#datasets) to specify how and where the underlying data for the [Dataset](#datasets) is stored.\n\nEach Flo.w [Application](#applications) will typically contain a single Database, which provides connection details to an\napplication-specific physical database. However, an [Application](#applications) can also be associated with multiple databases.\nIn this case, each [Dataset](#datasets) may specify which Database to use for backing storage -\nthe `default` Database will be used if not specified.\n"},{"name":"Map Styles","description":"\nA Map Style is used by the Map Server to provide base maps for visualizations.\n\nDuring creation of a new [Application](#applications), a copy of one of the standard base map styles will typically be made:\n\n- 'positron': a simple light base map showing place names and transport.\n- 'darkmatter': a simple dark base map showing place names and transport.\n- 'fjord': a simple blue base map showing place names and transport.\n- 'osm-bright': a detailed base map showing land use and points of interest.\n\nSupport is provided for alternative style formats. Currently, a single format is supported:\n\n- `plain`: the `style` property contains a [MapboxGL style specification](https://docs.mapbox.com/mapbox-gl-js/style-spec/).\n"},{"name":"Map Tile Sources","description":"\nMap Tile Sources are used by the Map Server and specify available vector map tiles.\n\nTwo types of Tile Source are supported:\n\n- 'dataset': Tile data is provided from a Flo.w [Dataset](#datasets). The `source` property specifies the Dataset ID.\n- 'tilelive': Tile data is provided from a [TileLive](https://github.com/mapbox/tilelive) source. The `source` property specifies the TileLive URI. This type\nof Tile Source is typically used to expose [mbtiles](https://docs.mapbox.com/help/glossary/mbtiles/) files as vector map tiles.\n"},{"name":"Users","description":"\nThe User resource together with [Authentication](#authentication) endpoints provide user management\nand authentication services required by many front-end applications.\n\nNote that the primary mechanism for authentication with Flo.w Engine is by API key. The use of Users and the Authentication\nendpoints is optional and provided as a service to applications if user-based authentication is required.\n"},{"name":"Authentication","description":"\nAuthentication endpoints together with the [User](#users) resource provide user management\nand authentication services required by many front-end applications.\n\nNote that the primary mechanism for authentication with Flo.w Engine is by API key. The use of Users and the Authentication\nendpoints is optional and provided as a service to applications if user-based authentication is required.\n"},{"name":"Map Endpoints","description":"\n::: warning\nMap endpoints are designed to be consumed by a front-end map visualization and are not designed to be called directly from\na front-end application or service.\n:::\n\nMap Server endpoints provide:\n\n- Base map styles\n- Vector map tiles\n- Map fonts\n- Map sprites\n"}],"servers":[{"url":"https://flow.emu-analytics.net","description":"Flo.w Production Server"},{"url":"http://localhost:3000","description":"Localhost Server on port 3000"}],"components":{"securitySchemes":{"headerApiKey":{"type":"apiKey","in":"header","name":"x-flow-api-key","description":"Specify a Flo.w API key as a request header."},"queryApiKey":{"type":"apiKey","in":"query","name":"api-key","description":"Specify a Flo.w API key as a query parameter."}},"schemas":{"Database":{"type":"object","properties":{"createdAt":{"format":"date-time","type":"string","readOnly":true,"description":"Creation timestamp"},"updatedAt":{"format":"date-time","type":"string","readOnly":true,"description":"Last update timestamp"},"metadata":{"type":"object","description":"Resource metadata"},"id":{"type":"string","description":"Resource ID"},"type":{"type":"string","description":"Database type"},"name":{"type":"string","description":"Database name"},"description":{"type":"string","description":"Database description"},"host":{"type":"string","description":"Database connection: host address"},"port":{"type":"number","description":"Database connection: port number"},"user":{"type":"string","description":"Database connection: user"},"password":{"type":"string","writeOnly":true,"description":"Database connection: password"},"db":{"type":"string","description":"Database connection: database name"},"default":{"type":"boolean","description":"Default Database for Application"},"application":{"readOnly":true,"description":"Related Application resource (specify `join` to load)","allOf":[{"$ref":"#/components/schemas/Application"}]},"applicationId":{"type":"string","readOnly":true,"description":"Related Application ID"}},"required":["createdAt","updatedAt","metadata","id","type","name","description","host","port","user","password","db","default","applicationId"]},"Application":{"type":"object","properties":{"createdAt":{"format":"date-time","type":"string","readOnly":true,"description":"Creation timestamp"},"updatedAt":{"format":"date-time","type":"string","readOnly":true,"description":"Last update timestamp"},"metadata":{"type":"object","description":"Resource metadata"},"id":{"type":"string","description":"Resource ID"},"name":{"type":"string","description":"Application name"},"description":{"type":"string","description":"Application description"},"contact":{"type":"string","description":"Contact email"},"databases":{"readOnly":true,"description":"Related Database resources (specify `join` to load)","type":"array","items":{"$ref":"#/components/schemas/Database"}}},"required":["createdAt","updatedAt","metadata","id","name","description","contact"]},"User":{"type":"object","properties":{"createdAt":{"format":"date-time","type":"string","readOnly":true,"description":"Creation timestamp"},"updatedAt":{"format":"date-time","type":"string","readOnly":true,"description":"Last update timestamp"},"application":{"readOnly":true,"description":"Related Application (specify `join` to load)","allOf":[{"$ref":"#/components/schemas/Application"}]},"applicationId":{"type":"string","readOnly":true,"description":"Application ID"},"metadata":{"type":"object","description":"Resource metadata"},"id":{"type":"string","description":"Resource ID"},"email":{"type":"string","description":"User email address"},"firstName":{"type":"string","description":"User first name"},"lastName":{"type":"string","description":"User last name"},"password":{"type":"string","writeOnly":true,"description":"User password"},"roles":{"description":"Application-specific roles","type":"array","items":{"type":"string"}},"emailVerified":{"type":"boolean","description":"User email is verified"},"enabled":{"type":"boolean","description":"User is enabled"},"verificationToken":{"type":"string","readOnly":true,"description":"User email verification token"},"passwordResetToken":{"type":"string","readOnly":true,"description":"User password reset token"}},"required":["createdAt","updatedAt","applicationId","metadata","id","email","firstName","lastName","password","roles","emailVerified","enabled","verificationToken","passwordResetToken"]},"ApiKey":{"type":"object","properties":{"createdAt":{"format":"date-time","type":"string","readOnly":true,"description":"Creation timestamp"},"updatedAt":{"format":"date-time","type":"string","readOnly":true,"description":"Last update timestamp"},"application":{"readOnly":true,"description":"Related Application (specify `join` to load)","allOf":[{"$ref":"#/components/schemas/Application"}]},"applicationId":{"type":"string","readOnly":true,"description":"Application ID"},"metadata":{"type":"object","description":"Resource metadata"},"id":{"type":"string","description":"Resource ID"},"description":{"type":"string","description":"Description"},"type":{"type":"string","description":"API key type","enum":["master","app","user"]},"permissions":{"type":"object","description":"Permission ACLs"},"user":{"readOnly":true,"description":"Related User resource (user-type keys only)","allOf":[{"$ref":"#/components/schemas/User"}]},"userId":{"type":"number","description":"Related User ID (user-type keys only)"}},"required":["createdAt","updatedAt","applicationId","metadata","id","description","type","permissions"]},"LoginDto":{"type":"object","properties":{"email":{"type":"string","description":"User email address"},"password":{"type":"string","description":"Supplied password"},"applicationId":{"type":"string","description":"Application ID"}},"required":["email","password","applicationId"]},"AuthLoginResponse":{"type":"object","properties":{"accessToken":{"type":"string","description":"JWT bearer token"},"refreshToken":{"type":"string","description":"Opaque refresh token"}},"required":["accessToken","refreshToken"]},"ChangePasswordDto":{"type":"object","properties":{"password":{"type":"string","description":"Current password"},"newPassword":{"type":"string","description":"New password"}},"required":["password","newPassword"]},"SignupDto":{"type":"object","properties":{"firstName":{"type":"string","description":"User first name"},"lastName":{"type":"string","description":"User last name"},"email":{"type":"string","description":"User email address"},"password":{"type":"string","description":"User password"},"applicationId":{"type":"string","description":"Application ID"},"confirmUrl":{"type":"string","description":"Confirmation URL (supplied in confirmation email)"},"redirectUrl":{"type":"string","description":"Redirect URL (on successful confirmation)"}},"required":["firstName","lastName","email","password","applicationId","confirmUrl","redirectUrl"]},"RequestPasswordResetDto":{"type":"object","properties":{"email":{"type":"string","description":"User email address"},"applicationId":{"type":"string","description":"Application ID"},"redirectUrl":{"type":"string","description":"Redirect URL"}},"required":["email","applicationId","redirectUrl"]},"ResetPasswordDto":{"type":"object","properties":{"email":{"type":"string","description":"User email address"},"password":{"type":"string","description":"New password"},"applicationId":{"type":"string","description":"Application ID"},"token":{"type":"string","description":"Password reset token"}},"required":["email","password","applicationId","token"]},"ConfigDto":{"type":"object","properties":{"version":{"type":"object","description":"Server version","properties":{"tag":{"type":"string","description":"Version tag"},"hash":{"type":"string","description":"Build hash"},"timestamp":{"type":"number","description":"Build timestamp"}}}},"required":["version"]},"ContactPointSendRequestDto":{"type":"object","properties":{"template":{"type":"string","description":"Template to use for the notification. If not specified, the default template configured for the contact point will be used.","default":null},"subject":{"type":"string","description":"Subject to use for the notification. The subject can include template variables that will be populated with the data provided in the `data` field of the request body. If not specified, the default subject configured for the contact point will be used.","default":null},"recipients":{"description":"List of recipients for the notification. If not specified, the default recipients configured for the contact point will be used.","default":[],"type":"array","items":{"type":"string"}},"data":{"type":"object","description":"Data to apply to the notification template. This is used to populate template variables.","default":{}}}},"ContactPoint":{"type":"object","properties":{"createdAt":{"format":"date-time","type":"string","readOnly":true,"description":"Creation timestamp"},"updatedAt":{"format":"date-time","type":"string","readOnly":true,"description":"Last update timestamp"},"metadata":{"type":"object","description":"Resource metadata"},"applicationId":{"type":"string","readOnly":true,"description":"Related Application ID"},"id":{"type":"string","description":"Contact Point ID"},"application":{"readOnly":true,"description":"Related Application (specify `join` to load)","allOf":[{"$ref":"#/components/schemas/Application"}]},"type":{"type":"string","description":"Contact Point  type"},"description":{"type":"string","description":"Contact Point description"},"templates":{"description":"Notification templates","type":"array","items":{"type":"string"}},"recipients":{"description":"Contact Point recipients","type":"array","items":{"type":"string"}},"host":{"type":"string","description":"Contact Point connection: host address"},"port":{"type":"number","description":"Contact Point connection: port number"},"user":{"type":"string","description":"Contact Point connection: user"},"password":{"type":"string","writeOnly":true,"description":"Contact Point : password"}},"required":["createdAt","updatedAt","metadata","applicationId","id","type","description","templates","recipients","host","port","user","password"]},"AttributeDto":{"type":"object","properties":{"attribute":{"type":"string","description":"Attribute ID"},"type":{"type":"string","description":"Attribute type"},"dbType":{"type":"string","description":"Native database type"},"primaryKey":{"type":"boolean","description":"Attribute is primary key"},"default":{"type":"string","description":"Default value"},"nullable":{"type":"boolean","description":"Attribute can be null"},"description":{"type":"boolean","description":"Attribute description"},"isGeometry":{"type":"boolean","description":"Attribute is a geometry type"},"extent":{"type":"array","items":{"type":"number"},"maxItems":4,"minItems":4,"description":"Extent in original SRS","example":[-180,-90,180,90]},"extentLngLat":{"type":"array","items":{"type":"number"},"maxItems":4,"minItems":4,"description":"Extent in WSG84","example":[-180,-90,180,90]}},"required":["attribute","type","dbType","primaryKey","default","nullable","description"]},"Dataset":{"type":"object","properties":{"createdAt":{"format":"date-time","type":"string","readOnly":true,"description":"Creation timestamp"},"updatedAt":{"format":"date-time","type":"string","readOnly":true,"description":"Last update timestamp"},"metadata":{"type":"object","description":"Resource metadata"},"owner":{"readOnly":true,"description":"Related User (specify `join` to load)","allOf":[{"$ref":"#/components/schemas/User"}]},"ownerId":{"type":"string","description":"User ID"},"applicationId":{"type":"string","readOnly":true,"description":"Related Application ID"},"id":{"type":"string","description":"Dataset ID"},"application":{"readOnly":true,"description":"Related Application (specify `join` to load)","allOf":[{"$ref":"#/components/schemas/Application"}]},"type":{"type":"string","description":"Dataset type - table or SQL","enum":["table","sql"]},"source":{"type":"string","description":"Source table name or SQL"},"name":{"type":"string","description":"Dataset name"},"description":{"type":"string","description":"Dataset description"},"attributes":{"description":"Dataset attributes (autodetected)","readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/AttributeDto"}},"bytes":{"type":"number","description":"Dataset size (only applicable to `table` type)","readOnly":true},"databaseId":{"type":"string","description":"Database ID"},"database":{"readOnly":true,"description":"Related Database (specify `join` to load)","allOf":[{"$ref":"#/components/schemas/Database"}]}},"required":["createdAt","updatedAt","metadata","applicationId","id","type","source","name","description","databaseId"]},"SimpleQueryDto":{"type":"object","properties":{"format":{"type":"string","description":"Response format","enum":["json","geojson","csv"],"default":"json","example":"json"},"explain":{"type":"object","description":"Explain query","default":false},"attributes":{"description":"Select attributes to return","explode":true,"style":"form","type":"array","items":{"type":"string"}},"filter":{"type":"object","description":"Filter results","additionalProperties":true,"explode":true,"style":"deepObject"},"sort":{"description":"Sort by attributes","explode":true,"style":"form","type":"array","items":{"type":"string"}},"limit":{"type":"number","description":"Limit number of results","example":10},"offset":{"type":"number","description":"Offset results","example":0},"filename":{"type":"string","description":"Specify download file name\n\nAdds a `Content-Disposition: attachment; filename=\"<filename>\"` header to the response.\nThis hints that the response should be downloaded when the request is issued from a browser.\n  "}}},"SamplingOptionsDto":{"type":"object","properties":{"percentage":{"type":"number","description":"Sampling percentage"},"method":{"type":"string","description":"Sampling method"},"seed":{"type":"number","description":"Random seed"}},"required":["percentage"]},"AdvancedQueryBodyDto":{"type":"object","properties":{"attributes":{"description":"Select attributes to return","explode":true,"style":"form","type":"array","items":{"type":"string"}},"where":{"type":"object","description":"Filter results","additionalProperties":true,"explode":true,"style":"deepObject"},"order":{"description":"Sort by attributes","explode":true,"style":"form","type":"array","items":{"type":"string"}},"group":{"description":"Group by attributes","explode":true,"style":"form","type":"array","items":{"type":"string"}},"sample":{"description":"Table sampling options","allOf":[{"$ref":"#/components/schemas/SamplingOptionsDto"}]},"limit":{"type":"number","description":"Limit number of results"},"offset":{"type":"number","description":"Offset results"},"distinct":{"description":"Select DISTINCT ON attributes","explode":true,"style":"form","type":"array","items":{"type":"string"}}}},"JobSubmitDto":{"type":"object","properties":{"type":{"type":"string","description":"Job type"},"name":{"type":"string","description":"Job name"},"description":{"type":"string","description":"Job description"},"params":{"type":"object","description":"Job parameters","additionalProperties":true,"explode":true,"style":"deepObject"}},"required":["type","name","description","params"]},"Job":{"type":"object","properties":{"createdAt":{"format":"date-time","type":"string","readOnly":true,"description":"Creation timestamp"},"updatedAt":{"format":"date-time","type":"string","readOnly":true,"description":"Last update timestamp"},"application":{"readOnly":true,"description":"Related Application (specify `join` to load)","allOf":[{"$ref":"#/components/schemas/Application"}]},"applicationId":{"type":"string","readOnly":true,"description":"Application ID"},"metadata":{"type":"object","description":"Resource metadata"},"owner":{"readOnly":true,"description":"Related User (specify `join` to load)","allOf":[{"$ref":"#/components/schemas/User"}]},"ownerId":{"type":"string","description":"User ID"},"id":{"type":"string","description":"Resource ID"},"type":{"type":"string","description":"Job type identifier (application-specific)"},"name":{"type":"string","description":"Job name"},"description":{"type":"string","description":"Job description"},"params":{"type":"object","description":"Job parameters"},"status":{"type":"string","description":"Job status"},"error":{"type":"object","description":"Job error information"},"progress":{"type":"number","description":"Job progress (0-1)"},"progressText":{"type":"string","description":"Progress display text (e.g. processing stage)"},"datasetId":{"type":"string","description":"Associated results dataset"}},"required":["createdAt","updatedAt","applicationId","metadata","id","type","name","description","params","status","progress"]},"JobStatusDto":{"type":"object","properties":{"status":{"type":"string","description":"Job status"},"progress":{"type":"number","description":"Job progress (0-1)"},"progressText":{"type":"string","description":"Job progress text"},"error":{"type":"object","description":"Job error information"}},"required":["status","progress","progressText","error"]},"JobRequestDto":{"type":"object","properties":{"type":{"type":"string","description":"Job type"}},"required":["type"]},"CreateManyJobDto":{"type":"object","properties":{"bulk":{"type":"array","items":{"$ref":"#/components/schemas/Job"}}},"required":["bulk"]},"MapLayer":{"type":"object","properties":{"createdAt":{"format":"date-time","type":"string","readOnly":true,"description":"Creation timestamp"},"updatedAt":{"format":"date-time","type":"string","readOnly":true,"description":"Last update timestamp"},"metadata":{"type":"object","description":"Resource metadata"},"owner":{"readOnly":true,"description":"Related User (specify `join` to load)","allOf":[{"$ref":"#/components/schemas/User"}]},"ownerId":{"type":"string","description":"User ID"},"applicationId":{"type":"string","readOnly":true,"description":"Related Application ID"},"id":{"type":"string","description":"Map layer ID"},"application":{"readOnly":true,"description":"Related Application (specify `join` to load)","allOf":[{"$ref":"#/components/schemas/Application"}]},"name":{"type":"string","description":"Map layer name"},"description":{"type":"string","description":"Map layer description"},"type":{"type":"string","description":"App-specific map layer type"},"group":{"type":"string","description":"App-specific map layer group"},"layerSpec":{"type":"object","description":"Application configuration"}},"required":["createdAt","updatedAt","metadata","applicationId","id","name","description","type","group","layerSpec"]},"MediaUploadDto":{"type":"object","properties":{"file":{"type":"file","description":"The file to upload","properties":{"file":{"description":"Binary data","type":"string","format":"binary"}}},"id":{"type":"string","description":"Media ID"},"type":{"type":"string","description":"Media type"},"mimeType":{"type":"string","description":"Media MIME type - determined automatically if not provided"},"metadata":{"type":"object","description":"Metadata to associate with media (JSON)","default":"{}"}},"required":["file"]},"Buffer":{"type":"object","properties":{}},"Media":{"type":"object","properties":{"createdAt":{"format":"date-time","type":"string","readOnly":true,"description":"Creation timestamp"},"updatedAt":{"format":"date-time","type":"string","readOnly":true,"description":"Last update timestamp"},"metadata":{"type":"object","description":"Resource metadata"},"applicationId":{"type":"string","readOnly":true,"description":"Related Application ID"},"id":{"type":"string","description":"Media ID"},"application":{"readOnly":true,"description":"Related Application (specify `join` to load)","allOf":[{"$ref":"#/components/schemas/Application"}]},"fileName":{"type":"string","description":"Original file name of content"},"type":{"type":"string","description":"Media type"},"mimeType":{"type":"string","description":"MIME type"},"content":{"description":"Media binary content","allOf":[{"$ref":"#/components/schemas/Buffer"}]}},"required":["createdAt","updatedAt","metadata","applicationId","id","fileName","type","mimeType","content"]},"Pipeline":{"type":"object","properties":{"createdAt":{"format":"date-time","type":"string","readOnly":true,"description":"Creation timestamp"},"updatedAt":{"format":"date-time","type":"string","readOnly":true,"description":"Last update timestamp"},"metadata":{"type":"object","description":"Resource metadata"},"applicationId":{"type":"string","description":"Related Application ID"},"id":{"type":"string","description":"Resource ID"},"environment":{"type":"string","description":"Environment"},"description":{"type":"string","description":"Style description"},"config":{"type":"object","description":"Pipeline configuration"},"startedAt":{"format":"date-time","type":"string","description":"Pipeline start timestamp"},"heartbeatAt":{"format":"date-time","type":"string","description":"Last heartbeat received timestamp"},"application":{"readOnly":true,"description":"Related Application resource (specify `join` to load)","allOf":[{"$ref":"#/components/schemas/Application"}]},"components":{"readOnly":true,"description":"Related Pipeline Component resources (specify `join` to load)","type":"array","items":{"$ref":"#/components/schemas/PipelineComponent"}}},"required":["createdAt","updatedAt","metadata","applicationId","id","environment","description","config","startedAt","heartbeatAt"]},"PipelineMetric":{"type":"object","properties":{"createdAt":{"format":"date-time","type":"string","readOnly":true,"description":"Creation timestamp"},"updatedAt":{"format":"date-time","type":"string","readOnly":true,"description":"Last update timestamp"},"id":{"type":"string","description":"Unique metric ID"},"applicationId":{"type":"string","description":"Related Application ID"},"pipelineId":{"type":"string","description":"Parent Pipeline ID"},"componentId":{"type":"string","description":"Pipeline Component ID"},"name":{"type":"string","description":"Metric name"},"type":{"type":"string","description":"Metric type"},"timestamp":{"format":"date-time","type":"string","description":"Metric timestamp"},"value":{"type":"string","description":"Metric value"},"labels":{"type":"object","description":"Extra metrics labels"},"pipelineComponent":{"readOnly":true,"description":"Parent pipeline component resource (specify `join` to load)","allOf":[{"$ref":"#/components/schemas/PipelineComponent"}]}},"required":["createdAt","updatedAt","id","applicationId","pipelineId","componentId","name","type","timestamp","value","labels"]},"PipelineComponent":{"type":"object","properties":{"createdAt":{"format":"date-time","type":"string","readOnly":true,"description":"Creation timestamp"},"updatedAt":{"format":"date-time","type":"string","readOnly":true,"description":"Last update timestamp"},"metadata":{"type":"object","description":"Resource metadata"},"applicationId":{"type":"string","description":"Related Application ID"},"pipelineId":{"type":"string","description":"Parent Pipeline ID"},"id":{"type":"string","description":"Pipeline Component ID"},"class":{"type":"string","description":"Pipeline Component class (e.g. source, sink, cache"},"type":{"type":"string","description":"Pipeline Component type (e.g. SQSReadableSource, StrategyCache"},"description":{"type":"string","description":"Pipeline Component description"},"config":{"type":"object","description":"Pipeline component configuration"},"index":{"type":"number","description":"Index of component in pipeline"},"pipeline":{"readOnly":true,"description":"Parent Pipeline resource (specify `join` to load)","allOf":[{"$ref":"#/components/schemas/Pipeline"}]},"metrics":{"readOnly":true,"description":"Related Pipeline Metric resources (specify `join` to load)","type":"array","items":{"$ref":"#/components/schemas/PipelineMetric"}}},"required":["createdAt","updatedAt","metadata","applicationId","pipelineId","id","class","type","description","config","index"]},"Style":{"type":"object","properties":{"createdAt":{"format":"date-time","type":"string","readOnly":true,"description":"Creation timestamp"},"updatedAt":{"format":"date-time","type":"string","readOnly":true,"description":"Last update timestamp"},"metadata":{"type":"object","description":"Resource metadata"},"applicationId":{"type":"string","description":"Related Application ID"},"id":{"type":"string","description":"Resource ID"},"application":{"readOnly":true,"description":"Related Application resource (specify `join` to load)","allOf":[{"$ref":"#/components/schemas/Application"}]},"name":{"type":"string","description":"Style name"},"description":{"type":"string","description":"Style description"},"type":{"type":"string","description":"Style type. Currently only `plain` (MapboxGL style specification) is supported)","enum":["plain"]},"style":{"type":"object","description":"Style JSON definition"}},"required":["createdAt","updatedAt","metadata","applicationId","id","name","description","type","style"]},"TileSource":{"type":"object","properties":{"createdAt":{"format":"date-time","type":"string","readOnly":true,"description":"Creation timestamp"},"updatedAt":{"format":"date-time","type":"string","readOnly":true,"description":"Last update timestamp"},"metadata":{"type":"object","description":"Resource metadata"},"applicationId":{"type":"string","readOnly":true,"description":"Related Application ID"},"id":{"type":"string","description":"Resource ID"},"application":{"readOnly":false,"description":"Related Application resource (specify `join` to load)","allOf":[{"$ref":"#/components/schemas/Application"}]},"type":{"type":"string","description":"Tile source type"},"source":{"type":"string","description":"Data source"},"attribution":{"type":"string","description":"Tile source attribution text"},"minZoom":{"type":"number","description":"Minimum zoom level"},"maxZoom":{"type":"number","description":"Maximum zoom level"},"extentLngLat":{"description":"Override tile source extent","minItems":4,"maxItems":4,"type":"array","items":{"type":"number"}},"headers":{"type":"object","description":"Tile source response headers"}},"required":["createdAt","updatedAt","metadata","applicationId","id","type","source","attribution","minZoom","maxZoom","extentLngLat","headers"]},"UploadDto":{"type":"object","properties":{"file":{"type":"file","description":"The file to upload","properties":{"file":{"description":"Binary data","type":"string","format":"binary"}}},"filePath":{"type":"string","description":"File path - required if file not uploaded with request"},"datasetId":{"type":"string","description":"Dataset ID"},"name":{"type":"string","description":"Dataset name"},"description":{"type":"string","description":"Dataset description"},"attribution":{"type":"string","description":"Tile source attribution text"},"sourceSrid":{"type":"number","description":"Source SRS ID"},"targetSrid":{"type":"number","description":"Target SRS ID"},"schema":{"type":"string","description":"Database schema"},"metadata":{"type":"object","description":"Metadata to associate with dataset","default":"{}"}},"required":["file"]},"Upload":{"type":"object","properties":{"createdAt":{"format":"date-time","type":"string","readOnly":true,"description":"Creation timestamp"},"updatedAt":{"format":"date-time","type":"string","readOnly":true,"description":"Last update timestamp"},"application":{"readOnly":true,"description":"Related Application (specify `join` to load)","allOf":[{"$ref":"#/components/schemas/Application"}]},"applicationId":{"type":"string","readOnly":true,"description":"Application ID"},"owner":{"readOnly":true,"description":"Related User (specify `join` to load)","allOf":[{"$ref":"#/components/schemas/User"}]},"ownerId":{"type":"string","description":"User ID"},"id":{"type":"string","description":"Resource ID"},"fileName":{"type":"string","description":"Upload original filename"},"path":{"type":"string","description":"Temporary upload path"},"options":{"type":"object","description":"Upload options"},"status":{"type":"string","readOnly":true,"description":"Upload status"},"error":{"type":"object","readOnly":true,"description":"Upload error information"},"size":{"type":"number","readOnly":true,"description":"Upload size in bytes"}},"required":["createdAt","updatedAt","applicationId","id","fileName","path","options","status","error","size"]}}}}