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.

Sign up for GitHub

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

Jump to bottom

fix(#zimic): support declaring http bodies using interfaces (#350) #358

Merged
merged 26 commits into from
Aug 25, 2024
Merged

fix(#zimic): support declaring http bodies using interfaces (#350) #358

merged 26 commits into from
Aug 25, 2024

Conversation

diego-aquino
Copy link
Member

@diego-aquino diego-aquino commented Aug 24, 2024 •
edited
Loading

Fixes

  • [#zimic] Added support to declare HTTP schema bodies using interface. This became no longer possible after HTTP interceptor strict JSON validation #106. Zimic now is less strict about the validation of JSON bodies in HTTP schemas, due to limitations in TypeScript. Due to the type error message being somewhat cryptic ("Index signature is missing in type X"), we believe allowing type and interface and serializing JSON body types before use is a good compromise.
  • Deprecated HttpResponseSchemaByStatusCode.Strict in favor of HttpResponseSchemaByStatusCode.
  • Added HttpFormDataSerialized and updated the typegen code to wrap this type around raw schemas. This is to ensure that Zimic correctly understands schemas not strictly correct, as sometimes happens for search params and headers.

Development

  • [#zimic] Updated tsconfig.json to ignore interceptor/*.d.ts and http/*.d.ts in type checking and linting.
  • [#eslint] Disabled the rule "no-redeclare", which is already enforced by the TypeScript copiler.

Closes #350.

@diego-aquino diego-aquino self-assigned this Aug 24, 2024
@diego-aquino diego-aquino added this to the v0.9.1 milestone Aug 24, 2024
@diego-aquino diego-aquino mentioned this pull request Aug 24, 2024
Closed
5 tasks
@diego-aquino
chore(#zimic): ignore dist types in type checking
e88268d
@diego-aquino
style(#eslint): check no-redeclare through typescript
14a65a1
@diego-aquino
fix(#zimic): support declaring http schemas using interfaces
2716e91
@diego-aquino
refactor(#zimic): replace strict subtype by parent type
2a2ad15
@diego-aquino
docs(#zimic): document public namespace types
3f31f10
@diego-aquino
test(#zimic): verify bodies declared as interfaces
c7967be
@diego-aquino
fix(#zimic): fix recursive json type declaration
e78abf5
@diego-aquino
test(#zimic): declare more body types as interfaces
286c2bf
@diego-aquino
fix(#zimic): correctly convert responses by status code to strict
9bc17be
@diego-aquino
test(zimic-test-client): declare some response bodies as interfaces
4180cd2
@diego-aquino
chore(examples): remove unnecessary eslint comments
1e502e3
@diego-aquino
chore(root): improve concurrency in root tasks
ee25300
@diego-aquino
chore(#zimic): ignore dist types in linting
a37b8dd
@diego-aquino
docs(#zimic): improve jsdoc descriptions
27fd966
@diego-aquino
docs(wiki): simplify body declarations previously using JSONValue
dc0262c
@diego-aquino
perf(#zimic): skip json serialization if already compatible
81dd2bb
@diego-aquino
chore(#zimic): return previous body validation behavior
9e0aab5
@diego-aquino
perf(#zimic): skip search param serialization if already compatible
50380b6
@diego-aquino
refactor(#zimic): create http path params module
b6782c4
@diego-aquino
fix(#zimic): improve http search params and header serialization types
61c1eb7
@diego-aquino
feat(#zimic): support serializing http form data schemas
4ebaf53
@diego-aquino
fix(#zimic): improve json serialization checks
5d2fe16
@diego-aquino
feat(#zimic): export new type utilities
902979e
@diego-aquino
test(zimic-test-client): verify schemas and serialization types
78f2948
@diego-aquino
fix(#zimic): serialize typegen form data schema before use
cd83e79
@diego-aquino
test(#zimic): correctly check request and response serialized fields
b6d4010
@diego-aquino diego-aquino force-pushed the @diego-aquino/350-interfaces-in-http-schemas branch from acbc51f to b6d4010 Compare August 25, 2024 00:38
@diego-aquino diego-aquino merged commit f24d8e4 into canary Aug 25, 2024
15 checks passed
@diego-aquino diego-aquino deleted the @diego-aquino/350-interfaces-in-http-schemas branch August 25, 2024 00:42
@github-actions GitHub Actions
Copy link
Contributor

Released in v0.9.1 🎉

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees

@diego-aquino diego-aquino

Labels
None yet
Projects
None yet
Milestone
v0.9.1
Development

Successfully merging this pull request may close these issues.

Support declaring bodies using interfaces in HTTP schemas
1 participant
@diego-aquino