docs: update docstrings (#486)

Author: sukovanej

packages/effect-http/src/ApiEndpoint.ts

@@ -559,19 +559,22 @@ export interface Security<A> {
 }
 
 /**
+ * @category models
  * @since 1.0.0
  */
 export declare namespace ApiSecurity {
   /**
    * Any endpoint with `Request = Request.Any` and `Response = Response.Any`.
    *
+   * @category models
    * @since 1.0.0
    */
   export type Any = Security<any>
 
   /**
    * Default security spec = no security scheme.
    *
+   * @category models
    * @since 1.0.0
    */
   export type Empty = {}

packages/effect-http/src/ApiResponse.ts

@@ -32,10 +32,12 @@ export interface ApiResponse<S extends ApiResponse.AnyStatus, B, H, R>
 {}
 
 /**
+ * @category models
  * @since 1.0.0
  */
 export declare namespace ApiResponse {
   /**
+   * @category models
    * @since 1.0.0
    */
   export interface Variance<S, B, H, R> {
@@ -48,50 +50,58 @@ export declare namespace ApiResponse {
   }
 
   /**
+   * @category models
    * @since 1.0.0
    */
   export type AnyStatus = number
 
   /**
    * Any request with all `Body`, `Path`, `Query` and `Headers` set to `Schema.Schema.Any`.
    *
+   * @category models
    * @since 1.0.0
    */
   export type Any = ApiResponse<AnyStatus, any, any, unknown>
 
   /**
    * Default response.
    *
+   * @category models
    * @since 1.0.0
    */
   export type Default = ApiResponse<200, ApiSchema.Ignored, ApiSchema.Ignored, never>
 
   /**
+   * @category models
    * @since 1.0.0
    */
   export type Status<Request> = [Request] extends [ApiResponse<infer S, any, any, any>] ? S
     : never
 
   /**
+   * @category models
    * @since 1.0.0
    */
   export type Body<Request> = [Request] extends [ApiResponse<any, infer B, any, any>] ? B
     : never
 
   /**
+   * @category models
    * @since 1.0.0
    */
   export type Headers<Request> = [Request] extends [ApiResponse<any, any, infer H, any>] ? H
     : never
 
   /**
+   * @category models
    * @since 1.0.0
    */
   export type Requirements<Request> = [Request] extends [ApiResponse<any, any, any, infer R>] ? R
     : never
 }
 
 /**
+ * @category refinements
  * @since 1.0.0
  */
 export const isApiResponse: (u: unknown) => u is ApiResponse.Any = internal.isApiResponse

packages/effect-http/src/ApiSchema.ts

@@ -5,7 +5,7 @@ import type * as Schema from "@effect/schema/Schema"
 import * as internal from "./internal/api-schema.js"
 
 /**
- * @category schemas
+ * @category type id
  * @since 1.0.0
  */
 export const IgnoredId: unique symbol = internal.IgnoredId
@@ -17,21 +17,21 @@ export const IgnoredId: unique symbol = internal.IgnoredId
 export type IgnoredId = typeof IgnoredId
 
 /**
- * @category schemas
+ * @category type id
  * @since 1.0.0
  */
 export const Ignored: Ignored = internal.Ignored
 
 /**
- * @category models
+ * @category type id
  * @since 1.0.0
  */
 export interface Ignored {
   readonly [IgnoredId]: IgnoredId
 }
 
 /**
- * @category schemas
+ * @category refinements
  * @since 1.0.0
  */
 export const isIgnored = (u: unknown): u is Ignored => (u as Ignored)?.[IgnoredId] === IgnoredId