Class UsersApi

packages/platform-node/test/HttpApi.test.ts:436–493

{}

class UsersApi extends HttpApiGroup.make("users")
  .add(
    HttpApiEndpoint.get("findById")`/${HttpApiSchema.param("id", Schema.NumberFromString)}`
      .addSuccess(User)
  )
  .add(
    HttpApiEndpoint.post("create")`/`
      .setPayload(Schema.Struct(Struct.omit(
        User.fields,
        "id",
        "createdAt"
      )))
      .setUrlParams(Schema.Struct({
        id: Schema.NumberFromString
      }))
      .addSuccess(User)
      .addError(UserError)
      .addError(UserError) // ensure errors are deduplicated
  )
  .add(
    HttpApiEndpoint.get("list")`/`
      .setHeaders(Schema.Struct({
        page: Schema.NumberFromString.pipe(
          Schema.optionalWith({ default: () => 1 })
        )
      }))
      .setUrlParams(Schema.Struct({
        query: Schema.optional(Schema.String).annotations({ description: "search query" })
      }))
      .addSuccess(Schema.Array(User))
      .addError(NoStatusError)
      .annotate(OpenApi.Deprecated, true)
      .annotate(OpenApi.Summary, "test summary")
      .annotateContext(OpenApi.annotations({ identifier: "listUsers" }))
  )
  .add(
    HttpApiEndpoint.post("upload")`/upload/${Schema.optional(Schema.String)}`
      .setPayload(HttpApiSchema.Multipart(Schema.Struct({
        file: Multipart.SingleFileSchema
      })))
      .addSuccess(Schema.Struct({
        contentType: Schema.String,
        length: Schema.Int
      }))
  )
  .add(
    HttpApiEndpoint.post("uploadStream")`/uploadstream`
      .setPayload(HttpApiSchema.MultipartStream(Schema.Struct({
        file: Multipart.SingleFileSchema
      })))
      .addSuccess(Schema.Struct({
        contentType: Schema.String,
        length: Schema.Int
      }))
  )
  .middleware(Authorization)
  .annotateContext(OpenApi.annotations({ title: "Users API" }))
{}