Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[typescript] Generate documentation and examples #9413

Merged

Conversation

NouemanKHAL
Copy link
Contributor

@NouemanKHAL NouemanKHAL commented May 5, 2021

PR checklist

  • Read the contribution guidelines.
  • Pull Request title clearly describes the work in the pull request and Pull Request description provides details about how to validate the work. Missing information here may result in delayed response from the community.
  • Run the following to build the project and update samples:
    ./mvnw clean package 
    ./bin/generate-samples.sh
    ./bin/utils/export_docs_generators.sh
    
    Commit all changed files.
    This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master.
    These must match the expectations made by your contribution.
    You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example ./bin/generate-samples.sh bin/configs/java*.
    For Windows users, please run the script in Git BASH.
  • File the PR against the correct branch: master, 5.1.x, 6.0.x
  • If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

@NouemanKHAL NouemanKHAL force-pushed the noueman/typescript-doc-generation branch from 462f9bb to 4222aeb Compare May 5, 2021 23:40
@NouemanKHAL NouemanKHAL marked this pull request as draft May 6, 2021 00:10
@NouemanKHAL NouemanKHAL marked this pull request as ready for review May 6, 2021 02:29
@NouemanKHAL NouemanKHAL force-pushed the noueman/typescript-doc-generation branch 2 times, most recently from 74385c4 to f25fe51 Compare May 6, 2021 02:42
@NouemanKHAL NouemanKHAL marked this pull request as draft May 6, 2021 03:20
@NouemanKHAL NouemanKHAL force-pushed the noueman/typescript-doc-generation branch from f25fe51 to 4e24bbc Compare May 6, 2021 03:40

Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**tags** | [**Array<string>**](string.md)| Tags to filter by | defaults to undefined
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

string.md probably doesn't exist, need to check for basic types.

@NouemanKHAL NouemanKHAL marked this pull request as ready for review May 10, 2021 21:22
@NouemanKHAL NouemanKHAL marked this pull request as draft May 10, 2021 21:22
@NouemanKHAL NouemanKHAL reopened this May 10, 2021
Copy link
Contributor

@therve therve left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, some minor improvements.

@NouemanKHAL NouemanKHAL force-pushed the noueman/typescript-doc-generation branch 2 times, most recently from 8f8a109 to c993952 Compare May 11, 2021 17:00
@NouemanKHAL NouemanKHAL marked this pull request as ready for review May 12, 2021 09:41
@NouemanKHAL NouemanKHAL force-pushed the noueman/typescript-doc-generation branch from c993952 to a9509a5 Compare May 12, 2021 09:48
@NouemanKHAL
Copy link
Contributor Author

@NouemanKHAL NouemanKHAL marked this pull request as draft May 17, 2021 08:42
@NouemanKHAL NouemanKHAL marked this pull request as ready for review May 17, 2021 08:43
@NouemanKHAL NouemanKHAL force-pushed the noueman/typescript-doc-generation branch 2 times, most recently from fb475dd to 0aa52d2 Compare May 19, 2021 22:57
@NouemanKHAL NouemanKHAL force-pushed the noueman/typescript-doc-generation branch 2 times, most recently from b72293a to b4ffffb Compare May 23, 2021 16:45
@NouemanKHAL NouemanKHAL force-pushed the noueman/typescript-doc-generation branch from b4ffffb to 5c7e104 Compare May 23, 2021 18:09
@NouemanKHAL NouemanKHAL changed the title Generate TypeScript Docs and Examples [typescript] Generate documentation and examples May 26, 2021
@NouemanKHAL
Copy link
Contributor Author

I guess the CI is good now, can anyone take a look please?
@TiFu @taxpon @sebastianhaas @kenisteward @Vrolijkx @macjohnny @topce @akehir @petejohansonxo @amakhrov

@TiFu TiFu merged commit 624b6a7 into OpenAPITools:master Jun 12, 2021
@TiFu
Copy link
Contributor

TiFu commented Jun 12, 2021

Looks good to me - Circleci failure is unrelated.

Thank you for the PR!

TiFu added a commit that referenced this pull request Jun 12, 2021
@TiFu
Copy link
Contributor

TiFu commented Jun 12, 2021

@wing328 TS-TC: Could you please shed some light on the below error? I am getting some workflow error that I can't really pin-point to this PR:
https://github.com/OpenAPITools/openapi-generator/runs/2808884555

CC
@TiFu (2017/07) @taxpon (2017/07) @sebastianhaas (2017/07) @kenisteward (2017/07) @Vrolijkx (2017/09) @macjohnny (2018/01) @topce (2018/10) @akehir (2019/07) @petejohansonxo (2019/11) @amakhrov (2020/02)

1s
Run actions/[email protected]
Starting download for artifact
Directory structure has been setup for the artifact
Total number of files that will be downloaded: 1
Artifact artifact was downloaded to /home/runner/work/openapi-generator/openapi-generator
Artifact download has finished successfully
0s
Run git config --global core.fileMode false
  git config --global core.fileMode false
  git config --global core.safecrlf false
  git config --global core.autocrlf true
  mkdir -p modules/openapi-generator-cli/target/
  mv artifact/openapi-generator-cli.jar modules/openapi-generator-cli/target/
  ./bin/utils/ensure-up-to-date 
  shell: /usr/bin/bash --noprofile --norc -e -o pipefail {0}
