api/spec/packages/aip/src/shared/responses.tsp

import "@typespec/rest";
import "@typespec/http";
import "../common/properties.tsp";

namespace Shared;

@doc("{name} response.", T)
@friendlyName("Get{name}Response", T)
model GetResponse<T extends {}> {
  @Http.statusCode _: 200;
  @Http.body body: T;
}

@doc("{name} created response.", T)
@friendlyName("Create{name}Response", T)
model CreateResponse<T extends {}> {
  @Http.statusCode _: 201;
  @Http.body body: T;
}

@doc("{name} upsert response.", T)
@friendlyName("Upsert{name}Response", T)
model UpsertResponse<T extends {}> {
  @Http.statusCode _: 200;
  @Http.body body: T;
}

@doc("{name} updated response.", T)
@friendlyName("Update{name}Response", T)
model UpdateResponse<T extends {}> {
  @Http.statusCode _: 200;
  @Http.body body: T;
}

@doc("Deleted response.")
@friendlyName("DeleteResponse")
model DeleteResponse {
  @Http.statusCode _: 204;
}

/**
 * Cursor paginated response.
 */
@friendlyName("{name}PaginatedResponse", T)
model CursorPaginatedResponse<T> {
  @Http.statusCode _: 200;

  @pageItems
  data: T[];

  meta: Common.CursorMeta;
}

/**
 * Page paginated response.
 */
@friendlyName("{name}PagePaginatedResponse", T)
model PagePaginatedResponse<T> {
  @Http.statusCode _: 200;

  @pageItems
  data: T[];

  meta: Common.PageMeta;
}