Success

Success

Base model for all successful responses.

Table

Parameter	Type	Description
status	integer	The HTTP status code
message	string	The message to return

Formats

Example

A JSON example of this model.

{
  "status": 200,
  "message": "Success"
}

JSON Schema

The JSON Schema for this model.

$schema: https://json-schema.org/draft/2020-12/schema
$id: Success.yaml
type: object
properties:
  status:
    type: integer
    minimum: -2147483648
    maximum: 2147483647
    examples:
      - 200
  message:
    type: string
    examples:
      - Success
required:
  - status
  - message

TypeSpec

The TypeSpec code for this model.

@Versioning.added(CommonGrants.Versions.v0_1)
model Success {
  @example(200)
  status: int32;

  @example("Success")
  message: string;
}

Python

The Python code for this model.

class Success(DefaultResponse):
    """Default success response."""

    status: int = Field(
        default=200,
        description="The HTTP status code",
        examples=[200],
    )
    message: str = Field(
        default="Success",
        description="The message",
        examples=["Success"],
    )

TypeScript

The TypeScript code for this model.

export const SuccessSchema = z.object({
  /** HTTP status code */
  status: z.number().int(),

  /** Success message */
  message: z.string(),
});

Changelog

Version	Changes	Schema
0.1.0	Added Success model	Success.yaml

Ok

A 200 response with data.

Table

Parameter	Type	Description
status	integer	The HTTP status code
message	string	The message to return
data	any	The data to return

Formats

Example

A JSON example of this model.

{
  "status": 200,
  "message": "Success",
  "data": {
    "id": "123",
    "name": "Test 1"
  }
}

JSON Schema

The JSON Schema for this model.

$schema: https://json-schema.org/draft/2020-12/schema
$id: Ok.yaml
type: object
properties:
  data:
    description: Response data
required:
  - data
allOf:
  - $ref: Success.yaml
unevaluatedProperties:
  not: {}
description: A 200 response with data

TypeSpec

The TypeSpec code for this model.

@doc("A 200 response with data")
@Versioning.added(CommonGrants.Versions.v0_1)
model Ok extends Success {
  /** Response data */
  data: unknown;
}

Usage

Use the OkT<T> template to define a 200 response with typed data within an API operation:

import "@common-grants/core";
import "@typespec/http";

using TypeSpec.Http;
using CommonGrants.Responses;

model TestModel {
  id: string;
  name: string;
}

@summary("Get test")
@doc("Get a test model")
@get
op getTest(): OkT<TestModel>;

Changelog

Version	Changes	Schema
0.1.0	Added Ok model	Ok.yaml

Created

A 201 response with data.

Table

Parameter	Type	Description
status	integer	The HTTP status code
message	string	The message to return
data	any	The data to return

Formats

Example

A JSON example of this model.

{
  "status": 201,
  "message": "Created",
  "data": {
    "id": "123",
    "name": "Test 1"
  }
}

JSON Schema

The JSON Schema for this model.

$schema: https://json-schema.org/draft/2020-12/schema
$id: Created.yaml
type: object
properties:
  data:
    description: Response data
required:
  - data
allOf:
  - $ref: Success.yaml
unevaluatedProperties:
  not: {}
description: A 201 response with data

TypeSpec

The TypeSpec code for this model.

@doc("A 201 response with data")
@Versioning.added(CommonGrants.Versions.v0_1)
model Created extends Success {
  /** Response data */
  data: unknown;
}

Usage

Use the CreatedT<T> template to define a 201 response with typed data within an API operation:

import "@common-grants/core";
import "@typespec/http";

using TypeSpec.Http;
using CommonGrants.Responses;

model TestModel {
  id: string;
  name: string;
}

@summary("Create test")
@doc("Create a test model")
@post
op createTest(@body body: TestModel): CreatedT<TestModel>;

Changelog

Version	Changes	Schema
0.1.0	Added Created model	Created.yaml

Accepted

A 202 response with data.

Returned when a request is accepted for processing but may not be applied immediately, such as a change submitted for review. The typed AcceptedT<T> variant also sets a Location header that points to the accepted resource when one is available.

Table

Parameter	Type	Description
status	integer	The HTTP status code
message	string	The message to return
data	any	The data to return

Formats

Example

A JSON example of this model.

{
  "status": 202,
  "message": "Accepted",
  "data": {
    "id": "123",
    "name": "Test 1"
  }
}

JSON Schema

The JSON Schema for this model.

$schema: https://json-schema.org/draft/2020-12/schema
$id: Accepted.yaml
type: object
properties:
  data:
    description: Response data
required:
  - data
allOf:
  - $ref: Success.yaml
unevaluatedProperties:
  not: {}
description: A 202 response with data

TypeSpec

The TypeSpec code for this model.

@doc("A 202 response with data")
@Versioning.added(CommonGrants.Versions.v0_4)
model Accepted extends Success {
  /** Response data */
  data: unknown;
}

Usage

Use the AcceptedT<T> template to define a 202 response with typed data within an API operation:

import "@common-grants/core";
import "@typespec/http";

using TypeSpec.Http;
using CommonGrants.Responses;

model TestModel {
  id: string;
  name: string;
}

@summary("Submit test")
@doc("Submit a test model for processing")
@post
op submitTest(@body body: TestModel): AcceptedT<TestModel>;

Changelog

Version	Changes	Schema
0.4.0	Added Accepted model	Accepted.yaml