mv: cannot stat 'artifact/openapi-generator-cli.jar': No such file or directory```

@lwj5
Copy link
Contributor

lwj5 commented Jun 14, 2021

This broke something:

  Exception: null
	at org.openapitools.codegen.DefaultGenerator.processOperation(DefaultGenerator.java:1145)
	at org.openapitools.codegen.DefaultGenerator.processPaths(DefaultGenerator.java:1038)
	at org.openapitools.codegen.DefaultGenerator.generateApis(DefaultGenerator.java:561)
	at org.openapitools.codegen.DefaultGenerator.generate(DefaultGenerator.java:878)
	at org.openapitools.codegen.cmd.Generate.execute(Generate.java:441)
	at org.openapitools.codegen.cmd.OpenApiGeneratorCommand.run(OpenApiGeneratorCommand.java:32)
	at org.openapitools.codegen.OpenAPIGenerator.main(OpenAPIGenerator.java:66)
Caused by: java.lang.NullPointerException
	at org.openapitools.codegen.languages.TypeScriptClientCodegen.toExampleValueRecursive(TypeScriptClientCodegen.java:1230)
	at org.openapitools.codegen.languages.TypeScriptClientCodegen.toExampleValueRecursive(TypeScriptClientCodegen.java:1077)
	at org.openapitools.codegen.languages.TypeScriptClientCodegen.toExampleValue(TypeScriptClientCodegen.java:980)
	at org.openapitools.codegen.languages.TypeScriptClientCodegen.setParameterExampleValue(TypeScriptClientCodegen.java:1464)
	at org.openapitools.codegen.DefaultCodegen.fromRequestBody(DefaultCodegen.java:6238)
	at org.openapitools.codegen.DefaultCodegen.fromOperation(DefaultCodegen.java:3855)
	at org.openapitools.codegen.DefaultGenerator.processOperation(DefaultGenerator.java:1113)
	... 6 more

Here's a dumbed-down, redacted version of my YAML. I cannot post the whole YAML as it's an internal document.

openapi: 3.0.3
info:
  title: title
  description: description
  version: 0.0.1
servers:
  - url: "{scheme}://{address}/{basePath}"
    description: description
    variables:
      scheme:
        default: http
      address:
        default: localhost
      basePath:
        default: v0
components:
  schemas:
    Base:
      type: object
      description: description
      properties:
        base:
          description: description
          type: string
    BasePlus:
      title: title
      allOf:
        - $ref: "#/components/schemas/Base"
        - type: object
          title: title
          description: description
          properties:
            basePlus:
              description: description
              type: string
paths:
  "/test":
    put:
      operationId: test
      summary: description
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/BasePlus"
      responses:
        "200":
          description: Test successfully

@TiFu
Copy link
Contributor

TiFu commented Jun 14, 2021

Many thanks! Let me revert this in the meantime.

@TiFu
Copy link
Contributor

TiFu commented Jun 16, 2021

@NouemanKHAL Could you please review and re-file (sorry!) with a fix for the spec that @lwj5 provided?

@wing328 wing328 added this to the 5.2.0 milestone Jul 9, 2021
TiFu pushed a commit that referenced this pull request Aug 7, 2021
* generate docs for typescript

* commit changed files

* Fix NullPointerException on ComposedSchema

* Fix merge issues
ekilmer added a commit to ekilmer/openapi-generator that referenced this pull request Aug 16, 2021
* master: (849 commits)
  Don't use encodeCollectionQueryParameter on maps (OpenAPITools#10116)
  Fixed the utc time issue for httpSigning auth. (OpenAPITools#10139)
  [dart][dio] Update built_value to =>8.1.0 (OpenAPITools#10122)
  Add Inquisico to list of generator users (OpenAPITools#10142)
  add my companies to README (OpenAPITools#10146)
  [C][Client] Allocate memory for the element of array when the type is number (OpenAPITools#10124)
  update samples
  Fixed typo in csharp-netcore httpclient generated code (OpenAPITools#10119)
  Typescript-angular: Added missing semi colon to interface export in `apis.ts` template file. (OpenAPITools#10121)
  Fix issue 10020: [BUG] [typescript-angular] Add "header" to reserved words (OpenAPITools#10091)
  Add missing samples for OpenAPITools#9857
  [typescript] FIX: Generate documentation and examples OpenAPITools#9413 (OpenAPITools#9857)
  Feat adds has discriminator with non empty mapping (OpenAPITools#9667)
  Add switches (authentication collections) to support files (OpenAPITools#9884)
  [dart-dio-next] improve encodeCollectionQueryParameter to handle cases where collectionFormat is null (OpenAPITools#10105)
  [go-server] Feat: add required assertions to models (OpenAPITools#10068)
  [dart2] Include request body on DELETE call (OpenAPITools#10100)
  Make php's array a primitive (OpenAPITools#10093)
  Fix typo (preffer -> prefer) (OpenAPITools#10098)
  Fix typo on rust client (OpenAPITools#10096)
  ...
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants