this repo has no description
1// Copyright 2023 CUE Authors
2//
3// Licensed under the Apache License, Version 2.0 (the "License");
4// you may not use this file except in compliance with the License.
5// You may obtain a copy of the License at
6//
7// http://www.apache.org/licenses/LICENSE-2.0
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14
15package openapi
16
17// #Config represents options for generating OpenAPI.
18#Config: {
19 // version is fixed to 3.0.0 for now.
20 version!: "3.0.0"
21
22 info?: #Info
23
24 // selfContained causes all non-expanded external references to be included
25 // in this document.
26 selfContained: bool | *false
27
28 // expandReferences replaces references with actual objects when generating
29 // OpenAPI Schema. It is an error for an CUE value to refer to itself
30 // if this option is used.
31 expandReferences: bool | *false
32}
33
34// #Info represents metadata about the API.
35#Info: {
36 title!: string
37 version!: string
38 summary?: string
39 description?: string
40 termsOfService?: string
41 contact?: #Contact
42 license?: #License
43}
44
45// #Contact represents contact information for the exposed API.
46#Contact: {
47 name?: string
48 url?: string
49 email?: string
50}
51
52// #License represents license information for the exposed API.
53#License: {
54 name!: string
55 url?: string
56}