# yaml-language-server: $schema=../../wick/wick-config/json-schema/manifest.json
---
name: http
kind: wick/types@v1
metadata:
  version: 0.5.0
package:
  registry:
    host: registry.candle.dev
    namespace: types
types:
  - name: HttpMethod
    kind: wick/type/enum@v1
    description: HTTP method enum
    variants:
      - name: Get
        description: HTTP GET method
      - name: Post
        description: HTTP POST method
      - name: Put
        description: HTTP PUT method
      - name: Delete
        description: HTTP DELETE method
      - name: Patch
        description: HTTP PATCH method
      - name: Head
        description: HTTP HEAD method
      - name: Options
        description: HTTP OPTIONS method
      - name: Trace
        description: HTTP TRACE method
  - name: HttpScheme
    kind: wick/type/enum@v1
    description: HTTP scheme
    variants:
      - name: Http
        description: HTTP scheme
      - name: Https
        description: HTTPS scheme
  - name: HttpVersion
    kind: wick/type/enum@v1
    description: HTTP version
    variants:
      - name: Http1_0
        value: '1.0'
        description: HTTP 1.0 version
      - name: Http1_1
        value: '1.1'
        description: HTTP 1.1 version
      - name: Http2_0
        value: '2.0'
        description: HTTP 2.0 version
  - name: StatusCode
    kind: wick/type/enum@v1
    description: HTTP status code
    variants:
      - name: Continue
        value: '100'
        description: Continue status code
      - name: SwitchingProtocols
        value: '101'
        description: SwitchingProtocols status code
      - name: Ok
        value: '200'
        description: HTTP OK status code
      - name: Created
        value: '201'
        description: Created status code
      - name: Accepted
        value: '202'
        description: Accepted status code
      - name: NonAuthoritativeInformation
        value: '203'
        description: NonAuthoritativeInformation status code
      - name: NoContent
        value: '204'
        description: NoContent status code
      - name: ResetContent
        value: '205'
        description: ResetContent status code
      - name: PartialContent
        value: '206'
        description: PartialContent status code
      - name: MultipleChoices
        value: '300'
        description: MultipleChoices status code
      - name: MovedPermanently
        value: '301'
        description: MovedPermanently status code
      - name: Found
        value: '302'
        description: Found status code
      - name: SeeOther
        value: '303'
        description: SeeOther status code
      - name: NotModified
        value: '304'
        description: NotModified status code
      - name: TemporaryRedirect
        value: '307'
        description: TemporaryRedirect status code
      - name: PermanentRedirect
        value: '308'
        description: PermanentRedirect status code
      - name: BadRequest
        value: '400'
        description: BadRequest status code
      - name: Unauthorized
        value: '401'
        description: Unauthorized status code
      - name: PaymentRequired
        value: '402'
        description: PaymentRequired status code
      - name: Forbidden
        value: '403'
        description: Forbidden status code
      - name: NotFound
        value: '404'
        description: NotFound status code
      - name: MethodNotAllowed
        value: '405'
        description: MethodNotAllowed status code
      - name: NotAcceptable
        value: '406'
        description: NotAcceptable status code
      - name: ProxyAuthenticationRequired
        value: '407'
        description: ProxyAuthenticationRequired status code
      - name: RequestTimeout
        value: '408'
        description: RequestTimeout status code
      - name: Conflict
        value: '409'
        description: Conflict status code
      - name: Gone
        value: '410'
        description: Gone status code
      - name: LengthRequired
        value: '411'
        description: LengthRequired status code
      - name: PreconditionFailed
        value: '412'
        description: PreconditionFailed status code
      - name: PayloadTooLarge
        value: '413'
        description: PayloadTooLarge status code
      - name: URITooLong
        value: '414'
        description: URITooLong status code
      - name: UnsupportedMediaType
        value: '415'
        description: UnsupportedMediaType status code
      - name: RangeNotSatisfiable
        value: '416'
        description: RangeNotSatisfiable status code
      - name: ExpectationFailed
        value: '417'
        description: ExpectationFailed status code
      - name: ImATeapot
        value: '418'
        description: ImATeapot status code
      - name: UnprocessableEntity
        value: '422'
        description: UnprocessableEntity status code
      - name: Locked
        value: '423'
        description: Locked status code
      - name: FailedDependency
        value: '424'
        description: FailedDependency status code
      - name: TooManyRequests
        value: '429'
        description: TooManyRequests status code
      - name: InternalServerError
        value: '500'
        description: InternalServerError status code
      - name: NotImplemented
        value: '501'
        description: NotImplemented status code
      - name: BadGateway
        value: '502'
        description: BadGateway status code
      - name: ServiceUnavailable
        value: '503'
        description: ServiceUnavailable status code
      - name: GatewayTimeout
        value: '504'
        description: GatewayTimeout status code
      - name: HTTPVersionNotSupported
        value: '505'
        description: HTTPVersionNotSupported status code
      - name: Unknown
        value: '-1'
        description: Indicates an unknown status code
  - name: HttpResponse
    kind: wick/type/struct@v1
    description: HTTP response
    fields:
      - name: version
        type: HttpVersion
        description: HTTP version enum
      - name: status
        type: StatusCode
        description: status code enum
      - name: headers
        type: '{string: string[]}'
        description: All response headers. Supports duplicates.
  - name: HttpRequest
    kind: wick/type/struct@v1
    description: HTTP request
    fields:
      - name: method
        type: HttpMethod
        description: method from request line enum
      - name: scheme
        type: HttpScheme
        description: scheme from request line enum
      - name: authority
        type: string
        description: domain/port and any authentication from request line. optional
      - name: query_parameters
        type: '{string: string[]}'
        description: query parameters from request line. optional
      - name: path
        type: string
        description: path from request line (not including query parameters)
      - name: uri
        type: string
        description: full URI from request line
      - name: version
        type: HttpVersion
        description: HTTP version enum
      - name: headers
        type: '{string: string[]}'
        description: All request headers. Duplicates are comma separated
      - name: remote_addr
        type: string
        description: The remote address of the connected client
  - name: RequestMiddlewareResponse
    kind: wick/type/union@v1
    description: A response from pre-request middleware
    types:
      - HttpRequest
      - HttpResponse
  - name: HttpEvent
    kind: wick/type/struct@v1
    description: HTTP server side event
    fields:
      - name: event
        type: string
        description: The event name if given
      - name: data
        type: string
        description: The event data
      - name: id
        type: string
        description: The event id if given
      - name: retry
        type: u64?
        description: Retry duration if given