Skip to content
Permalink
Browse files

Fix some broken links

  • Loading branch information...
mpvl committed Aug 27, 2019
1 parent cc3f04d commit bff75805e0839f6dd29b48e04048e53e25504f8e
@@ -22,9 +22,7 @@ can be downloaded from
In addition, CUE can be installed with using brew on MacOS and Linux:

```
brew tap cuelang/homebrew-tap
brew install cue
brew install cuelang/tap/cue
```


@@ -17,7 +17,7 @@ The CUE APIs in the main repo are organized as follows:
- [**cue**](https://godoc.org/cuelang.org/go/cue):
core APIs related to parsing, formatting, loading and running CUE programs.
These packages are used by all other packages, including the command line tool.
- [**doc**](https://godoc.org/cuelang.org/go/doc):
- [**doc**](https://github.com/cuelang/cue/tree/master/doc):
[CUE documentation](/docs/references),
including tutorials and the reference manual.
- [**encoding**](https://godoc.org/cuelang.org/go/encoding):
@@ -43,4 +43,4 @@ The `cuelang.org/go/encoding/openapi` package outputs it in this form
if expansion of references is requested.

This topic has been covered in more detail in the
[OpenAPI and CRDs](./openapi.md) section.
[OpenAPI and CRDs](/docs/integrations/openapi) section.
@@ -6,7 +6,7 @@ description = "How CUE integrates with OpenOPI, an API description format for RE

OpenAPI is a standard for the description of REST APIs.
Describing value schema is one aspect of this.
In the [Data Definition](/docs/comparison/datadef) section we already
In the [Schema Definition](/docs/usecases/datadef) section we already
talked about the relationship between CUE and OpenAPI.

One aspect of OpenAPI is to define data schema.
@@ -25,8 +25,10 @@ to generate OpenAPI build on this API.

Generating an OpenAPI definition can be as simple as
{{< highlight go >}}
import "cuelang.org/go/encoding/openapi"

func genOpenAPI(inst *cue.Instance) (b []byte, error) {
b, err := Gen(inst, nil)
b, err := openapi.Gen(inst, nil)
if err != nil {
return nil, err
}
@@ -38,7 +40,8 @@ func genOpenAPI(inst *cue.Instance) (b []byte, error) {
{{< /highlight >}}
The package provides options to make a definition self-contained,
The [cuelang.org/go/encoding/openapi](https://godoc.org/cuelang.org/go/encoding/openapi)
package provides options to make a definition self-contained,
expand references, filtering constraints, and so on.
If expanding references is selected it will ensure the output is

0 comments on commit bff7580

Please sign in to comment.
You can’t perform that action at this time.