Skip to content
GitLab
    • Explore Projects Groups Snippets
Projects Groups Snippets
  • /
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
    • Contribute to GitLab
  • Sign in / Register
  • O openapi-generator
  • Project information
    • Project information
    • Activity
    • Labels
    • Members
  • Repository
    • Repository
    • Files
    • Commits
    • Branches
    • Tags
    • Contributors
    • Graph
    • Compare
  • Issues 3,476
    • Issues 3,476
    • List
    • Boards
    • Service Desk
    • Milestones
  • Merge requests 402
    • Merge requests 402
  • CI/CD
    • CI/CD
    • Pipelines
    • Jobs
    • Schedules
  • Deployments
    • Deployments
    • Environments
    • Releases
  • Packages and registries
    • Packages and registries
    • Package Registry
    • Infrastructure Registry
  • Monitor
    • Monitor
    • Incidents
  • Analytics
    • Analytics
    • Value stream
    • CI/CD
    • Repository
  • Wiki
    • Wiki
  • Snippets
    • Snippets
  • Activity
  • Graph
  • Create a new issue
  • Jobs
  • Commits
  • Issue Boards
Collapse sidebar
  • OpenAPI Tools
  • openapi-generator
  • Merge requests
  • !9295

[PowerShell] improve return type documentation

  • Review changes

  • Download
  • Email patches
  • Plain diff
Merged William Cheng requested to merge powershell-doc into master 4 years ago
  • Overview 0
  • Commits 2
  • Pipelines 0
  • Changes 4
  • improve return type documentation

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.
Compare
  • master (base)

and
  • latest version
    8f3bd125
    2 commits, 2 years ago

4 files
+ 31
- 31

    Preferences

    File browser
    Compare changes
modules/…/…/…‎/…/powershell‎
api_doc.‎mustache‎ +2 -2
samples/client/pets‎tore/powershell/docs‎
PSPet‎Api.md‎ +14 -14
PSStor‎eApi.md‎ +6 -6
PSUser‎Api.md‎ +9 -9
modules/openapi-generator/src/main/resources/powershell/api_doc.mustache
+ 2
- 2
  • View file @ 8f3bd125

  • Edit in single-file editor

  • Open in Web IDE


