@robinmordasiewicz/f5xc-terraform-mcp 2.3.0 → 2.4.3

package/dist/docs/specifications/api/docs-cloud-f5-com.0254.public.ves.io.schema.user.setting.ves-swagger.json

@@ -0,0 +1 @@
+{"openapi":"3.0.0","info":{"title":"F5 Distributed Cloud Services API for ves.io.schema.user.setting","description":"Custom API of user settings.","version":""},"paths":{"/api/web/namespaces/system/user/admin_notifications":{"get":{"summary":"Get admin ntfn preferences","description":"Get admin ntfn preferences gets current admin notification preferences for user.\nIt combines information from two sources:\n- explicitly set admin notification preferences in user settings object\n- default values from uam config (for those notifications which not explicitly set)","operationId":"ves.io.schema.user.setting.CustomAPI.GetAdminNtfnPreferences","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/settingNotificationList"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-user-setting-customapi-getadminntfnpreferences"},"x-ves-proto-rpc":"ves.io.schema.user.setting.CustomAPI.GetAdminNtfnPreferences"},"put":{"summary":"Update admin ntfn preferences","description":"Update admin ntfn preferences updates admin notification preferences for the user and store them in user settings object.","operationId":"ves.io.schema.user.setting.CustomAPI.UpdateAdminNtfnPreferences","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/usersettingEmpty"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"requestBody":{"$ref":"#/components/requestBodies/settingNtfnPreferencesMap"},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-user-setting-customapi-updateadminntfnpreferences"},"x-ves-proto-rpc":"ves.io.schema.user.setting.CustomAPI.UpdateAdminNtfnPreferences"},"x-displayname":"User Settings Custom API","x-ves-proto-service":"ves.io.schema.user.setting.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/web/namespaces/system/user/admin_notifications/unset":{"put":{"summary":"Unset admin ntfn preference","description":"Unset admin ntfn preference unsets specific admin notification preference for the user and store it in user settings object.\nIt can be used in email newsletters to allow easy unsubscribing for users.","operationId":"ves.io.schema.user.setting.CustomAPI.UnsetAdminNtfnPreference","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/usersettingEmpty"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"requestBody":{"$ref":"#/components/requestBodies/settingNtfnToUnset"},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-user-setting-customapi-unsetadminntfnpreference"},"x-ves-proto-rpc":"ves.io.schema.user.setting.CustomAPI.UnsetAdminNtfnPreference"},"x-displayname":"User Settings Custom API","x-ves-proto-service":"ves.io.schema.user.setting.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/web/namespaces/system/user/combined_notifications":{"get":{"summary":"Get combined ntfn preferences","description":"Get combined ntfn preferences gets user-ntfn-preferences and admin-ntfn-preferences and returns combined result.","operationId":"ves.io.schema.user.setting.CustomAPI.GetCombinedNtfnPreferences","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/settingNotificationList"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-user-setting-customapi-getcombinedntfnpreferences"},"x-ves-proto-rpc":"ves.io.schema.user.setting.CustomAPI.GetCombinedNtfnPreferences"},"put":{"summary":"Update combined ntfn preferences","description":"Update combined ntfn preferences updates both user-ntfn-preferences and admin-ntfn-preferences.","operationId":"ves.io.schema.user.setting.CustomAPI.UpdateCombinedNtfnPreferences","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/usersettingEmpty"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"requestBody":{"$ref":"#/components/requestBodies/settingNtfnPreferencesMap"},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-user-setting-customapi-updatecombinedntfnpreferences"},"x-ves-proto-rpc":"ves.io.schema.user.setting.CustomAPI.UpdateCombinedNtfnPreferences"},"x-displayname":"User Settings Custom API","x-ves-proto-service":"ves.io.schema.user.setting.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/web/namespaces/system/user/notifications":{"get":{"summary":"Get ntfn preferences","description":"Get ntfn preferences gets current notification preferences for user.\nIt combines information from two sources:\n- explicitly set notification preferences in user settings object\n- default values from uam config (for those notifications which not explicitly set)","operationId":"ves.io.schema.user.setting.CustomAPI.GetNtfnPreferences","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/settingNotificationList"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-user-setting-customapi-getntfnpreferences"},"x-ves-proto-rpc":"ves.io.schema.user.setting.CustomAPI.GetNtfnPreferences"},"put":{"summary":"Update ntfn preferences","description":"Update ntfn preferences updates notification preferences for the user and store them in user settings object.","operationId":"ves.io.schema.user.setting.CustomAPI.UpdateNtfnPreferences","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/usersettingEmpty"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"requestBody":{"$ref":"#/components/requestBodies/settingNtfnPreferencesMap"},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-user-setting-customapi-updatentfnpreferences"},"x-ves-proto-rpc":"ves.io.schema.user.setting.CustomAPI.UpdateNtfnPreferences"},"x-displayname":"User Settings Custom API","x-ves-proto-service":"ves.io.schema.user.setting.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/web/namespaces/system/user/notifications/unset":{"put":{"summary":"Unset ntfn preference","description":"Unset ntfn preference unsets specific notification preference for the user and store it in user settings object.\nIt can be used in email newsletters to allow easy unsubscribing for users.","operationId":"ves.io.schema.user.setting.CustomAPI.UnsetNtfnPreference","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/usersettingEmpty"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"requestBody":{"$ref":"#/components/requestBodies/settingNtfnToUnset"},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-user-setting-customapi-unsetntfnpreference"},"x-ves-proto-rpc":"ves.io.schema.user.setting.CustomAPI.UnsetNtfnPreference"},"x-displayname":"User Settings Custom API","x-ves-proto-service":"ves.io.schema.user.setting.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/web/namespaces/system/user/otp/admin_reset":{"put":{"summary":"ResetOtpDeviceByAdmin","description":"TODO(evg): description","operationId":"ves.io.schema.user.setting.CustomAPI.ResetOtpDeviceByAdmin","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/usersettingEmpty"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"requestBody":{"$ref":"#/components/requestBodies/settingUserEmail"},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-user-setting-customapi-resetotpdevicebyadmin"},"x-ves-proto-rpc":"ves.io.schema.user.setting.CustomAPI.ResetOtpDeviceByAdmin"},"x-displayname":"User Settings Custom API","x-ves-proto-service":"ves.io.schema.user.setting.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/web/namespaces/system/user/sessions":{"get":{"summary":"GetUserSessions","description":"GetUserSessions returns a list of user sessions.","operationId":"ves.io.schema.user.setting.CustomAPI.GetUserSessions","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/settingUserSessionList"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-user-setting-customapi-getusersessions"},"x-ves-proto-rpc":"ves.io.schema.user.setting.CustomAPI.GetUserSessions"},"x-displayname":"User Settings Custom API","x-ves-proto-service":"ves.io.schema.user.setting.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/web/namespaces/system/user/settings":{"get":{"summary":"Get","description":"Retrieves current user settings object defined to the user.","operationId":"ves.io.schema.user.setting.CustomAPI.Get","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/settingUserSettingsResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-user-setting-customapi-get"},"x-ves-proto-rpc":"ves.io.schema.user.setting.CustomAPI.Get"},"put":{"summary":"Update","description":"Update defined user settings.","operationId":"ves.io.schema.user.setting.CustomAPI.Update","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/usersettingEmpty"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/settingUserSettingsRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-user-setting-customapi-update"},"x-ves-proto-rpc":"ves.io.schema.user.setting.CustomAPI.Update"},"x-displayname":"User Settings Custom API","x-ves-proto-service":"ves.io.schema.user.setting.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/web/namespaces/system/user/settings/idm/disable":{"put":{"summary":"DisableUserInIDM","description":"Disables user in Identity.","operationId":"ves.io.schema.user.setting.CustomAPI.DisableUserInIDM","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/usersettingEmpty"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"requestBody":{"$ref":"#/components/requestBodies/settingUserEmail"},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-user-setting-customapi-disableuserinidm"},"x-ves-proto-rpc":"ves.io.schema.user.setting.CustomAPI.DisableUserInIDM"},"x-displayname":"User Settings Custom API","x-ves-proto-service":"ves.io.schema.user.setting.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/web/namespaces/system/user/settings/idm/enable":{"put":{"summary":"EnableUserInIDM","description":"Enables user in Identity. Use this to enable a user which is disabled.","operationId":"ves.io.schema.user.setting.CustomAPI.EnableUserInIDM","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/usersettingEmpty"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"requestBody":{"$ref":"#/components/requestBodies/settingUserEmail"},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-user-setting-customapi-enableuserinidm"},"x-ves-proto-rpc":"ves.io.schema.user.setting.CustomAPI.EnableUserInIDM"},"x-displayname":"User Settings Custom API","x-ves-proto-service":"ves.io.schema.user.setting.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/web/namespaces/system/user/settings/image":{"get":{"summary":"GetUserProfileImage","description":"GetUserProfileImage returns user profile picture.","operationId":"ves.io.schema.user.setting.CustomAPI.GetUserImage","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/apiHttpBody"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-user-setting-customapi-getuserimage"},"x-ves-proto-rpc":"ves.io.schema.user.setting.CustomAPI.GetUserImage"},"delete":{"summary":"DeleteUserImage","description":"Deletes current user profile picture.","operationId":"ves.io.schema.user.setting.CustomAPI.DeleteUserImage","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/usersettingEmpty"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-user-setting-customapi-deleteuserimage"},"x-ves-proto-rpc":"ves.io.schema.user.setting.CustomAPI.DeleteUserImage"},"put":{"summary":"UpdateUserImage","description":"Updates current user profile picture.","operationId":"ves.io.schema.user.setting.CustomAPI.UpdateUserImage","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/usersettingEmpty"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/settingUpdateImageRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-user-setting-customapi-updateuserimage"},"x-ves-proto-rpc":"ves.io.schema.user.setting.CustomAPI.UpdateUserImage"},"x-displayname":"User Settings Custom API","x-ves-proto-service":"ves.io.schema.user.setting.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/web/namespaces/system/user/settings/request_initial_access":{"put":{"summary":"Request Initial Access","description":"Request initial access requests initial access for user within tenant.\nEmails will be send to tenant's admins with corresponding information.","operationId":"ves.io.schema.user.setting.CustomAPI.RequestInitialAccess","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/usersettingEmpty"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/usersettingEmpty"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-user-setting-customapi-requestinitialaccess"},"x-ves-proto-rpc":"ves.io.schema.user.setting.CustomAPI.RequestInitialAccess"},"x-displayname":"User Settings Custom API","x-ves-proto-service":"ves.io.schema.user.setting.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/web/namespaces/system/user/settings/view_preference":{"get":{"summary":"Get view preference","description":"Get view preference gets view preference for specific user.","operationId":"ves.io.schema.user.setting.CustomAPI.GetViewPreference","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/settingViewPreference"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-user-setting-customapi-getviewpreference"},"x-ves-proto-rpc":"ves.io.schema.user.setting.CustomAPI.GetViewPreference"},"put":{"summary":"Set view preference","description":"Set view preference sets view preference for specific user.","operationId":"ves.io.schema.user.setting.CustomAPI.SetViewPreference","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/usersettingEmpty"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/settingSetViewPreferenceRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-user-setting-customapi-setviewpreference"},"x-ves-proto-rpc":"ves.io.schema.user.setting.CustomAPI.SetViewPreference"},"x-displayname":"User Settings Custom API","x-ves-proto-service":"ves.io.schema.user.setting.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"}},"x-displayname":"User Settings Custom API","x-ves-proto-package":"ves.io.schema.user.setting","components":{"requestBodies":{"settingNtfnPreferencesMap":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/settingNtfnPreferencesMap"}}},"required":true},"settingNtfnToUnset":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/settingNtfnToUnset"}}},"required":true},"settingUserEmail":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/settingUserEmail"}}},"required":true}},"schemas":{"apiHttpBody":{"type":"object","description":"Message that represents an arbitrary HTTP body. It should only be used for\npayload formats that can't be represented as JSON, such as raw binary or\nan HTML page.\n\n\nThis message can be used both in streaming and non-streaming API methods in\nthe request as well as the response.\n\nIt can be used as a top-level request field, which is convenient if one\nwants to extract parameters from either the URL or HTTP template into the\nrequest fields and also want access to the raw HTTP body.\n\nExample:\n\n    message GetResourceRequest {\n      // A unique request id.\n      string request_id = 1;\n\n      // The raw HTTP body is bound to this field.\n      google.api.HttpBody http_body = 2;\n    }\n\n    service ResourceService {\n      rpc GetResource(GetResourceRequest) returns (google.api.HttpBody);\n      rpc UpdateResource(google.api.HttpBody) returns\n      (google.protobuf.Empty);\n    }\n\nExample with streaming methods:\n\n    service CaldavService {\n      rpc GetCalendar(stream google.api.HttpBody)\n        returns (stream google.api.HttpBody);\n      rpc UpdateCalendar(stream google.api.HttpBody)\n        returns (stream google.api.HttpBody);\n    }\n\nUse of this type only changes how the request and response bodies are\nhandled, all other features will continue to work unchanged.","properties":{"content_type":{"type":"string","description":"The HTTP Content-Type header value specifying the content type of the body."},"data":{"type":"string","description":"The HTTP request/response body as raw binary.","format":"byte"},"extensions":{"type":"array","description":"Application specific response metadata. Must be set in the first response\nfor streaming APIs.","items":{"$ref":"#/components/schemas/protobufAny"}}}},"protobufAny":{"type":"object","description":"`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n    Foo foo = ...;\n    Any any;\n    any.PackFrom(foo);\n    ...\n    if (any.UnpackTo(&foo)) {\n      ...\n    }\n\nExample 2: Pack and unpack a message in Java.\n\n    Foo foo = ...;\n    Any any = Any.pack(foo);\n    ...\n    if (any.is(Foo.class)) {\n      foo = any.unpack(Foo.class);\n    }\n\n Example 3: Pack and unpack a message in Python.\n\n    foo = Foo(...)\n    any = Any()\n    any.Pack(foo)\n    ...\n    if any.Is(Foo.DESCRIPTOR):\n      any.Unpack(foo)\n      ...\n\n Example 4: Pack and unpack a message in Go\n\n     foo := &pb.Foo{...}\n     any, err := ptypes.MarshalAny(foo)\n     ...\n     foo := &pb.Foo{}\n     if err := ptypes.UnmarshalAny(any, foo); err != nil {\n       ...\n     }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n    package google.profile;\n    message Person {\n      string first_name = 1;\n      string last_name = 2;\n    }\n\n    {\n      \"@type\": \"type.googleapis.com/google.profile.Person\",\n      \"firstName\": <string>,\n      \"lastName\": <string>\n    }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n    {\n      \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n      \"value\": \"1.212s\"\n    }","properties":{"type_url":{"type":"string","description":"A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n  value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n  URL, or have them precompiled into a binary to avoid any\n  lookup. Therefore, binary compatibility needs to be preserved\n  on changes to types. (Use versioned type names to manage\n  breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics."},"value":{"type":"string","description":"Must be a valid serialized protocol buffer of the above specified type.","format":"byte"}}},"settingInitialAccess":{"type":"object","description":"User console view preferences","title":"Initial access","x-displayname":"Initial access","x-ves-proto-message":"ves.io.schema.user.setting.InitialAccess","properties":{"email_sent":{"type":"boolean","description":" Boolean flag which shows whether email has been sent or not.","title":"EmailSent","format":"boolean","x-displayname":"EmailSent"},"last_requesting_time":{"type":"string","description":" If initial access was requested at least once, last_requesting_time contains last time when it happened.","title":"Last requesting time","format":"date-time","x-displayname":"Last requesting time"},"requested":{"type":"boolean","description":" Boolean flag which shows whether initial access was requested or not.","title":"Requested","format":"boolean","x-displayname":"Requested"}}},"settingNotification":{"type":"object","description":"Definition of existing notifications created for subscription.","title":"Notification","x-displayname":"Notification","x-ves-proto-message":"ves.io.schema.user.setting.Notification","properties":{"code":{"type":"string","description":" Code of notification.\n\nExample: ` \"notif-1\"`","title":"Code","x-displayname":"Code","x-ves-example":"notif-1"},"description":{"type":"string","description":" Description text of the notification.\n\nExample: ` \"Something to notify of\"`","title":"Notification","x-displayname":"Notification","x-ves-example":"Something to notify of"},"enabled":{"type":"boolean","description":" Is it enabled.","title":"Enabled","format":"boolean","x-displayname":"Enabled"},"label":{"type":"string","description":" Public label of the notification.\n\nExample: ` \"Notification 1\"`","title":"Label","x-displayname":"Label","x-ves-example":"Notification 1"}}},"settingNotificationList":{"type":"object","description":"List of notifications","title":"NotificationList","x-displayname":"NotificationList","x-ves-proto-message":"ves.io.schema.user.setting.NotificationList","properties":{"notifications":{"type":"array","description":" List of notifications.","title":"Notifications","items":{"$ref":"#/components/schemas/settingNotification"},"x-displayname":"Notifications"}}},"settingNtfnPreferencesMap":{"type":"object","description":"Notification preferences information","title":"Notification preferences","x-displayname":"Notification preferences","x-ves-proto-message":"ves.io.schema.user.setting.NtfnPreferencesMap","properties":{"ntfn_preferences_map":{"type":"object","description":" Ntfn preferences map contains information whether user is enabled or disabled specific notification.\n\nExample: ` \"['notif-1':false]\"`","title":"Ntfn preferences map","x-displayname":"Ntfn preferences map","x-ves-example":"['notif-1':false]"}}},"settingNtfnToUnset":{"type":"object","description":"Notification to unset","title":"Notification unset","x-displayname":"Notification unset","x-ves-proto-message":"ves.io.schema.user.setting.NtfnToUnset","properties":{"ntfn_to_unset":{"type":"string","description":" Ntfn to unset contains notification which should be unset for particular user.\n\nExample: ` \"notif-1\"`","title":"Ntfn to unset","x-displayname":"Ntfn to unset","x-ves-example":"notif-1"}}},"settingPersonaPreferences":{"type":"object","description":"Preferences to display appropriate content to appropriate audience","title":"Persona type","x-displayname":"Persona type","x-ves-proto-message":"ves.io.schema.user.setting.PersonaPreferences","properties":{"billing":{"type":"boolean","description":" Audience is a billing admin","title":"Billing","format":"boolean","x-displayname":"Billing"},"dev_ops":{"type":"boolean","description":" Audience is DevOps","title":"DevOps","format":"boolean","x-displayname":"DevOps"},"developer":{"type":"boolean","description":" Audience is a developer","title":"Developer","format":"boolean","x-displayname":"Developer"},"master":{"type":"boolean","description":" Audience is an admin","title":"Admin","format":"boolean","x-displayname":"Admin"},"net_ops":{"type":"boolean","description":" Audience is NetOps","title":"NetOps","format":"boolean","x-displayname":"NetOps"},"sec_ops":{"type":"boolean","description":" Audience is SecOps","title":"SecOps","format":"boolean","x-displayname":"SecOps"}}},"settingSetViewPreferenceRequest":{"type":"object","description":"User console view preferences","title":"View preference","x-displayname":"View preference","x-ves-proto-message":"ves.io.schema.user.setting.SetViewPreferenceRequest","properties":{"advanced_view":{"type":"boolean","description":" If true then more options are displayed, otherwise a simplified view is displayed","title":"Advanced view","format":"boolean","x-displayname":"Advanced view"},"persona_preferences":{"$ref":"#/components/schemas/settingPersonaPreferences"}}},"settingUpdateImageRequest":{"type":"object","description":"Message contains data for updating user profile image.","title":"UpdateImageRequest","x-displayname":"UpdateImageRequest","x-ves-proto-message":"ves.io.schema.user.setting.UpdateImageRequest","properties":{"content_type":{"type":"string","description":" Type of uploading image.\n\nExample: ` \"image/jpeg\"`","x-displayname":"ContentType","x-ves-example":"image/jpeg"},"image":{"type":"string","description":" Blob of the user profile image.\n\nExample: ` \"dXNlci1pbWFnZS5qcGVn\"`","format":"byte","x-displayname":"Image","x-ves-example":"dXNlci1pbWFnZS5qcGVn"}}},"settingUserEmail":{"type":"object","description":"Email","title":"Email","x-displayname":"Email","x-ves-proto-message":"ves.io.schema.user.setting.UserEmail","properties":{"user_email":{"type":"string","description":"\n\nExample: ` \"joe.doe@acme.com\"`","title":"Email","x-displayname":"Email","x-ves-example":"joe.doe@acme.com"}}},"settingUserSession":{"type":"object","description":"UserSession contains information about active user's sessions in IAM.","title":"UserSession","x-displayname":"UserSession","x-ves-proto-message":"ves.io.schema.user.setting.UserSession","properties":{"ip_address":{"type":"string","description":" IPAddress from which session was initialized.\n\nExample: ` \"127.0.0.1\"`","title":"IPAddress","x-displayname":"IPAddress","x-ves-example":"127.0.0.1"},"last_access":{"type":"string","description":" Last recorded activity for the session.\n\nExample: ` \"2020-04-20T12:32:51.341959216Z\"`","title":"LastAccess","format":"date-time","x-displayname":"LastAccess","x-ves-example":"2020-04-20T12:32:51.341959216Z"},"start":{"type":"string","description":" Time when session was initialized.\n\nExample: ` \"2020-04-20T12:32:51.341959216Z\"`","title":"Start","format":"date-time","x-displayname":"Start","x-ves-example":"2020-04-20T12:32:51.341959216Z"}}},"settingUserSessionList":{"type":"object","description":"UserSessionList contains list of user sessions.","title":"UserSessionList","x-displayname":"UserSessionList","x-ves-proto-message":"ves.io.schema.user.setting.UserSessionList","properties":{"user_sessions":{"type":"array","description":" UserSessions contains list of user sessions.","title":"UserSessions","items":{"$ref":"#/components/schemas/settingUserSession"},"x-displayname":"UserSessions"}}},"settingUserSettingsRequest":{"type":"object","description":"Allowed settings for the user to be modified.","title":"UserSettingsRequest","x-displayname":"UserSettingsRequest","x-ves-proto-message":"ves.io.schema.user.setting.UserSettingsRequest","properties":{"enabled_notifications":{"type":"array","description":" Enabled notification for specific user.\n\nExample: ` \"['notif-1','notif-2']\"`","title":"Enabled Notifications","items":{"type":"string"},"x-displayname":"Enabled Notifications","x-ves-example":"['notif-1','notif-2']"},"first_name":{"type":"string","description":" First name of the user.\n\nExample: ` \"Joe\"`","title":"First Name","x-displayname":"First Name","x-ves-example":"Joe"},"image":{"type":"string","description":" Blob of the user avatar image.\n\nExample: ` \"dXNlci1pbWFnZS5qcGVn\"`","title":"Image","format":"byte","x-displayname":"Image","x-ves-example":"dXNlci1pbWFnZS5qcGVn"},"last_name":{"type":"string","description":" Last Name of the user.\n\nExample: ` \"Doe\"`","title":"Last Name","x-displayname":"Last Name","x-ves-example":"Doe"},"otp_enabled":{"type":"boolean","description":" OTP enabled flag","title":"OTP enable","format":"boolean","x-displayname":"OTP enabled"}}},"settingUserSettingsResponse":{"type":"object","description":"Response of modified user settings.","title":"UserSettingsResponse","x-displayname":"UserSettingsResponse","x-ves-proto-message":"ves.io.schema.user.setting.UserSettingsResponse","properties":{"image":{"type":"string","description":" Image blob field stores user's image, should be base64 encoded while used by http.\n\nExample: ` \"dXNlci1pbWFnZS5qcGVn\"`","title":"Image","format":"byte","x-displayname":"Image","x-ves-example":"dXNlci1pbWFnZS5qcGVn"},"initial_access":{"$ref":"#/components/schemas/settingInitialAccess"},"is_next_request_allowed":{"type":"boolean","description":" Boolean flag which shows whether re-request access is allowed or not.\n Virtually flag shows whether 24hrs are passed from the last_requesting_time timestamp or not.","title":"Is Next Request Allowed","format":"boolean","x-displayname":"Is Next Request Allowed"},"notifications":{"type":"array","description":" List of enabled notifications for specific user account.","title":"EnabledNotification","items":{"$ref":"#/components/schemas/settingNotification"},"x-displayname":"EnabledNotification"},"otp_enabled":{"type":"boolean","description":" Switcher for configuration of enabling OTP in IAM Provider.","title":"OTP Enabled","format":"boolean","x-displayname":"OTP Enabled"},"otp_status":{"$ref":"#/components/schemas/tenantOtpStatus"}}},"settingViewPreference":{"type":"object","description":"Preferences to display appropriate content to appropriate audience","title":"View preference","x-displayname":"View preference","x-ves-proto-message":"ves.io.schema.user.setting.ViewPreference","properties":{"advanced_view":{"type":"boolean","description":" If true then more options are displayed, otherwise a simplified view is displayed","title":"Advanced view","format":"boolean","x-displayname":"Advanced view"},"initialized":{"type":"boolean","description":" If true then the user picked their preference","title":"Initialized","format":"boolean","x-displayname":"Initialized"},"persona_preferences":{"$ref":"#/components/schemas/settingPersonaPreferences"}}},"tenantOtpStatus":{"type":"string","description":"OtpStatus can be either enabled/disabled or processing.\nApplying new policy can take time, especially if tenant has many users so for this purpose processing state is introduced.\n\n - OTP_DISABLED: OTP_DISABLED\n\nOTP disabled\n - OTP_ENABLED: OTP_ENABLED\n\nOTP enabled\n - OTP_PROCESSING: OTP_PROCESSING\n\nOTP is being updated\n - OTP_PROCESS_DISABLING: OTP_PROCESSING\n\nOTP is being updated to be disabled","title":"OtpStatus","enum":["OTP_DISABLED","OTP_ENABLED","OTP_PROCESSING","OTP_PROCESS_DISABLING"],"default":"OTP_DISABLED","x-displayname":"OtpStatus","x-ves-proto-enum":"ves.io.schema.tenant.OtpStatus"},"usersettingEmpty":{"type":"object","description":"Empty object definition.","title":"Empty","x-displayname":"Empty","x-ves-proto-message":"ves.io.schema.user.setting.Empty"}}}}

package/dist/docs/specifications/api/docs-cloud-f5-com.0255.public.ves.io.schema.views.view_internal.ves-swagger.json

@@ -0,0 +1 @@
+{"openapi":"3.0.0","info":{"title":"F5 Distributed Cloud Services API for ves.io.schema.views.view_internal","description":"View Internal object contains reference to child objects of a given view","version":""},"paths":{"/api/config/namespaces/{namespace}/view_internal/{view_kind}/{view_name}":{"get":{"summary":"Get Internal object for view","description":"returned internal object for a given view.","operationId":"ves.io.schema.views.view_internal.CustomAPI.Get","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/view_internalGetResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"Namespace\n\nx-example: \"value\"\nNamespace for the object  to be retrieved","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"view_kind","description":"Kind of View\n\nx-example: \"value\"\nKind of view of which internal objec is  requested e.g. aws_vpc_site, azure_vnet_site","in":"path","required":true,"x-displayname":"Kind of View","schema":{"type":"string"}},{"name":"view_name","description":"Name of view\n\nx-example: \"value\"\nName of the view for which internal object is requested","in":"path","required":true,"x-displayname":"Name of view","schema":{"type":"string"}}],"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-views-view_internal-customapi-get"},"x-ves-proto-rpc":"ves.io.schema.views.view_internal.CustomAPI.Get"},"x-displayname":"View Internal","x-ves-proto-service":"ves.io.schema.views.view_internal.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"}},"x-displayname":"View Internal","x-ves-proto-package":"ves.io.schema.views.view_internal","components":{"schemas":{"schemaViewRefType":{"type":"object","description":"ViewRefType represents a reference to a view","title":"ViewRefType","x-displayname":"View Reference","x-ves-proto-message":"ves.io.schema.ViewRefType","properties":{"kind":{"type":"string","description":" Kind of the view object\n\nExample: ` \"http_proxy\"`","title":"kind","x-displayname":"Kind","x-ves-example":"http_proxy"},"name":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then name will hold the referred object's(e.g. route's) name.\n\nExample: ` \"contactus-route\"`","title":"name","x-displayname":"Name","x-ves-example":"contactus-route"},"namespace":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then namespace will hold the referred object's(e.g. route's) namespace.\n\nExample: ` \"ns1\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"ns1"},"uid":{"type":"string","description":" UID of the view object\n\nExample: ` \"f3744323-1adf-4aaa-a5dc-0707c1d1bd82\"`","title":"uid","x-displayname":"UID","x-ves-example":"f3744323-1adf-4aaa-a5dc-0707c1d1bd82"}}},"view_internalAllocatedNumbers":{"type":"object","description":"x-displayName: \"Allocated Numbers\"\nAllocated Numbers","title":"AlloatedNumbers","properties":{"allocatedNumbers":{"type":"object","description":"x-displayName: \"Allocated Numbers\"\nAllocated Numbers","title":"AllocatedNumbers"}}},"view_internalGetResponse":{"type":"object","description":"Response for Get API","title":"GetResponse","x-displayname":"Get Response","x-ves-proto-message":"ves.io.schema.views.view_internal.GetResponse","properties":{"view_internal":{"$ref":"#/components/schemas/view_internalGlobalSpecType"}}},"view_internalGlobalSpecType":{"type":"object","description":"Shape of the view internal specification","title":"GlobalSpecType","x-displayname":"View Specification","x-ves-proto-message":"ves.io.schema.views.view_internal.GlobalSpecType","properties":{"allocationMap":{"type":"object","description":" Allocation Map keeps track of all allocations for this view. The key is the allocator name.","title":"Allocation Map","x-displayname":"Allocation Map"},"child_objects":{"type":"array","description":" Reference to child objects","title":"child_objects","items":{"$ref":"#/components/schemas/schemaViewRefType"},"x-displayname":"Child Objects"},"view":{"$ref":"#/components/schemas/schemaViewRefType"}}}}}}

package/dist/docs/specifications/api/docs-cloud-f5-com.0256.public.ves.io.schema.views.terraform_parameters.ves-swagger.json

@@ -0,0 +1 @@
+{"openapi":"3.0.0","info":{"title":"F5 Distributed Cloud Services API for ves.io.schema.views.terraform_parameters","description":"View Terraform Parameters is set of parameters that are used by terraform scripts \nto instantiate view objects external to volterra","version":""},"paths":{"/api/terraform/namespaces/{namespace}/terraform/{view_kind}/{view_name}/force-delete":{"post":{"summary":"Force delete view","description":"force delete view object. This can result in staled objects in cloud provider.","operationId":"ves.io.schema.views.terraform_parameters.CustomActionAPI.ForceDelete","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/terraform_parametersForceDeleteResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"Namespace\n\nx-example: \"value\"\nNamespace for the label to be retrieved","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"view_kind","description":"Kind of View\n\nx-example: \"value\"\nKind of view of which terraform parameters are requested e.g. aws_vpc_site, azure_vnet_site","in":"path","required":true,"x-displayname":"Kind of View","schema":{"type":"string"}},{"name":"view_name","description":"Name of view\n\nx-example: \"value\"\nName of the view for which terraform parameters are requested","in":"path","required":true,"x-displayname":"Name of view","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/terraform_parametersForceDeleteRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-views-terraform_parameters-customactionapi-forcedelete"},"x-ves-proto-rpc":"ves.io.schema.views.terraform_parameters.CustomActionAPI.ForceDelete"},"x-displayname":"View Terraform Parameters","x-ves-proto-service":"ves.io.schema.views.terraform_parameters.CustomActionAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/terraform/namespaces/{namespace}/terraform/{view_kind}/{view_name}/run":{"post":{"summary":"Run Terraform Action for view","description":"perform terraform actions for a given view. Supported actions are apply and plan.","operationId":"ves.io.schema.views.terraform_parameters.CustomActionAPI.Run","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/terraform_parametersRunResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"Namespace\n\nx-example: \"value\"\nNamespace for the label to be retrieved","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"view_kind","description":"Kind of View\n\nx-example: \"value\"\nKind of view of which terraform parameters are requested e.g. aws_vpc_site, azure_vnet_site","in":"path","required":true,"x-displayname":"Kind of View","schema":{"type":"string"}},{"name":"view_name","description":"Name of view\n\nx-example: \"value\"\nName of the view for which terraform parameters are requested","in":"path","required":true,"x-displayname":"Name of view","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/terraform_parametersRunRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-views-terraform_parameters-customactionapi-run"},"x-ves-proto-rpc":"ves.io.schema.views.terraform_parameters.CustomActionAPI.Run"},"x-displayname":"View Terraform Parameters","x-ves-proto-service":"ves.io.schema.views.terraform_parameters.CustomActionAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/config/namespaces/{namespace}/terraform_parameters/{view_kind}/{view_name}":{"get":{"summary":"Get Terraform Parameters for view","description":"returned from list of terraform parameter objects for a given view.","operationId":"ves.io.schema.views.terraform_parameters.CustomAPI.Get","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/terraform_parametersGetResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"Namespace\n\nx-example: \"value\"\nNamespace for the label to be retrieved","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"view_kind","description":"Kind of View\n\nx-example: \"value\"\nKind of view of which terraform parameters are requested e.g. aws_vpc_site, azure_vnet_site","in":"path","required":true,"x-displayname":"Kind of View","schema":{"type":"string"}},{"name":"view_name","description":"Name of view\n\nx-example: \"value\"\nName of the view for which terraform parameters are requested","in":"path","required":true,"x-displayname":"Name of view","schema":{"type":"string"}}],"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-views-terraform_parameters-customapi-get"},"x-ves-proto-rpc":"ves.io.schema.views.terraform_parameters.CustomAPI.Get"},"x-displayname":"View Terraform Parameters","x-ves-proto-service":"ves.io.schema.views.terraform_parameters.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/config/namespaces/{namespace}/terraform_parameters/{view_kind}/{view_name}/status":{"get":{"summary":"Get Status of Terraform for view","description":"returned from list of terraform parameter status objects for a given view.","operationId":"ves.io.schema.views.terraform_parameters.CustomAPI.GetStatus","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/terraform_parametersGetStatusResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"Namespace\n\nx-example: \"value\"\nNamespace for the label to be retrieved","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"view_kind","description":"Kind of View\n\nx-example: \"value\"\nKind of view of which terraform parameters are requested e.g. aws_vpc_site, azure_vnet_site","in":"path","required":true,"x-displayname":"Kind of View","schema":{"type":"string"}},{"name":"view_name","description":"Name of view\n\nx-example: \"value\"\nName of the view for which terraform parameters are requested","in":"path","required":true,"x-displayname":"Name of view","schema":{"type":"string"}}],"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-views-terraform_parameters-customapi-getstatus"},"x-ves-proto-rpc":"ves.io.schema.views.terraform_parameters.CustomAPI.GetStatus"},"x-displayname":"View Terraform Parameters","x-ves-proto-service":"ves.io.schema.views.terraform_parameters.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"}},"x-displayname":"View Terraform Parameters","x-ves-proto-package":"ves.io.schema.views.terraform_parameters","components":{"schemas":{"ioschemaObjectRefType":{"type":"object","description":"This type establishes a 'direct reference' from one object(the referrer) to another(the referred).\nSuch a reference is in form of tenant/namespace/name for public API and Uid for private API\nThis type of reference is called direct because the relation is explicit and concrete (as opposed\nto selector reference which builds a group based on labels of selectee objects)","title":"ObjectRefType","x-displayname":"Object reference","x-ves-proto-message":"ves.io.schema.ObjectRefType","properties":{"kind":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then kind will hold the referred object's kind (e.g. \"route\")\n\nExample: ` \"virtual_site\"`","title":"kind","x-displayname":"Kind","x-ves-example":"virtual_site"},"name":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then name will hold the referred object's(e.g. route's) name.\n\nExample: ` \"contactus-route\"`","title":"name","x-displayname":"Name","x-ves-example":"contactus-route"},"namespace":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then namespace will hold the referred object's(e.g. route's) namespace.\n\nExample: ` \"ns1\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"ns1"},"tenant":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then tenant will hold the referred object's(e.g. route's) tenant.\n\nExample: ` \"acmecorp\"`","title":"tenant","x-displayname":"Tenant","x-ves-example":"acmecorp"},"uid":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then uid will hold the referred object's(e.g. route's) uid.\n\nExample: ` \"d15f1fad-4d37-48c0-8706-df1824d76d31\"`","title":"uid","x-displayname":"UID","x-ves-example":"d15f1fad-4d37-48c0-8706-df1824d76d31"}}},"protobufAny":{"type":"object","description":"`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n    Foo foo = ...;\n    Any any;\n    any.PackFrom(foo);\n    ...\n    if (any.UnpackTo(&foo)) {\n      ...\n    }\n\nExample 2: Pack and unpack a message in Java.\n\n    Foo foo = ...;\n    Any any = Any.pack(foo);\n    ...\n    if (any.is(Foo.class)) {\n      foo = any.unpack(Foo.class);\n    }\n\n Example 3: Pack and unpack a message in Python.\n\n    foo = Foo(...)\n    any = Any()\n    any.Pack(foo)\n    ...\n    if any.Is(Foo.DESCRIPTOR):\n      any.Unpack(foo)\n      ...\n\n Example 4: Pack and unpack a message in Go\n\n     foo := &pb.Foo{...}\n     any, err := ptypes.MarshalAny(foo)\n     ...\n     foo := &pb.Foo{}\n     if err := ptypes.UnmarshalAny(any, foo); err != nil {\n       ...\n     }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n    package google.profile;\n    message Person {\n      string first_name = 1;\n      string last_name = 2;\n    }\n\n    {\n      \"@type\": \"type.googleapis.com/google.profile.Person\",\n      \"firstName\": <string>,\n      \"lastName\": <string>\n    }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n    {\n      \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n      \"value\": \"1.212s\"\n    }","properties":{"type_url":{"type":"string","description":"A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n  value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n  URL, or have them precompiled into a binary to avoid any\n  lookup. Therefore, binary compatibility needs to be preserved\n  on changes to types. (Use versioned type names to manage\n  breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics."},"value":{"type":"string","description":"Must be a valid serialized protocol buffer of the above specified type.","format":"byte"}}},"schemaConditionType":{"type":"object","description":"Conditions are used in the object status to describe the current state of the\nobject, e.g. Ready, Succeeded, etc.","title":"ConditionType","x-displayname":"Status Condition","x-ves-proto-message":"ves.io.schema.ConditionType","properties":{"hostname":{"type":"string","description":" Hostname of the instance of the site that sent the status","title":"hostname","x-displayname":"Hostname"},"last_update_time":{"type":"string","description":" Last time the condition was updated","title":"last_update_time","format":"date-time","x-displayname":"Last Updated"},"reason":{"type":"string","description":" x-reason: \"Insufficient memory in data plane\"\n A human readable string explaining the reason for reaching this condition\n\nExample: ` \"value\"`","title":"reason","x-displayname":"Reason","x-ves-example":"value"},"service_name":{"type":"string","description":" Name of the service that sent the status","title":"service name","x-displayname":"Service Name"},"status":{"type":"string","description":" Status of the condition\n \"Success\" Validtion has succeded. Requested operation was successful.\n \"Failed\"  Validation has failed.\n \"Incomplete\" Validation of configuration has failed due to missing configuration.\n \"Installed\" Validation has passed and configuration has been installed in data path or K8s\n \"Down\" Configuration is operationally down. e.g. down interface\n \"Disabled\" Configuration is administratively disabled i.e. ObjectMetaType.Disable = true.\n \"NotApplicable\" Configuration is not applicable e.g. tenant service_policy_set(s) in system namespace are not applicable on REs\n\nExample: ` \"Failed\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.in: [\\\"Success\\\",\\\"Failed\\\",\\\"Incomplete\\\",\\\"Installed\\\",\\\"Down\\\",\\\"Disabled\\\",\\\"NotApplicable\\\"]\n","title":"status","x-displayname":"Status","x-ves-example":"Failed","x-ves-validation-rules":{"ves.io.schema.rules.string.in":"[\\\"Success\\\",\\\"Failed\\\",\\\"Incomplete\\\",\\\"Installed\\\",\\\"Down\\\",\\\"Disabled\\\",\\\"NotApplicable\\\"]"}},"type":{"type":"string","description":" Type of the condition\n \"Validation\" represents validation user given configuration object\n \"Operational\" represents operational status of a given configuration object\n\nExample: ` \"Operational\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.in: [\\\"Validation\\\",\\\"Operational\\\"]\n","title":"type","x-displayname":"Type","x-ves-example":"Operational","x-ves-validation-rules":{"ves.io.schema.rules.string.in":"[\\\"Validation\\\",\\\"Operational\\\"]"}}}},"schemaStatusMetaType":{"type":"object","description":"StatusMetaType is metadata that all status must have.","title":"StatusMetaType","x-displayname":"Metadata","x-ves-proto-message":"ves.io.schema.StatusMetaType","properties":{"creation_timestamp":{"type":"string","description":" creation_timestamp is when the status object was created. It is used to find/tie-break\n for latest status object from same origin","title":"creation_timestamp","format":"date-time","x-displayname":"Creation Timestamp"},"creator_class":{"type":"string","description":" Class of creator which created this StatusObject. This will be service's DNS FQDN.\n This will be set by the system based on client certificate information.\n\nExample: ` \"ver.re1.int.ves.io\"`","title":"creator_class","x-displayname":"Creator Class","x-ves-example":"ver.re1.int.ves.io"},"creator_id":{"type":"string","description":" ID of creator which created this StatusObject. This will be a concrete identifier for service (e.g.\n identifying the environment also). This will be set by the system based on client certificate\n information\n\nExample: ` \"ver-instance-1\"`","title":"creator_id","x-displayname":"Creator ID","x-ves-example":"ver-instance-1"},"publish":{"$ref":"#/components/schemas/schemaStatusPublishType"},"status_id":{"type":"string","description":" status_id is a field used by the generator to distinguish (if necessary) between two status\n objects for the same config object from the same site and same service and potentially same\n daemon(creator-id)","title":"status_id","x-displayname":"Status ID"},"uid":{"type":"string","description":" uid is the unique in time and space value for a StatusObject.\n\nExample: ` \"d15f1fad-4d37-48c0-8706-df1824d76d31\"`","title":"uid","x-displayname":"UID","x-ves-example":"d15f1fad-4d37-48c0-8706-df1824d76d31"},"vtrp_id":{"type":"string","description":" Origin of this status exchanged by VTRP.","title":"vtrp_id","x-displayname":"VTRP ID"},"vtrp_stale":{"type":"boolean","description":" Indicate whether mars deems this object to be stale via graceful restart timer information","title":"vtrp_stale","format":"boolean","x-displayname":"VTRP Stale"}}},"schemaStatusPublishType":{"type":"string","description":"StatusPublishType is all possible publish operations on a StatusObject\n\n - STATUS_DO_NOT_PUBLISH: Do Not Publish\n\nDo not propagate this status to user. This could be because status is only informational\n - STATUS_PUBLISH: Publish\n\nPropagate this status up to user as it might be actionable","title":"StatusPublishType","enum":["STATUS_DO_NOT_PUBLISH","STATUS_PUBLISH"],"default":"STATUS_DO_NOT_PUBLISH","x-displayname":"Status Publish Type","x-ves-proto-enum":"ves.io.schema.StatusPublishType"},"terraform_parametersApplyStageState":{"type":"string","title":"- APPLIED: x-displayName: \"Applied\"\n - APPLY_ERRORED: x-displayName: \"Apply errored\"\n - APPLY_INIT_ERRORED: x-displayName: \"Apply init errored\"\n - APPLYING: x-displayName: \"Applying\"\n - APPLY_PLANNING: x-displayName: \"Apply planning\"\n - APPLY_PLAN_ERRORED: x-displayName: \"Apply plan errored\"\n - APPLY_QUEUED: x-displayName: \"Apply queued\"","enum":["APPLIED","APPLY_ERRORED","APPLY_INIT_ERRORED","APPLYING","APPLY_PLANNING","APPLY_PLAN_ERRORED","APPLY_QUEUED"],"default":"APPLIED","x-displayname":"","x-ves-proto-enum":"ves.io.schema.views.terraform_parameters.ApplyStageState"},"terraform_parametersApplyStatus":{"type":"object","x-ves-oneof-field-state":"[\"apply_state\",\"destroy_state\",\"infra_state\"]","x-ves-proto-message":"ves.io.schema.views.terraform_parameters.ApplyStatus","properties":{"apply_state":{"$ref":"#/components/schemas/terraform_parametersApplyStageState"},"container_version":{"type":"string","description":" Container image version","title":"container_version","x-displayname":"Container image version"},"destroy_state":{"$ref":"#/components/schemas/terraform_parametersDestroyStageState"},"error_output":{"type":"string","description":" Error output of terraform run\n\nExample: ` \"value\"`","title":"error_output","x-displayname":"Error Output","x-ves-example":"value"},"infra_state":{"$ref":"#/components/schemas/terraform_parametersInfraState"},"modification_timestamp":{"type":"string","description":" ModificationTimestamp is a timestamp representing the server time when this status was\n last modified.","title":"modification_timestamp","format":"date-time","x-displayname":"Modification Timestamp"},"suggested_action":{"type":"string","description":" Suggested action for customer on error\n\nExample: ` \"value\"`","title":"suggested_action","x-displayname":"Suggested Action","x-ves-example":"value"},"tf_output":{"type":"string","description":" The value of an \"output\" variable from the terraform state file.\n\nExample: ` \"value\"`","title":"tf_output","x-displayname":"Terraform Output","x-ves-example":"value"},"tf_stdout":{"type":"string","description":" The stdout of terraform apply command.","title":"tf_stdout","x-displayname":"Terraform Standard Output"}}},"terraform_parametersDestroyStageState":{"type":"string","title":"- DESTROYED: x-displayName: \"Destroyed\"\n - DESTROY_ERRORED: x-displayName: \"Destroy errored\"\n - DESTROYING: x-displayName: \"Destroying\"\n - DESTROY_QUEUED: x-displayName: \"Destroy Queued\"","enum":["DESTROYED","DESTROY_ERRORED","DESTROYING","DESTROY_QUEUED"],"default":"DESTROYED","x-displayname":"","x-ves-proto-enum":"ves.io.schema.views.terraform_parameters.DestroyStageState"},"terraform_parametersForceDeleteRequest":{"type":"object","description":"Force delete view request","title":"ForceDeleteRequest","x-displayname":"Force delete view request","x-ves-proto-message":"ves.io.schema.views.terraform_parameters.ForceDeleteRequest","properties":{"namespace":{"type":"string","description":" Namespace for the label to be retrieved\n\nExample: ` \"value\"`","title":"Namespace","x-displayname":"Namespace","x-ves-example":"value"},"view_kind":{"type":"string","description":" Kind of view of which terraform parameters are requested e.g. aws_vpc_site, azure_vnet_site\n\nExample: ` \"value\"`","title":"Kind of View","x-displayname":"Kind of View","x-ves-example":"value"},"view_name":{"type":"string","description":" Name of the view for which terraform parameters are requested\n\nExample: ` \"value\"`","title":"Name of view","x-displayname":"Name of view","x-ves-example":"value"}}},"terraform_parametersForceDeleteResponse":{"type":"object","description":"Force delete view response","title":"ForceDeleteResponse","x-displayname":"Force delete view response","x-ves-proto-message":"ves.io.schema.views.terraform_parameters.ForceDeleteResponse"},"terraform_parametersGetResponse":{"type":"object","description":"Response for Get API","title":"GetResponse","x-displayname":"Get Response","x-ves-proto-message":"ves.io.schema.views.terraform_parameters.GetResponse","properties":{"terraform_parameters":{"$ref":"#/components/schemas/viewsterraform_parametersGlobalSpecType"}}},"terraform_parametersGetStatusResponse":{"type":"object","description":"Response for GetStatus API","title":"GetStatusResponse","x-displayname":"Get Status Response","x-ves-proto-message":"ves.io.schema.views.terraform_parameters.GetStatusResponse","properties":{"status":{"$ref":"#/components/schemas/terraform_parametersStatusObject"}}},"terraform_parametersInfraState":{"type":"string","title":"- PROVISIONED: x-displayName: \"Provisioned\"\n - TIMED_OUT: x-displayName: \"Timed out\"\n - ERRORED: x-displayName: \"Errored\"\n - PROVISIONING: x-displayName: \"Provisioning\"","enum":["PROVISIONED","TIMED_OUT","ERRORED","PROVISIONING"],"default":"PROVISIONED","x-displayname":"","x-ves-proto-enum":"ves.io.schema.views.terraform_parameters.InfraState"},"terraform_parametersPlanStageState":{"type":"string","description":"Terraform state during plan stage\n","title":"Plan Stage State","enum":["PLANNING","PLAN_ERRORED","NO_CHANGES","HAS_CHANGES","DISCARDED","PLAN_INIT_ERRORED","PLAN_QUEUED"],"default":"PLANNING","x-displayname":"Plan Stage State","x-ves-proto-enum":"ves.io.schema.views.terraform_parameters.PlanStageState"},"terraform_parametersPlanStatus":{"type":"object","x-ves-oneof-field-state":"[\"infra_state\",\"plan_state\"]","x-ves-proto-message":"ves.io.schema.views.terraform_parameters.PlanStatus","properties":{"error_output":{"type":"string","description":" Error output of terraform run\n\nExample: ` \"value\"`","title":"error_output","x-displayname":"Error Output","x-ves-example":"value"},"infra_state":{"$ref":"#/components/schemas/terraform_parametersInfraState"},"modification_timestamp":{"type":"string","description":" ModificationTimestamp is a timestamp representing the server time when this status was\n last modified.","title":"modification_timestamp","format":"date-time","x-displayname":"Modification Timestamp"},"plan_state":{"$ref":"#/components/schemas/terraform_parametersPlanStageState"},"suggested_action":{"type":"string","description":" Suggested action for customer on error\n\nExample: ` \"value\"`","title":"suggested_action","x-displayname":"Suggested Action","x-ves-example":"value"},"tf_plan_output":{"type":"string","description":" Terraform \"plan\" command output. Terraform performs a refresh, unless explicitly disabled, and then\n determines what actions are necessary to achieve the desired state specified in the configuration files.\n\nExample: ` \"value\"`","title":"tf_plan_output","x-displayname":"Terraform Plan Output","x-ves-example":"value"}}},"terraform_parametersRollbackState":{"type":"string","title":"- ROLLBACK_SUCCESSFUL: x-displayName: \"Rollback successful\"\n - ROLLBACK_ERRORED: x-displayName: \"Rollback errored\"\n - ROLLBACK_NOT_REQUIRED: x-displayName: \"Rollback not required\"","enum":["ROLLBACK_SUCCESSFUL","ROLLBACK_ERRORED","ROLLBACK_NOT_REQUIRED"],"default":"ROLLBACK_SUCCESSFUL"},"terraform_parametersRunAction":{"type":"string","description":"Terraform action to be performed for a given view e.g. plan, apply\n\nApply action used to apply the changes required to reach the desired state of the configuration\nPlan action is a convenient way to check whether the execution plan for a set of changes matches your expectations without making any changes to real resources or to the state\nDESTROY action is used to destroy the Terraform-managed infrastructure","title":"Terraform Action","enum":["APPLY","PLAN","DESTROY"],"default":"APPLY","x-displayname":"Terraform action to be performed","x-ves-proto-enum":"ves.io.schema.views.terraform_parameters.RunAction"},"terraform_parametersRunRequest":{"type":"object","description":"perform terraform actions for a given view. Supported actions are apply and plan.","title":"Run Terraform Action for view","x-displayname":"Run Terraform Action for view","x-ves-proto-message":"ves.io.schema.views.terraform_parameters.RunRequest","properties":{"action":{"$ref":"#/components/schemas/terraform_parametersRunAction"},"namespace":{"type":"string","description":" Namespace for the label to be retrieved\n\nExample: ` \"value\"`","title":"Namespace","x-displayname":"Namespace","x-ves-example":"value"},"view_kind":{"type":"string","description":" Kind of view of which terraform parameters are requested e.g. aws_vpc_site, azure_vnet_site\n\nExample: ` \"value\"`","title":"Kind of View","x-displayname":"Kind of View","x-ves-example":"value"},"view_name":{"type":"string","description":" Name of the view for which terraform parameters are requested\n\nExample: ` \"value\"`","title":"Name of view","x-displayname":"Name of view","x-ves-example":"value"}}},"terraform_parametersRunResponse":{"type":"object","description":"Response for Run API","title":"RunResponse","x-displayname":"Run Response","x-ves-proto-message":"ves.io.schema.views.terraform_parameters.RunResponse"},"terraform_parametersStatusObject":{"type":"object","description":"view terraform parameters status object","title":"Status Object","x-displayname":"Status","x-ves-proto-message":"ves.io.schema.views.terraform_parameters.StatusObject","properties":{"apply_status":{"$ref":"#/components/schemas/terraform_parametersApplyStatus"},"conditions":{"type":"array","description":" Conditions reported by various components of the system","title":"conditions","items":{"$ref":"#/components/schemas/schemaConditionType"},"x-displayname":"Conditions"},"metadata":{"$ref":"#/components/schemas/schemaStatusMetaType"},"object_refs":{"type":"array","description":" View terraform parameters object reference for which this status object is generated","title":"object_refs","items":{"$ref":"#/components/schemas/ioschemaObjectRefType"},"x-displayname":"Config Object"},"plan_status":{"$ref":"#/components/schemas/terraform_parametersPlanStatus"}}},"terraform_parametersUpgradeState":{"type":"string","description":"x-displayName: \"Upgrade State\"\nTerraform State after version Upgrade\n\n - UPGRADE_SUCCESSFUL: x-displayName: \"Upgrade successful\"\n - UPGRADE_ERRORED: x-displayName: \"Upgrade errored\"\n - UPGRADE_NOT_REQUIRED: x-displayName: \"Upgrade not required\"","title":"Upgrade State","enum":["UPGRADE_SUCCESSFUL","UPGRADE_ERRORED","UPGRADE_NOT_REQUIRED"],"default":"UPGRADE_SUCCESSFUL"},"viewsterraform_parametersGlobalSpecType":{"type":"object","description":"Shape of the view terraform parameters specification","title":"GlobalSpecType","x-displayname":"View Terraform Parameters Specification","x-ves-proto-message":"ves.io.schema.views.terraform_parameters.GlobalSpecType","properties":{"container_version":{"type":"string","description":" Container Version used to run the terrafrom.","title":"Container Version","x-displayname":"Container Version"},"creds":{"type":"array","description":" Reference to cloud credentials used in the terraform.","title":"Cloud Credentials","items":{"$ref":"#/components/schemas/ioschemaObjectRefType"},"x-displayname":"Cloud Credentials"},"tf_objects":{"type":"array","description":" Data specific to child objects","title":"child_objects","items":{"$ref":"#/components/schemas/protobufAny"},"x-displayname":"Child Objects"}}}}}}