Skip to content

Commit

Permalink
Merge pull request #425 from kubernetes/apelisse-update-readme-notes
Browse files Browse the repository at this point in the history
Update README.md
  • Loading branch information
k8s-ci-robot committed Aug 31, 2023
2 parents 14e4089 + d020704 commit 0d7b43e
Showing 1 changed file with 7 additions and 18 deletions.
25 changes: 7 additions & 18 deletions test/integration/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,27 +29,16 @@ $ go run ../../cmd/openapi-gen/openapi-gen.go \
The generated file `pkg/generated/openapi_generated.go` should have been created.

Next, run the OpenAPI builder to create the Swagger file which includes
the definitions. The output file named `golden.v2.json` will be output in
the definitions. The output file named `golden.v2.json` (or v3) will be output in
the current directory.

---
**NOTE:**

If you've created a new type, make sure you add it in `createWebServices()` in
`./builder/main.go`, or the definitions won't be generated.
---

---
**NOTE:**

If you've created a new package, make sure you also add it to the
`inputDir` in `integration_suite_test.go`.
---

```bash
$ go run builder/main.go testdata/golden.v2.json
```

```bash
$ go run builder3/main.go testdata/golden.v3.json
```

❗NOTE❗: If you've created a new type, make sure you add it in `createWebServices()` in
`./builder/main.go`, or the definitions won't be generated.

❗NOTE❗: If you've created a new package, make sure you also add it to the
`inputDir` in `integration_suite_test.go`.

0 comments on commit 0d7b43e

Please sign in to comment.