OpenAPITools / OpenAPITools/openapi-generator

[BUG] Global Properties of apiTests & modelTests & modelDocs & apiDocs not working for openapi-generator generate -g go-server

Open
#11,070 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Issue: Bug
Dominant language
Java
Stars
26.8k
Forks
7.7k
PR merge metrics
PR metrics pending

Description

Bug Report Checklist
  • Have you provided a full/minimal spec to reproduce the issue?
  • Have you validated the input using an OpenAPI validator (example)?
  • Have you tested with the latest master to confirm the issue still exists?
  • Have you searched for related issues/PRs?
  • What's the actual output vs expected output?
Description

I would like to generate / use the following objects / functionality:

  • apiDocs | Allows the user to define if api docs will be generated.
  • modelDocs | Allows the user to define if model docs will be generated.
  • apiTests | Allows the user to define if api tests will be generated.
  • modelTests | Allows the user to define if model tests will be generated.

See: https://openapi-generator.tech/docs/globals

Sadly there is nothing generated additionally when setting all options to true.

openapi-generator version

openapi-generator version
5.3.0

OpenAPI declaration file content or url

Open API declaration used for generation: https://raw.githubusercontent.com/openservicebrokerapi/servicebroker/v2.16/openapi.yaml

Generation Details
openapi-gen-go-server-test GO_POST_PROCESS_FILE="gofmt -s -w" openapi-generator generate -g go-server  -o ./ -i openapi.yaml  -c config.yaml --global-property apiTest=true,modelTests=true,apiDocs=true,modelDocs=true 
[main] INFO  o.o.codegen.DefaultGenerator - Generating with dryRun=false
[main] INFO  o.o.c.ignore.CodegenIgnoreProcessor - No .openapi-generator-ignore file found.
[main] INFO  o.o.codegen.DefaultGenerator - OpenAPI Generator: go-server (server)
[main] INFO  o.o.codegen.DefaultGenerator - Generator 'go-server' is considered stable.
[main] INFO  o.o.codegen.DefaultGenerator - Model Context not generated since it's a free-form object
[main] INFO  o.o.codegen.DefaultGenerator - Model Metadata not generated since it's a free-form object
[main] INFO  o.o.codegen.DefaultGenerator - Model Object not generated since it's a free-form object
[main] INFO  o.o.codegen.TemplateManager - writing file /Users/..../go/src/openapi-gen-go-server-test/./go/model_async_operation.go
[main] INFO  o.o.codegen.TemplateManager - writing file /Users/..../go/src/openapi-gen-go-server-test/./go/model_catalog.go
[main] INFO  o.o.codegen.TemplateManager - writing file /Users/..../go/src/openapi-gen-go-server-test/./go/model_dashboard_client.go
[main] INFO  o.o.codegen.TemplateManager - writing file /Users/..../go/src/openapi-gen-go-server-test/./go/model_error.go
[main] INFO  o.o.codegen.TemplateManager - writing file /Users/..../go/src/openapi-gen-go-server-test/./go/model_last_operation_resource.go
[main] INFO  o.o.codegen.TemplateManager - writing file /Users/..../go/src/openapi-gen-go-server-test/./go/model_maintenance_info.go
[main] INFO  o.o.codegen.TemplateManager - writing file /Users/..../go/src/openapi-gen-go-server-test/./go/model_plan.go
[main] INFO  o.o.codegen.TemplateManager - writing file /Users/..../go/src/openapi-gen-go-server-test/./go/model_schemas.go
[main] INFO  o.o.codegen.TemplateManager - writing file /Users/..../go/src/openapi-gen-go-server-test/./go/model_service.go
[main] INFO  o.o.codegen.TemplateManager - writing file /Users/..../go/src/openapi-gen-go-server-test/./go/model_service_binding_endpoint.go
[main] INFO  o.o.codegen.TemplateManager - writing file /Users/..../go/src/openapi-gen-go-server-test/./go/model_service_binding_metadata.go
[main] INFO  o.o.codegen.TemplateManager - writing file /Users/..../go/src/openapi-gen-go-server-test/./go/model_service_binding_request.go
[main] INFO  o.o.codegen.TemplateManager - writing file /Users/..../go/src/openapi-gen-go-server-test/./go/model_service_binding_resouce_object.go
[main] INFO  o.o.codegen.TemplateManager - writing file /Users/..../go/src/openapi-gen-go-server-test/./go/model_service_binding_resource.go
[main] INFO  o.o.codegen.TemplateManager - writing file /Users/..../go/src/openapi-gen-go-server-test/./go/model_service_binding_response.go
[main] INFO  o.o.codegen.TemplateManager - writing file /Users/..../go/src/openapi-gen-go-server-test/./go/model_service_binding_schema.go
[main] INFO  o.o.codegen.TemplateManager - writing file /Users/..../go/src/openapi-gen-go-server-test/./go/model_service_binding_volume_mount.go
[main] INFO  o.o.codegen.TemplateManager - writing file /Users/..../go/src/openapi-gen-go-server-test/./go/model_service_binding_volume_mount_device.go
[main] INFO  o.o.codegen.TemplateManager - writing file /Users/..../go/src/openapi-gen-go-server-test/./go/model_service_instance_async_operation.go
[main] INFO  o.o.codegen.TemplateManager - writing file /Users/..../go/src/openapi-gen-go-server-test/./go/model_service_instance_metadata.go
[main] INFO  o.o.codegen.TemplateManager - writing file /Users/..../go/src/openapi-gen-go-server-test/./go/model_service_instance_previous_values.go
[main] INFO  o.o.codegen.TemplateManager - writing file /Users/..../go/src/openapi-gen-go-server-test/./go/model_service_instance_provision_request_body.go
[main] INFO  o.o.codegen.TemplateManager - writing file /Users/..../go/src/openapi-gen-go-server-test/./go/model_service_instance_provision_response.go
[main] INFO  o.o.codegen.TemplateManager - writing file /Users/..../go/src/openapi-gen-go-server-test/./go/model_service_instance_resource.go
[main] INFO  o.o.codegen.TemplateManager - writing file /Users/..../go/src/openapi-gen-go-server-test/./go/model_service_instance_schema.go
[main] INFO  o.o.codegen.TemplateManager - writing file /Users/..../go/src/openapi-gen-go-server-test/./go/model_service_instance_schema_create.go
[main] INFO  o.o.codegen.TemplateManager - writing file /Users/..../go/src/openapi-gen-go-server-test/./go/model_service_instance_update_request_body.go
[main] INFO  o.o.codegen.TemplateManager - writing file /Users/..../go/src/openapi-gen-go-server-test/./go/api_catalog.go
[main] INFO  o.o.codegen.TemplateManager - writing file /Users/..../go/src/openapi-gen-go-server-test/./go/api_catalog_service.go
[main] INFO  o.o.codegen.TemplateManager - writing file /Users/..../go/src/openapi-gen-go-server-test/./go/api_service_bindings.go
[main] INFO  o.o.codegen.TemplateManager - writing file /Users/..../go/src/openapi-gen-go-server-test/./go/api_service_bindings_service.go
[main] INFO  o.o.codegen.TemplateManager - writing file /Users/..../go/src/openapi-gen-go-server-test/./go/api_service_instances.go
[main] INFO  o.o.codegen.TemplateManager - writing file /Users/..../go/src/openapi-gen-go-server-test/./go/api_service_instances_service.go
[main] INFO  o.o.codegen.TemplateManager - writing file /Users/..../go/src/openapi-gen-go-server-test/./api/openapi.yaml
[main] INFO  o.o.codegen.TemplateManager - writing file /Users/..../go/src/openapi-gen-go-server-test/./main.go
[main] INFO  o.o.codegen.TemplateManager - writing file /Users/..../go/src/openapi-gen-go-server-test/./Dockerfile
[main] INFO  o.o.codegen.TemplateManager - writing file /Users/..../go/src/openapi-gen-go-server-test/./go.mod
[main] INFO  o.o.codegen.TemplateManager - writing file /Users/..../go/src/openapi-gen-go-server-test/./go/routers.go
[main] INFO  o.o.codegen.TemplateManager - writing file /Users/..../go/src/openapi-gen-go-server-test/./go/logger.go
[main] INFO  o.o.codegen.TemplateManager - writing file /Users/..../go/src/openapi-gen-go-server-test/./go/impl.go
[main] INFO  o.o.codegen.TemplateManager - writing file /Users/..../go/src/openapi-gen-go-server-test/./go/helpers.go
[main] INFO  o.o.codegen.TemplateManager - writing file /Users/..../go/src/openapi-gen-go-server-test/./go/api.go
[main] INFO  o.o.codegen.TemplateManager - writing file /Users/..../go/src/openapi-gen-go-server-test/./go/error.go
[main] INFO  o.o.codegen.TemplateManager - writing file /Users/..../go/src/openapi-gen-go-server-test/./README.md
[main] INFO  o.o.codegen.TemplateManager - writing file /Users/..../go/src/openapi-gen-go-server-test/./.openapi-generator-ignore
[main] INFO  o.o.codegen.TemplateManager - writing file /Users/..../go/src/openapi-gen-go-server-test/./.openapi-generator/VERSION
[main] INFO  o.o.codegen.TemplateManager - writing file /Users/..../go/src/openapi-gen-go-server-test/./.openapi-generator/FILES
################################################################################
# Thanks for using OpenAPI Generator.                                          #
# Please consider donation to help us maintain this project 🙏                 #
# https://opencollective.com/openapi_generator/donate                          #
################################################################################

config.yaml content

addResponseHeaders: true
hideGenerationTimestamp: false
packageVersion: "1.17"
# global
verbose: false
apiDocs: true
modelDocs: true
apiTests: true
modelTests: true
Steps to reproduce

GO_POST_PROCESS_FILE="gofmt -s -w" openapi-generator generate -g go-server -o ./ -i openapi.yaml -c config.yaml --global-property apiTest=true,modelTests=true,apiDocs=true,modelDocs=true

Open API declaration used for generation: https://raw.githubusercontent.com/openservicebrokerapi/servicebroker/v2.16/openapi.yaml

config.yaml content

addResponseHeaders: true
hideGenerationTimestamp: false
packageVersion: "1.17"
# global
verbose: false
apiDocs: true
modelDocs: true
apiTests: true
modelTests: true
Related issues/PRs
Suggest a fix

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reproducing the issue with the documented openapi-generator generate command, config.yaml, and the linked openapi.yaml using the go-server generator. Inspect how the four global properties are consumed during generation and verify the result against the expected API and model documentation and test outputs.

Written by the indexing model from the issue text.

Assessment

Tech stack
go, java
Domain
tooling
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.