@@ -78,8 +78,8 @@ Name | Type | Description | Notes
{{/allParams}}
### Return type
# cmdlet returns PSCustomObject, the return object contains the properties of below type
{{#returnType}}{{#returnTypeIsPrimitive}}**{{{returnType}}}**{{/returnTypeIsPrimitive}}{{^returnTypeIsPrimitive}}[**{{{returnType}}}**]({{returnBaseType}}.md){{/returnTypeIsPrimitive}}{{/returnType}}{{^returnType}}void (empty response body){{/returnType}}
{{#returnType}}{{#returnTypeIsPrimitive}}**{{{returnType}}}**{{/returnTypeIsPrimitive}}{{^returnTypeIsPrimitive}}[**{{{returnType}}}**]({{returnBaseType}}.md) (PSCustomObject){{/returnTypeIsPrimitive}}{{/returnType}}{{^returnType}}void (empty response body){{/returnType}}
### Authorization
samples/client/petstore/powershell/docs/PSPetApi.md
+ 14
- 14
  • View file @ 8f3bd125

  • Edit in single-file editor

  • Open in Web IDE


@@ -46,8 +46,8 @@ Name | Type | Description | Notes
**Pet** | [**Pet**](Pet.md)| Pet object that needs to be added to the store |
### Return type
# cmdlet returns PSCustomObject, the return object contains the properties of below type
[**Pet**](Pet.md)
[**Pet**](Pet.md) (PSCustomObject)
### Authorization
@@ -95,7 +95,7 @@ Name | Type | Description | Notes
**ApiKey** | **String**| | [optional]
### Return type
# cmdlet returns PSCustomObject, the return object contains the properties of below type
void (empty response body)
### Authorization
@@ -143,8 +143,8 @@ Name | Type | Description | Notes
**Status** | [**String[]**](String.md)| Status values that need to be considered for filter |
### Return type
# cmdlet returns PSCustomObject, the return object contains the properties of below type
[**Pet[]**](Pet.md)
[**Pet[]**](Pet.md) (PSCustomObject)
### Authorization
@@ -191,8 +191,8 @@ Name | Type | Description | Notes
**Tags** | [**String[]**](String.md)| Tags to filter by |
### Return type
# cmdlet returns PSCustomObject, the return object contains the properties of below type
[**Pet[]**](Pet.md)
[**Pet[]**](Pet.md) (PSCustomObject)
### Authorization
@@ -241,8 +241,8 @@ Name | Type | Description | Notes
**PetId** | **Int64**| ID of pet to return |
### Return type
# cmdlet returns PSCustomObject, the return object contains the properties of below type
[**Pet**](Pet.md)
[**Pet**](Pet.md) (PSCustomObject)
### Authorization
@@ -287,8 +287,8 @@ Name | Type | Description | Notes
**Pet** | [**Pet**](Pet.md)| Pet object that needs to be added to the store |
### Return type
# cmdlet returns PSCustomObject, the return object contains the properties of below type
[**Pet**](Pet.md)
[**Pet**](Pet.md) (PSCustomObject)
### Authorization
@@ -339,7 +339,7 @@ Name | Type | Description | Notes
**Status** | **String**| Updated status of the pet | [optional]
### Return type
# cmdlet returns PSCustomObject, the return object contains the properties of below type
void (empty response body)
### Authorization
@@ -391,8 +391,8 @@ Name | Type | Description | Notes
**File** | **System.IO.FileInfo****System.IO.FileInfo**| file to upload | [optional]
### Return type
# cmdlet returns PSCustomObject, the return object contains the properties of below type
[**ApiResponse**](ApiResponse.md)
[**ApiResponse**](ApiResponse.md) (PSCustomObject)
### Authorization
samples/client/petstore/powershell/docs/PSStoreApi.md
+ 6
- 6
  • View file @ 8f3bd125

  • Edit in single-file editor

  • Open in Web IDE


@@ -39,7 +39,7 @@ Name | Type | Description | Notes
**OrderId** | **String**| ID of the order that needs to be deleted |
### Return type
# cmdlet returns PSCustomObject, the return object contains the properties of below type
void (empty response body)
### Authorization
@@ -84,7 +84,7 @@ try {
This endpoint does not need any parameter.
### Return type
# cmdlet returns PSCustomObject, the return object contains the properties of below type
**System.Collections.Hashtable**
### Authorization
@@ -127,8 +127,8 @@ Name | Type | Description | Notes
**OrderId** | **Int64**| ID of pet that needs to be fetched |
### Return type
# cmdlet returns PSCustomObject, the return object contains the properties of below type
[**Order**](Order.md)
[**Order**](Order.md) (PSCustomObject)
### Authorization
@@ -168,8 +168,8 @@ Name | Type | Description | Notes
**Order** | [**Order**](Order.md)| order placed for purchasing the pet |
### Return type
# cmdlet returns PSCustomObject, the return object contains the properties of below type
[**Order**](Order.md)
[**Order**](Order.md) (PSCustomObject)
### Authorization
samples/client/petstore/powershell/docs/PSUserApi.md
+ 9
- 9
  • View file @ 8f3bd125

  • Edit in single-file editor

  • Open in Web IDE


@@ -50,7 +50,7 @@ Name | Type | Description | Notes
**User** | [**User**](User.md)| Created user object |
### Return type
# cmdlet returns PSCustomObject, the return object contains the properties of below type
void (empty response body)
### Authorization
@@ -98,7 +98,7 @@ Name | Type | Description | Notes
**User** | [**User[]**](User.md)| List of user object |
### Return type
# cmdlet returns PSCustomObject, the return object contains the properties of below type
void (empty response body)
### Authorization
@@ -146,7 +146,7 @@ Name | Type | Description | Notes
**User** | [**User[]**](User.md)| List of user object |
### Return type
# cmdlet returns PSCustomObject, the return object contains the properties of below type
void (empty response body)
### Authorization
@@ -196,7 +196,7 @@ Name | Type | Description | Notes
**Username** | **String**| The name that needs to be deleted |
### Return type
# cmdlet returns PSCustomObject, the return object contains the properties of below type
void (empty response body)
### Authorization
@@ -237,8 +237,8 @@ Name | Type | Description | Notes
**Username** | **String**| The name that needs to be fetched. Use user1 for testing. |
### Return type
# cmdlet returns PSCustomObject, the return object contains the properties of below type
[**User**](User.md)
[**User**](User.md) (PSCustomObject)
### Authorization
@@ -281,7 +281,7 @@ Name | Type | Description | Notes
**Password** | **String**| The password for login in clear text |
### Return type
# cmdlet returns PSCustomObject, the return object contains the properties of below type
**String**
### Authorization
@@ -324,7 +324,7 @@ try {
This endpoint does not need any parameter.
### Return type
# cmdlet returns PSCustomObject, the return object contains the properties of below type
void (empty response body)
### Authorization
@@ -377,7 +377,7 @@ Name | Type | Description | Notes
**User** | [**User**](User.md)| Updated user object |
### Return type
# cmdlet returns PSCustomObject, the return object contains the properties of below type
void (empty response body)
### Authorization
0 Assignees
None
Assign to
0 Reviewers
None
Request review from
Labels
3
Client: PowerShell Enhancement: Feature Feature: Documentation
3
Client: PowerShell Enhancement: Feature Feature: Documentation
    Assign labels
  • Manage project labels

Milestone
5.1.1
5.1.1 (expired)
None
Time tracking
No estimate or time spent
Lock merge request
Unlocked
1
1 participant
William Cheng
Reference: OpenAPITools/openapi-generator!9295
Source branch: powershell-doc

Menu

Explore Projects Groups Snippets