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 #6

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

kota65535
Copy link
Owner

@kota65535 kota65535 commented Feb 23, 2024

Related:

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'>;
}

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.

@kota65535 kota65535 force-pushed the omit-readonly-properties-on-request branch 3 times, most recently from 7d446c6 to b139bfe Compare February 27, 2024 06:43
@kota65535 kota65535 force-pushed the omit-readonly-properties-on-request branch from 2eb6786 to f184081 Compare March 10, 2024 14:29
@kota65535 kota65535 changed the title [typescript-fetch] Omit readOnly properties on requests [typescript-fetch] Omit readOnly properties of request models Mar 10, 2024
@kota65535 kota65535 changed the title [typescript-fetch] Omit readOnly properties of request models [typescript-fetch] Omit readOnly properties from request models Mar 10, 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.

1 participant