forked from OpenAPITools/openapi-generator
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[Go] fix unused bytes import for anyOf and oneOf models (OpenAPITools…
…#17775) * add sample spec for oneof and anyof with required properties * omit bytes import for oneOf and anyOf models * generate sample client for new spec
- Loading branch information
Showing
49 changed files
with
5,062 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
generatorName: go | ||
outputDir: samples/client/others/go/oneof-anyof-required | ||
inputSpec: modules/openapi-generator/src/test/resources/3_0/go/spec-with-oneof-anyof-required.yaml | ||
additionalProperties: | ||
hideGenerationTimestamp: "true" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
29 changes: 29 additions & 0 deletions
29
modules/openapi-generator/src/test/resources/3_0/go/spec-with-oneof-anyof-required.yaml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
openapi: 3.0.0 | ||
info: | ||
title: Test | ||
version: 1.0.0 | ||
paths: {} | ||
components: | ||
schemas: | ||
NestedObject1: | ||
required: | ||
- field1 | ||
properties: | ||
field1: | ||
description: Specifies an action name to be used with the Android Intent class. | ||
type: string | ||
NestedObject2: | ||
required: | ||
- field2 | ||
properties: | ||
field2: | ||
description: Specifies an action name to be used with the Android Intent class. | ||
type: string | ||
Object: | ||
oneOf: | ||
- $ref: '#/components/schemas/NestedObject1' | ||
- $ref: '#/components/schemas/NestedObject2' | ||
Object2: | ||
anyOf: | ||
- $ref: '#/components/schemas/NestedObject1' | ||
- $ref: '#/components/schemas/NestedObject2' |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
# Compiled Object files, Static and Dynamic libs (Shared Objects) | ||
*.o | ||
*.a | ||
*.so | ||
|
||
# Folders | ||
_obj | ||
_test | ||
|
||
# Architecture specific extensions/prefixes | ||
*.[568vq] | ||
[568vq].out | ||
|
||
*.cgo1.go | ||
*.cgo2.c | ||
_cgo_defun.c | ||
_cgo_gotypes.go | ||
_cgo_export.* | ||
|
||
_testmain.go | ||
|
||
*.exe | ||
*.test | ||
*.prof |
23 changes: 23 additions & 0 deletions
23
samples/client/others/go/oneof-anyof-required/.openapi-generator-ignore
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
# OpenAPI Generator Ignore | ||
# Generated by openapi-generator https://github.com/openapitools/openapi-generator | ||
|
||
# Use this file to prevent files from being overwritten by the generator. | ||
# The patterns follow closely to .gitignore or .dockerignore. | ||
|
||
# As an example, the C# client generator defines ApiClient.cs. | ||
# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line: | ||
#ApiClient.cs | ||
|
||
# You can match any string of characters against a directory, file or extension with a single asterisk (*): | ||
#foo/*/qux | ||
# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux | ||
|
||
# You can recursively match patterns against a directory, file or extension with a double asterisk (**): | ||
#foo/**/qux | ||
# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux | ||
|
||
# You can also negate patterns with an exclamation (!). | ||
# For example, you can ignore all files in a docs folder with the file extension .md: | ||
#docs/*.md | ||
# Then explicitly reverse the ignore rule for a single file: | ||
#!docs/README.md |
19 changes: 19 additions & 0 deletions
19
samples/client/others/go/oneof-anyof-required/.openapi-generator/FILES
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
.gitignore | ||
.travis.yml | ||
README.md | ||
api/openapi.yaml | ||
client.go | ||
configuration.go | ||
docs/NestedObject1.md | ||
docs/NestedObject2.md | ||
docs/Object.md | ||
docs/Object2.md | ||
git_push.sh | ||
go.mod | ||
go.sum | ||
model_nested_object1.go | ||
model_nested_object2.go | ||
model_object.go | ||
model_object2.go | ||
response.go | ||
utils.go |
1 change: 1 addition & 0 deletions
1
samples/client/others/go/oneof-anyof-required/.openapi-generator/VERSION
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
7.3.0-SNAPSHOT |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
language: go | ||
|
||
install: | ||
- go get -d -v . | ||
|
||
script: | ||
- go build -v ./ | ||
|
113 changes: 113 additions & 0 deletions
113
samples/client/others/go/oneof-anyof-required/README.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,113 @@ | ||
# Go API client for openapi | ||
|
||
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) | ||
|
||
## Overview | ||
This API client was generated by the [OpenAPI Generator](https://openapi-generator.tech) project. By using the [OpenAPI-spec](https://www.openapis.org/) from a remote server, you can easily generate an API client. | ||
|
||
- API version: 1.0.0 | ||
- Package version: 1.0.0 | ||
- Build package: org.openapitools.codegen.languages.GoClientCodegen | ||
|
||
## Installation | ||
|
||
Install the following dependencies: | ||
|
||
```sh | ||
go get github.com/stretchr/testify/assert | ||
go get golang.org/x/net/context | ||
``` | ||
|
||
Put the package under your project folder and add the following in import: | ||
|
||
```go | ||
import openapi "github.com/GIT_USER_ID/GIT_REPO_ID" | ||
``` | ||
|
||
To use a proxy, set the environment variable `HTTP_PROXY`: | ||
|
||
```go | ||
os.Setenv("HTTP_PROXY", "http://proxy_name:proxy_port") | ||
``` | ||
|
||
## Configuration of Server URL | ||
|
||
Default configuration comes with `Servers` field that contains server objects as defined in the OpenAPI specification. | ||
|
||
### Select Server Configuration | ||
|
||
For using other server than the one defined on index 0 set context value `openapi.ContextServerIndex` of type `int`. | ||
|
||
```go | ||
ctx := context.WithValue(context.Background(), openapi.ContextServerIndex, 1) | ||
``` | ||
|
||
### Templated Server URL | ||
|
||
Templated server URL is formatted using default variables from configuration or from context value `openapi.ContextServerVariables` of type `map[string]string`. | ||
|
||
```go | ||
ctx := context.WithValue(context.Background(), openapi.ContextServerVariables, map[string]string{ | ||
"basePath": "v2", | ||
}) | ||
``` | ||
|
||
Note, enum values are always validated and all unused variables are silently ignored. | ||
|
||
### URLs Configuration per Operation | ||
|
||
Each operation can use different server URL defined using `OperationServers` map in the `Configuration`. | ||
An operation is uniquely identified by `"{classname}Service.{nickname}"` string. | ||
Similar rules for overriding default operation server index and variables applies by using `openapi.ContextOperationServerIndices` and `openapi.ContextOperationServerVariables` context maps. | ||
|
||
```go | ||
ctx := context.WithValue(context.Background(), openapi.ContextOperationServerIndices, map[string]int{ | ||
"{classname}Service.{nickname}": 2, | ||
}) | ||
ctx = context.WithValue(context.Background(), openapi.ContextOperationServerVariables, map[string]map[string]string{ | ||
"{classname}Service.{nickname}": { | ||
"port": "8443", | ||
}, | ||
}) | ||
``` | ||
|
||
## Documentation for API Endpoints | ||
|
||
All URIs are relative to *http://localhost* | ||
|
||
Class | Method | HTTP request | Description | ||
------------ | ------------- | ------------- | ------------- | ||
|
||
|
||
## Documentation For Models | ||
|
||
- [NestedObject1](docs/NestedObject1.md) | ||
- [NestedObject2](docs/NestedObject2.md) | ||
- [Object](docs/Object.md) | ||
- [Object2](docs/Object2.md) | ||
|
||
|
||
## Documentation For Authorization | ||
|
||
Endpoints do not require authorization. | ||
|
||
|
||
## Documentation for Utility Methods | ||
|
||
Due to the fact that model structure members are all pointers, this package contains | ||
a number of utility functions to easily obtain pointers to values of basic types. | ||
Each of these functions takes a value of the given basic type and returns a pointer to it: | ||
|
||
* `PtrBool` | ||
* `PtrInt` | ||
* `PtrInt32` | ||
* `PtrInt64` | ||
* `PtrFloat` | ||
* `PtrFloat32` | ||
* `PtrFloat64` | ||
* `PtrString` | ||
* `PtrTime` | ||
|
||
## Author | ||
|
||
|
33 changes: 33 additions & 0 deletions
33
samples/client/others/go/oneof-anyof-required/api/openapi.yaml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,33 @@ | ||
openapi: 3.0.0 | ||
info: | ||
title: Test | ||
version: 1.0.0 | ||
servers: | ||
- url: / | ||
paths: {} | ||
components: | ||
schemas: | ||
NestedObject1: | ||
properties: | ||
field1: | ||
description: Specifies an action name to be used with the Android Intent | ||
class. | ||
type: string | ||
required: | ||
- field1 | ||
NestedObject2: | ||
properties: | ||
field2: | ||
description: Specifies an action name to be used with the Android Intent | ||
class. | ||
type: string | ||
required: | ||
- field2 | ||
Object: | ||
oneOf: | ||
- $ref: '#/components/schemas/NestedObject1' | ||
- $ref: '#/components/schemas/NestedObject2' | ||
Object2: | ||
anyOf: | ||
- $ref: '#/components/schemas/NestedObject1' | ||
- $ref: '#/components/schemas/NestedObject2' |
Oops, something went wrong.