Packages > pkg.pkl-lang.org/pkl-pantry/org.openapis.v3

org.openapis.v3.HTTPResponse2.1.2

Properties
Methods
Type Aliases

module org.openapis.v3.HTTPResponse

Describes a single response from an API Operation, including design-time, static links to operations based on the response.

Module URI:: package://pkg.pkl-lang.org/pkl-pantry/org.openapis.v3@2.1.2#/HTTPResponse.pkl
Source code:: HTTPResponse.pkl
Known subtypes:
Known usages:
All versions:

Properties(show inherited)

link

hidden

output: ModuleOutput (pkl.base)Source

The output of this module.

Defaults to all module properties rendered as either Pcf or the format specified on the command line.
link

Continue: "100"Source

This interim response indicates that the client should continue the request or ignore the response if the request is already finished.
link

SwitchingProtocols: "101"Source

This code is sent in response to an Upgrade request header from the client and indicates the protocol the server is switching to.
link

Processing: "102"Source

This code indicates that the server has received and is processing the request, but no response is available yet.
link

EarlyHints: "103"Source

This status code is primarily intended to be used with the Link header, letting the user agent start preloading resources while the server prepares a response or preconnect to an origin from which the page will need resources.
link
OK: "200"Source

The request succeeded. The result meaning of "success" depends on the HTTP method:
- GET: The resource has been fetched and transmitted in the message body.
- HEAD: The representation headers are included in the response without any message body.
- PUT or POST: The resource describing the result of the action is transmitted in the message body.
- TRACE: The message body contains the request message as received by the server.
link

Created: "201"Source

The request succeeded, and a new resource was created as a result.

This is typically the response sent after POST requests, or some PUT requests.
link

Accepted: "202"Source

The request has been received but not yet acted upon. It is noncommittal, since there is no way in HTTP to later send an asynchronous response indicating the outcome of the request.

It is intended for cases where another process or server handles the request, or for batch processing.
link

NonAuthoritativeInformation: "203"Source

This response code means the returned metadata is not exactly the same as is available from the origin server, but is collected from a local or a third-party copy. This is mostly used for mirrors or backups of another resource.

Except for that specific case, the 200 OK response is preferred to this status.
link

NoContent: "204"Source

There is no content to send for this request, but the headers may be useful.

The user agent may update its cached headers for this resource with the new ones.
link

ResetContent: "205"Source

Tells the user agent to reset the document which sent this request.
link

PartialContent: "206"Source

This response code is used when the Range header is sent from the client to request only part of a resource.
link

MultiStatus: "207"Source

Conveys information about multiple resources, for situations where multiple status codes might be appropriate.
link

AlreadyReported: "208"Source

Used inside a dav:propstat response element to avoid repeatedly enumerating the internal members of multiple bindings to the same collection.
link

IMUsed: "226"Source

The server has fulfilled a GET request for the resource, and the response is a representation of the result of one or more instance-manipulations applied to the current instance.
link

MultipleChoices: "300"Source

The request has more than one possible response. The user agent or user should choose one of them.

There is no standardized way of choosing one of the responses, but HTML links to the possibilities are recommended so the user can pick.
link

MovedPermanently: "301"Source

The URL of the requested resource has been changed permanently.

The new URL is given in the response.
link

Found: "302"Source

This response code means that the URI of requested resource has been changed temporarily.

Further changes in the URI might be made in the future. Therefore, this same URI should be used by the client in future requests.
link

SeeOther: "303"Source

The server sent this response to direct the client to get the requested resource at another URI with a GET request.
link

NotModified: "304"Source

This is used for caching purposes.

It tells the client that the response has not been modified, so the client can continue to use the same cached version of the response.
link

UseProxy: "305"Source

Defined in a previous version of the HTTP specification to indicate that a requested response must be accessed by a proxy.

It has been deprecated due to security concerns regarding in-band configuration of a proxy.
link

TemporaryRedirect: "307"Source

The server sends this response to direct the client to get the requested resource at another URI with the same method that was used in the prior request.

This has the same semantics as the 302 Found HTTP response code, with the exception that the user agent must not change the HTTP method used: if a POST was used in the first request, a POST must be used in the second request.
link

PermanentRedirect: "308"Source

This means that the resource is now permanently located at another URI, specified by the Location: HTTP Response header.

