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-fetch] Omit readOnly properties from request models #18065

Merged

Conversation

kota65535
Copy link
Contributor

@kota65535 kota65535 commented Mar 10, 2024

Related to: #4190

This PR omits readOnly properties from request models. Given the following OpenAPI schema and operation.

title: Task
type: object
properties:
  id:
    type: integer
    readOnly: true
  title:
    type: string
post:
  operationId: createTask
  requestBody:
    required: true
    content:
      application/json:
        schema:
          $ref: Task.yml
...

The current generated request models require the unneeded id property.

export interface CreateTaskRequest {
    task: Task;
}

This PR changes them to:

export interface CreateTaskRequest {
    task: Omit<Task, 'id'>;
}

To technical committee: @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) @davidgamero (2022/03) @mkusaka (2022/04)

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/configs/*.yaml
    ./bin/utils/export_docs_generators.sh
    
    (For Windows users, please run the script in Git BASH)
    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*.
    IMPORTANT: Do NOT purge/delete any folders/files (e.g. tests) when regenerating the samples as manually written tests may be removed.
  • File the PR against the correct branch: master (upcoming 7.1.0 minor release - breaking changes with fallbacks), 8.0.x (breaking changes without fallbacks)
  • If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

Copy link
Member

@macjohnny macjohnny left a comment

Choose a reason for hiding this comment

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

LGTM

Thanks for your contribution

@macjohnny macjohnny merged commit 0b4cf0a into OpenAPITools:master Mar 16, 2024
14 checks passed
zapodot pushed a commit to zapodot/openapi-generator that referenced this pull request Mar 21, 2024
…APITools#18065)

* omit readOnly properties on requests

* update the sample
@wing328 wing328 added this to the 7.5.0 milestone Apr 17, 2024
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.

None yet

3 participants