Response.pkl

//===----------------------------------------------------------------------===//
// Copyright © 2024-2026 Apple Inc. and the Pkl project authors. All rights reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     https://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//===----------------------------------------------------------------------===//
/// Describes a single response from an API Operation, including design-time, static links to operations based on the
/// response.
module org.openapis.v3.Response

import "Header.pkl"
import "Link.pkl"
import "MediaType.pkl"
import "Reference.pkl"

/// A short description of the response.
///
/// CommonMark syntax MAY be used for rich text representation.
@SourceCode { language = "Markdown" }
description: String

/// Maps a header name to its definition.
///
/// RFC7230 states header names are case insensitive. If a response header is defined with the name "Content-Type",
/// it SHALL be ignored.
headers: Mapping<String, *Header | Reference>?

/// A map containing descriptions of potential response payloads.
///
/// The key is a media type or media type range and the value describes it. For responses that match multiple keys,
/// only the most specific key is applicable. e.g. text/plain overrides text/*
content: Mapping<String, MediaType>?

/// A map of operations links that can be followed from the response.
///
/// The key of the map is a short name for the link, following the naming constraints of the names for Component Objects.
links: Mapping<String, *Link | Reference>?