Chapter 31. Definitions
Shared schema definitions used by the API.
31.1. ApiError Copy linkLink copied to clipboard!
| Name | Description | Schema |
|---|---|---|
| status optional | Status code of the response. | integer |
| type optional | Reference to the type of the error. | string |
| detail optional | Details about the specific instance of the error. | string |
| title optional | Unique error code to identify the type of error. | string |
| error_message optional | Deprecated; alias for detail | string |
| error_type optional | Deprecated; alias for detail | string |
31.2. UserView Copy linkLink copied to clipboard!
| Name | Description | Schema |
|---|---|---|
| verified optional | Whether the user’s email address has been verified | boolean |
| anonymous optional | true if this user data represents a guest user | boolean |
| optional | The user’s email address | string |
| avatar optional | Avatar data representing the user’s icon | object |
| organizations optional | Information about the organizations in which the user is a member | array of object |
| logins optional | The list of external login providers against which the user has authenticated | array of object |
| can_create_repo optional | Whether the user has permission to create repositories | boolean |
| preferred_namespace optional | If true, the user’s namespace is the preferred namespace to display | boolean |
31.3. ViewMirrorConfig Copy linkLink copied to clipboard!
| Name | Description | Schema |
|---|---|---|
| is_enabled optional | Used to enable or disable synchronizations. | boolean |
| external_reference optional | Location of the external repository. | string |
| external_registry_username optional | Username used to authenticate with external registry. | |
| external_registry_password optional | Password used to authenticate with external registry. | |
| sync_start_date optional | Determines the next time this repository is ready for synchronization. | string |
| sync_interval optional | Number of seconds after next_start_date to begin synchronizing. | integer |
| robot_username optional | Username of robot which will be used for image pushes. | string |
| root_rule optional | A list of glob-patterns used to determine which tags should be synchronized. | object |
| external_registry_config optional | object |
31.4. ApiErrorDescription Copy linkLink copied to clipboard!
| Name | Description | Schema |
|---|---|---|
| type optional | A reference to the error type resource | string |
| title optional | The title of the error. Can be used to uniquely identify the kind of error. | string |
| description optional | A more detailed description of the error that may include help for fixing the issue. | string |