This has the same semantics as the 301 Moved Permanently HTTP response code, with the exception that the user agent must not change the HTTP method used: if a POST was used in the first request, a POST must be used in the second request.
link

BadRequest: "400"Source

The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing).
link

Unauthorized: "401"Source

Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated".

That is, the client must authenticate itself to get the requested response.
link

PaymentRequired: "402"Source

This response code is reserved for future use.

The initial aim for creating this code was using it for digital payment systems, however this status code is used very rarely and no standard convention exists.
link

Forbidden: "403"Source

The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource.

Unlike 401 Unauthorized, the client's identity is known to the server.
link

NotFound: "404"Source

The server cannot find the requested resource.

In the browser, this means the URL is not recognized. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 Forbidden to hide the existence of a resource from an unauthorized client. This response code is probably the most well known due to its frequent occurrence on the web.
link

MethodNotAllowed: "405"Source

The request method is known by the server but is not supported by the target resource.

For example, an API may not allow calling DELETE to remove a resource.
link

NotAcceptable: "406"Source

This response is sent when the web server, after performing server-driven content negotiation, doesn't find any content that conforms to the criteria given by the user agent.
link

ProxyAuthenticationRequired: "407"Source

This is similar to 401 Unauthorized but authentication is needed to be done by a proxy.
link

RequestTimeout: "408"Source

This response is sent on an idle connection by some servers, even without any previous request by the client.

It means that the server would like to shut down this unused connection. This response is used much more since some browsers, like Chrome, Firefox 27+, or IE9, use HTTP pre-connection mechanisms to speed up surfing. Also note that some servers merely shut down the connection without sending this message.
link

Conflict: "409"Source

This response is sent when a request conflicts with the current state of the server.
link

Gone: "410"Source

This response is sent when the requested content has been permanently deleted from server, with no forwarding address.

Clients are expected to remove their caches and links to the resource. The HTTP specification intends this status code to be used for "limited-time, promotional services". APIs should not feel compelled to indicate resources that have been deleted with this status code.
link

LengthRequired: "411"Source

Server rejected the request because the Content-Length header field is not defined and the server requires it.
link

PreconditionFailed: "412"Source

The client has indicated preconditions in its headers which the server does not meet.
link

PayloadTooLarge: "413"Source

Request entity is larger than limits defined by server.

The server might close the connection or return an Retry-After header field.
link

URITooLong: "414"Source

The URI requested by the client is longer than the server is willing to interpret.
link

UnsupportedMediaType: "415"Source

The media format of the requested data is not supported by the server, so the server is rejecting the request.
link

RangeNotSatisfiable: "416"Source

The range specified by the Range header field in the request cannot be fulfilled.

It's possible that the range is outside the size of the target URI's data.
link

ExpectationFailed: "417"Source

This response code means the expectation indicated by the Expect request header field cannot be met by the server.
link

Teapot: "418"Source

The server refuses the attempt to brew coffee with a teapot.

Context: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/418
link

MisdirectedRequest: "421"Source

The request was directed at a server that is not able to produce a response.

This can be sent by a server that is not configured to produce responses for the combination of scheme and authority that are included in the request URI.
link

UnprocessableContent: "422"Source

The request was well-formed but was unable to be followed due to semantic errors.
link

Locked: "423"Source

The resource that is being accessed is locked.
link

FailedDependency: "424"Source

The request failed due to failure of a previous request.
link

TooEarly: "425"Source

Indicates that the server is unwilling to risk processing a request that might be replayed.
link

UpgradeRequired: "426"Source

The server refuses to perform the request using the current protocol but might be willing to do so after the client upgrades to a different protocol.

The server sends an Upgrade header in a 426 response to indicate the required protocol(s).
link

PreconditionRequired: "428"Source

The origin server requires the request to be conditional.

This response is intended to prevent the 'lost update' problem, where a client GETs a resource's state, modifies it and PUTs it back to the server, when meanwhile a third party has modified the state on the server, leading to a conflict.
link

TooManyRequests: "429"Source

The user has sent too many requests in a given amount of time ("rate limiting").
link

RequestHeaderFieldsTooLarge: "431"Source

The server is unwilling to process the request because its header fields are too large.

The request may be resubmitted after reducing the size of the request header fields.
link

UnavailableForLegalReasons: "451"Source

The user agent requested a resource that cannot legally be provided, such as a web page censored by a government.
link

