Skip to main content
API docs by Redocly

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

Download OpenAPI specification:Download

TemplateDefinitionService

ListTemplateKindRequest: Used to list unique template kind(names).

query Parameters
semanticVersion
string

Version of the revision, this accepts wild card, eg: 1.*, 1.2.

prefix
string

Prefix of the kind, eg: pds, pds:application, pds:application:postg.

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
{
  • "kinds": [
    ],
  • "pagination": {
    }
}

List API lists all the revision

query Parameters
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
{
  • "revisions": [
    ],
  • "pagination": {
    }
}

GetRevision gets the revision details, containing the actual schema.

query Parameters
uid
string

UID of the revision.

nameSemanticVersion.name
required
string

Name(kind) of the revision.

nameSemanticVersion.semanticVersion
required
string

Version of the revision.

Responses

Response samples

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

List API lists all the revision

Request Body schema: application/json
required

Request parameters for listing revisions.

object (v1Selector)

Selector is used to query resources using the associated labels or field names.

object (v1Sort)

The details of the attribute for which the requested list of resource to be sorted.

object (v1PageBasedPaginationRequest)

Request parameters for page-based pagination.

Responses

Request samples

Content type
application/json
{
  • "fieldSelector": {
    },
  • "sort": {
    },
  • "pagination": {
    }
}

Response samples

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

ListTemplateSamples: Used to list template sample schema.

query Parameters
kind
string

filter sample templates based on kind, this accepts wild card, eg: pds:service:postgre*

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
{
  • "templateSamples": [
    ],
  • "pagination": {
    }
}

GetTemplateSample API returns the template sample for a given template id.

path Parameters
id
required
string

UID of the template sample.

Responses

Response samples

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

ListTemplateTypes API returns the list of all supported template types.

query Parameters
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.

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.

Responses

Response samples

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

GetTemplateType API returns the template type by id.

path Parameters
id
required
string

unique id of template type.

Responses

Response samples

Content type
application/json
{
  • "uid": "string",
  • "name": "string",
  • "description": "string"
}