Skip to main content
API docs by Redocly

public/portworx/pds/catalog/dataserviceversions/apiv1/dataserviceversions.proto (version not set)

Download OpenAPI specification:Download

DataServiceVersionService

GetDataServiceVersion returns a data service version.

path Parameters
id
required
string

UID of the version.

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "info": {
    }
}

ListCompatibleDataServiceVersions lists all the data service versions compatible with other version of a data service.

query Parameters
dataServiceIds
Array of strings

List of UID of the data service for which compatible data service versions are requested.

dataServiceVersionIds
Array of strings

List of UID of the data service version for which compatible versions are requested.

sort.sortBy
string
Default: "FIELD_UNSPECIFIED"
Enum: "FIELD_UNSPECIFIED" "NAME" "CREATED_AT" "UPDATED_AT" "PHASE"

Name of the attribute to sort results by.

  • FIELD_UNSPECIFIED: Unspecified, do not use.
  • NAME: Sorting based on the name of the resource.
  • CREATED_AT: Sorting on create time of the resource.
  • UPDATED_AT: Sorting on update time of the resource.
  • PHASE: Sorting on phase of the resource.
sort.sortOrder
string
Default: "VALUE_UNSPECIFIED"
Enum: "VALUE_UNSPECIFIED" "ASC" "DESC"

Order of sorting to be applied on requested list. If sort_by having some value and sort_order is not provided, by default ascending order will be used to sort the list.

  • VALUE_UNSPECIFIED: Unspecified, do not use.
  • ASC: Sort order ascending.
  • DESC: Sort order descending.
pagination.pageNumber
string <int64>

Page number is the page number to return based on the size.

pagination.pageSize
string <int64>

Page size is the maximum number of records to include per page.

Responses

Response samples

Content type
application/json
{
  • "compatibleDataServiceVersions": [
    ],
  • "pagination": {
    }
}

ListDataServiceVersions lists all the versions of a data service.

path Parameters
dataServiceId
required
string

UID of the data service.

query Parameters
enabled
string
Default: "ENABLED_UNSPECIFIED"
Enum: "ENABLED_UNSPECIFIED" "TRUE" "FALSE"

Filter data service versions based on enabled flag.

  • ENABLED_UNSPECIFIED: List all versions.
  • TRUE: List only enabled versions.
  • FALSE: List only disabled versions.
sort.sortBy
string
Default: "FIELD_UNSPECIFIED"
Enum: "FIELD_UNSPECIFIED" "NAME" "CREATED_AT" "UPDATED_AT" "PHASE"

Name of the attribute to sort results by.

  • FIELD_UNSPECIFIED: Unspecified, do not use.
  • NAME: Sorting based on the name of the resource.
  • CREATED_AT: Sorting on create time of the resource.
  • UPDATED_AT: Sorting on update time of the resource.
  • PHASE: Sorting on phase of the resource.
sort.sortOrder
string
Default: "VALUE_UNSPECIFIED"
Enum: "VALUE_UNSPECIFIED" "ASC" "DESC"

Order of sorting to be applied on requested list. If sort_by having some value and sort_order is not provided, by default ascending order will be used to sort the list.

  • VALUE_UNSPECIFIED: Unspecified, do not use.
  • ASC: Sort order ascending.
  • DESC: Sort order descending.
pagination.pageNumber
string <int64>

Page number is the page number to return based on the size.

pagination.pageSize
string <int64>

Page size is the maximum number of records to include per page.

Responses

Response samples

Content type
application/json
{
  • "dataServiceVersions": [
    ],
  • "pagination": {
    }
}