InternalServerError: "500"Source

The server has encountered a situation it does not know how to handle.
link

NotImplemented: "501"Source

The request method is not supported by the server and cannot be handled.

The only methods that servers are required to support (and therefore that must not return this code) are GET and HEAD.
link

BadGateway: "502"Source

This error response means that the server, while working as a gateway to get a response needed to handle the request, got an invalid response.
link

ServiceUnavailable: "503"Source

The server is not ready to handle the request.

Common causes are a server that is down for maintenance or that is overloaded. Note that together with this response, a user-friendly page explaining the problem should be sent. This response should be used for temporary conditions and the Retry-After HTTP header should, if possible, contain the estimated time before the recovery of the service. The webmaster must also take care about the caching-related headers that are sent along with this response, as these temporary condition responses should usually not be cached.
link

GatewayTimeout: "504"Source

This error response is given when the server is acting as a gateway and cannot get a response in time.
link

HTTPVersionNotSupported: "505"Source

The HTTP version used in the request is not supported by the server.
link

VariantAlsoNegotiates: "506"Source

The server has an internal configuration error: the chosen variant resource is configured to engage in transparent content negotiation itself, and is therefore not a proper end point in the negotiation process.
link

InsufficientStorage: "507"Source

The method could not be performed on the resource because the server is unable to store the representation needed to successfully complete the request.
link

LoopDetected: "508"Source

The server detected an infinite loop while processing the request.
link

NotExtended: "510"Source

Further extensions to the request are required for the server to fulfill it.
link

NetworkAuthenticationRequired: "511"Source

Indicates that the client needs to authenticate to gain network access.

Methods(show inherited)

link

function

getClass(): Class (pkl.base)Source

Returns the class of this.
link

function

toString(): String (pkl.base)Source

Returns a string representation of this.

This method is used to convert the values of string interpolation expressions to strings.
link

function

ifNonNull<Result>(transform: (NonNull) -> Result): Result? (pkl.base)Source

Returns this |> transform if this is non-null, and null otherwise.

This method is the complement of the ?? operator and the equivalent of an Option type's map and flatMap methods.
link

function

hasProperty(name: String): Boolean (pkl.base)Source

Tells if this object has a property with the given name.
link

function

getProperty(name: String): unknown (pkl.base)Source

Returns the value of the property with the given name.

Throws if a property with this name does not exist.
link

function

getPropertyOrNull(name: String): unknown? (pkl.base)Source

Returns the value of the property with the given name.

Returns null if a property with this name does not exist.
link

function

toDynamic(): Dynamic (pkl.base)Source

Converts this object to a Dynamic object.
link

function

toMap(): Map<String, unknown> (pkl.base)Source

Converts this object to a Map.
link

function
relativePathTo(other: Module): List<String> (pkl.base)Source

Returns the relative, descendent directory path between this module and other.
Throws if no such path exists.

For example, if module mod1 has path /dir1/mod1.pkl, and module mod2 has path /dir1/dir2/dir3/mod2.pkl, then mod1.relativePathTo(mod2) will return List("dir2", "dir3").

A common use case is to compute the directory path between a template located at the root of a hierarchy (say rootModule.pkl) and the currently evaluated module (accessible via the module keyword):
```
import "rootModule.pkl" // self-import
path = rootModule.relativePathTo(module)
```

Type Aliases

link

typealias

Code = "100"|"101"|"102"|"103"|"200"|"201"|"202"|"203"|"204"|"205"|"206"|"207"|"208"|"226"|"300"|"301"|"302"|"303"|"304"|"305"|"307"|"308"|"400"|"401"|"402"|"403"|"404"|"405"|"406"|"407"|"408"|"409"|"410"|"411"|"412"|"413"|"414"|"415"|"416"|"417"|"418"|"421"|"422"|"423"|"424"|"425"|"426"|"427"|"428"|"429"|"431"|"451"|"500"|"501"|"502"|"503"|"504"|"505"|"506"|"507"|"508"|"510"|"511"Source

String matching a given standard HTTP response code.

This typealias allows us to restrict API definitions to responding to HTTP response codes that actually exist in the HTTP specification.

Context: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status
link

typealias

CodeWildcard = "1XX"|"2XX"|"3XX"|"4XX"|"5XX"Source

Only these wildcard strings are allowed to be used as operation response keys.