Add field_mappings to organizations download endpoints

This commit is contained in:
allegroai
2023-07-26 18:39:41 +03:00
parent ed86750b24
commit bc2fe28bdd
3 changed files with 117 additions and 31 deletions

View File

@@ -1,5 +1,38 @@
_description: "This service provides organization level operations"
_definitions {
value_mapping {
type: object
required: [key, value]
properties {
key {
description: Original value
type: object
}
value {
description: Translated value
type: object
}
}
}
field_mapping {
type: object
required: [field]
properties {
field {
description: The source field name as specified in the only_fields
type: string
}
name {
description: The column name in the exported csv file
type: string
}
values {
type: array
items { "$ref": "#/definitions/value_mapping"}
}
}
}
}
get_tags {
"2.8" {
description: "Get all the user and system tags used for the company tasks and models"
@@ -202,7 +235,7 @@ prepare_download_for_get_all {
description: Prepares download from get_all_ex parameters
request {
type: object
required: [ entity_type, only_fields]
required: [ entity_type, only_fields, field_mappings]
properties {
only_fields {
description: "List of task field names (nesting is supported using '.', e.g. execution.model_labels). If provided, this list defines the query's projection (only these fields will be returned for each result entry)"
@@ -227,6 +260,11 @@ prepare_download_for_get_all {
model
]
}
field_mappings {
description: The name and value mappings for the exported fields. The fields that are not in the mappings will not be exported
type: array
items { "$ref": "#/definitions/field_mapping"}
}
}
}
response {