generated from stijnvanhulle/template
-
-
Notifications
You must be signed in to change notification settings - Fork 113
Open
Labels
Description
What version of kubb
is running?
3.18.3
What kind of platform do you use?
MacOS
Your kubb.config.ts
config file?
import { defineConfig } from "@kubb/core";
import { pluginClient } from "@kubb/plugin-client";
import { pluginOas } from "@kubb/plugin-oas";
import { pluginReactQuery } from "@kubb/plugin-react-query";
import { pluginTs } from "@kubb/plugin-ts";
import { pluginZod } from "@kubb/plugin-zod";
export default defineConfig(() => {
return {
root: ".",
input: {
path: "api.json"
},
output: {
path: "./gen"
},
plugins: [
pluginOas({
validate: false
}),
pluginClient(),
pluginTs(),
pluginZod({
version: "4",
typed: true,
unknownType: "unknown"
}),
pluginReactQuery()
]
};
});
Swagger/OpenAPI file?
{"openapi":"3.1.0","info":{"title":"SIRH API","description":"","version":"1.0.0"},"servers":[{"url":"\/","description":""}],"paths":{"\/api\/companies":{"get":{"operationId":"api_companies_get_collection","tags":["Company"],"responses":{"200":{"description":"Company collection","content":{"application\/ld+json":{"schema":{"type":"object","properties":{"member":{"type":"array","items":{"$ref":"#\/components\/schemas\/Company.jsonld"}},"totalItems":{"type":"integer","minimum":0},"view":{"type":"object","properties":{"@id":{"type":"string","format":"iri-reference"},"@type":{"type":"string"},"first":{"type":"string","format":"iri-reference"},"last":{"type":"string","format":"iri-reference"},"previous":{"type":"string","format":"iri-reference"},"next":{"type":"string","format":"iri-reference"}},"example":{"@id":"string","type":"string","first":"string","last":"string","previous":"string","next":"string"}},"search":{"type":"object","properties":{"@type":{"type":"string"},"template":{"type":"string"},"variableRepresentation":{"type":"string"},"mapping":{"type":"array","items":{"type":"object","properties":{"@type":{"type":"string"},"variable":{"type":"string"},"property":{"type":["string","null"]},"required":{"type":"boolean"}}}}}}},"required":["member"]}},"application\/json":{"schema":{"type":"array","items":{"$ref":"#\/components\/schemas\/Company"}}}}}},"summary":"Retrieves the collection of Company resources.","description":"Retrieves the collection of Company resources.","parameters":[{"name":"page","in":"query","description":"The collection page number","required":false,"deprecated":false,"allowEmptyValue":true,"schema":{"type":"integer","default":1},"style":"form","explode":false,"allowReserved":false}],"deprecated":false},"post":{"operationId":"api_companies_post","tags":["Company"],"responses":{"201":{"description":"Company resource created","content":{"application\/ld+json":{"schema":{"$ref":"#\/components\/schemas\/Company.jsonld"}},"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Company"}}},"links":{}},"400":{"description":"Invalid input","content":{"application\/ld+json":{"schema":{"$ref":"#\/components\/schemas\/Error.jsonld"}},"application\/problem+json":{"schema":{"$ref":"#\/components\/schemas\/Error"}},"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}},"links":{}},"422":{"description":"An error occurred","content":{"application\/ld+json":{"schema":{"$ref":"#\/components\/schemas\/ConstraintViolation.jsonld-jsonld"}},"application\/problem+json":{"schema":{"$ref":"#\/components\/schemas\/ConstraintViolation-json"}},"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ConstraintViolation-json"}}},"links":{}}},"summary":"Creates a Company resource.","description":"Creates a Company resource.","parameters":[],"requestBody":{"description":"The new Company resource","content":{"application\/ld+json":{"schema":{"$ref":"#\/components\/schemas\/Company.jsonld"}},"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Company"}}},"required":true},"deprecated":false}},"\/api\/companies\/{id}":{"get":{"operationId":"api_companies_id_get","tags":["Company"],"responses":{"200":{"description":"Company resource","content":{"application\/ld+json":{"schema":{"$ref":"#\/components\/schemas\/Company.jsonld"}},"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Company"}}}},"404":{"description":"Not found","content":{"application\/ld+json":{"schema":{"$ref":"#\/components\/schemas\/Error.jsonld"}},"application\/problem+json":{"schema":{"$ref":"#\/components\/schemas\/Error"}},"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}},"links":{}}},"summary":"Retrieves a Company resource.","description":"Retrieves a Company resource.","parameters":[{"name":"id","in":"path","description":"Company identifier","required":true,"deprecated":false,"allowEmptyValue":false,"schema":{"type":"string"},"style":"simple","explode":false,"allowReserved":false}],"deprecated":false},"delete":{"operationId":"api_companies_id_delete","tags":["Company"],"responses":{"204":{"description":"Company resource deleted"},"404":{"description":"Not found","content":{"application\/ld+json":{"schema":{"$ref":"#\/components\/schemas\/Error.jsonld"}},"application\/problem+json":{"schema":{"$ref":"#\/components\/schemas\/Error"}},"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}},"links":{}}},"summary":"Removes the Company resource.","description":"Removes the Company resource.","parameters":[{"name":"id","in":"path","description":"Company identifier","required":true,"deprecated":false,"allowEmptyValue":false,"schema":{"type":"string"},"style":"simple","explode":false,"allowReserved":false}],"deprecated":false},"patch":{"operationId":"api_companies_id_patch","tags":["Company"],"responses":{"200":{"description":"Company resource updated","content":{"application\/ld+json":{"schema":{"$ref":"#\/components\/schemas\/Company.jsonld"}},"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Company"}}},"links":{}},"400":{"description":"Invalid input","content":{"application\/ld+json":{"schema":{"$ref":"#\/components\/schemas\/Error.jsonld"}},"application\/problem+json":{"schema":{"$ref":"#\/components\/schemas\/Error"}},"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}},"links":{}},"422":{"description":"An error occurred","content":{"application\/ld+json":{"schema":{"$ref":"#\/components\/schemas\/ConstraintViolation.jsonld-jsonld"}},"application\/problem+json":{"schema":{"$ref":"#\/components\/schemas\/ConstraintViolation-json"}},"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ConstraintViolation-json"}}},"links":{}},"404":{"description":"Not found","content":{"application\/ld+json":{"schema":{"$ref":"#\/components\/schemas\/Error.jsonld"}},"application\/problem+json":{"schema":{"$ref":"#\/components\/schemas\/Error"}},"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}},"links":{}}},"summary":"Updates the Company resource.","description":"Updates the Company resource.","parameters":[{"name":"id","in":"path","description":"Company identifier","required":true,"deprecated":false,"allowEmptyValue":false,"schema":{"type":"string"},"style":"simple","explode":false,"allowReserved":false}],"requestBody":{"description":"The updated Company resource","content":{"application\/merge-patch+json":{"schema":{"$ref":"#\/components\/schemas\/Company"}}},"required":true},"deprecated":false}},"\/api\/company_invitations":{"get":{"operationId":"api_company_invitations_get_collection","tags":["CompanyInvitation"],"responses":{"200":{"description":"CompanyInvitation collection","content":{"application\/ld+json":{"schema":{"type":"object","properties":{"member":{"type":"array","items":{"$ref":"#\/components\/schemas\/CompanyInvitation.jsonld"}},"totalItems":{"type":"integer","minimum":0},"view":{"type":"object","properties":{"@id":{"type":"string","format":"iri-reference"},"@type":{"type":"string"},"first":{"type":"string","format":"iri-reference"},"last":{"type":"string","format":"iri-reference"},"previous":{"type":"string","format":"iri-reference"},"next":{"type":"string","format":"iri-reference"}},"example":{"@id":"string","type":"string","first":"string","last":"string","previous":"string","next":"string"}},"search":{"type":"object","properties":{"@type":{"type":"string"},"template":{"type":"string"},"variableRepresentation":{"type":"string"},"mapping":{"type":"array","items":{"type":"object","properties":{"@type":{"type":"string"},"variable":{"type":"string"},"property":{"type":["string","null"]},"required":{"type":"boolean"}}}}}}},"required":["member"]}},"application\/json":{"schema":{"type":"array","items":{"$ref":"#\/components\/schemas\/CompanyInvitation"}}}}}},"summary":"Retrieves the collection of CompanyInvitation resources.","description":"Retrieves the collection of CompanyInvitation resources.","parameters":[{"name":"page","in":"query","description":"The collection page number","required":false,"deprecated":false,"allowEmptyValue":true,"schema":{"type":"integer","default":1},"style":"form","explode":false,"allowReserved":false}],"deprecated":false}},"\/api\/company_invitations\/invite":{"post":{"operationId":"api_company_invitationsinvite_post","tags":["CompanyInvitation"],"responses":{"201":{"description":"CompanyInvitation resource created","content":{"application\/ld+json":{"schema":{"$ref":"#\/components\/schemas\/CompanyInvitation.jsonld"}},"application\/json":{"schema":{"$ref":"#\/components\/schemas\/CompanyInvitation"}}},"links":{}},"400":{"description":"Invalid input","content":{"application\/ld+json":{"schema":{"$ref":"#\/components\/schemas\/Error.jsonld"}},"application\/problem+json":{"schema":{"$ref":"#\/components\/schemas\/Error"}},"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}},"links":{}},"422":{"description":"An error occurred","content":{"application\/ld+json":{"schema":{"$ref":"#\/components\/schemas\/ConstraintViolation.jsonld-jsonld"}},"application\/problem+json":{"schema":{"$ref":"#\/components\/schemas\/ConstraintViolation-json"}},"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ConstraintViolation-json"}}},"links":{}}},"summary":"Creates a CompanyInvitation resource.","description":"Creates a CompanyInvitation resource.","parameters":[],"requestBody":{"description":"The new CompanyInvitation resource","content":{"application\/ld+json":{"schema":{"$ref":"#\/components\/schemas\/CompanyInvitation.InviteUserDTO.jsonld"}},"application\/json":{"schema":{"$ref":"#\/components\/schemas\/CompanyInvitation.InviteUserDTO"}}},"required":true},"deprecated":false}},"\/api\/company_invitations\/{id}":{"get":{"operationId":"api_company_invitations_id_get","tags":["CompanyInvitation"],"responses":{"200":{"description":"CompanyInvitation resource","content":{"application\/ld+json":{"schema":{"$ref":"#\/components\/schemas\/CompanyInvitation.jsonld"}},"application\/json":{"schema":{"$ref":"#\/components\/schemas\/CompanyInvitation"}}}},"404":{"description":"Not found","content":{"application\/ld+json":{"schema":{"$ref":"#\/components\/schemas\/Error.jsonld"}},"application\/problem+json":{"schema":{"$ref":"#\/components\/schemas\/Error"}},"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}},"links":{}}},"summary":"Retrieves a CompanyInvitation resource.","description":"Retrieves a CompanyInvitation resource.","parameters":[{"name":"id","in":"path","description":"CompanyInvitation identifier","required":true,"deprecated":false,"allowEmptyValue":false,"schema":{"type":"string"},"style":"simple","explode":false,"allowReserved":false}],"deprecated":false}},"\/api\/invitations\/accept":{"post":{"operationId":"api_invitationsaccept_post","tags":["CompanyInvitation"],"responses":{"201":{"description":"CompanyInvitation resource created","content":{"application\/ld+json":{"schema":{"$ref":"#\/components\/schemas\/CompanyInvitation.TokenDTO.jsonld"}},"application\/json":{"schema":{"$ref":"#\/components\/schemas\/CompanyInvitation.TokenDTO"}}},"links":{}},"400":{"description":"Invalid input","content":{"application\/ld+json":{"schema":{"$ref":"#\/components\/schemas\/Error.jsonld"}},"application\/problem+json":{"schema":{"$ref":"#\/components\/schemas\/Error"}},"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}},"links":{}},"422":{"description":"An error occurred","content":{"application\/ld+json":{"schema":{"$ref":"#\/components\/schemas\/ConstraintViolation.jsonld-jsonld"}},"application\/problem+json":{"schema":{"$ref":"#\/components\/schemas\/ConstraintViolation-json"}},"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ConstraintViolation-json"}}},"links":{}}},"summary":"Creates a CompanyInvitation resource.","description":"Creates a CompanyInvitation resource.","parameters":[],"requestBody":{"description":"The new CompanyInvitation resource","content":{"application\/ld+json":{"schema":{"$ref":"#\/components\/schemas\/CompanyInvitation.AcceptInvitationDTO.jsonld"}},"application\/json":{"schema":{"$ref":"#\/components\/schemas\/CompanyInvitation.AcceptInvitationDTO"}}},"required":true},"deprecated":false}},"\/auth":{"post":{"operationId":"login_check_post","tags":["Login Check"],"responses":{"200":{"description":"User token created","content":{"application\/json":{"schema":{"type":"object","properties":{"token":{"readOnly":true,"type":"string","nullable":false}},"required":["token"]}}}}},"summary":"Creates a user token.","description":"Creates a user token.","requestBody":{"description":"The login data","content":{"application\/json":{"schema":{"type":"object","properties":{"email":{"type":"string","nullable":false},"password":{"type":"string","nullable":false}},"required":["email","password"]}}},"required":true}}},"\/api\/register":{"post":{"operationId":"api_register_post","tags":["User"],"responses":{"201":{"description":"User resource created","content":{"application\/ld+json":{"schema":{"$ref":"#\/components\/schemas\/User.TokenDTO.jsonld"}},"application\/json":{"schema":{"$ref":"#\/components\/schemas\/User.TokenDTO"}}},"links":{}},"400":{"description":"Invalid input","content":{"application\/ld+json":{"schema":{"$ref":"#\/components\/schemas\/Error.jsonld"}},"application\/problem+json":{"schema":{"$ref":"#\/components\/schemas\/Error"}},"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}},"links":{}},"422":{"description":"An error occurred","content":{"application\/ld+json":{"schema":{"$ref":"#\/components\/schemas\/ConstraintViolation.jsonld-jsonld"}},"application\/problem+json":{"schema":{"$ref":"#\/components\/schemas\/ConstraintViolation-json"}},"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ConstraintViolation-json"}}},"links":{}}},"summary":"Creates a User resource.","description":"Creates a User resource.","parameters":[],"requestBody":{"description":"The new User resource","content":{"application\/ld+json":{"schema":{"$ref":"#\/components\/schemas\/User.RegisterUserDTO.jsonld"}},"application\/json":{"schema":{"$ref":"#\/components\/schemas\/User.RegisterUserDTO"}}},"required":true},"deprecated":false}},"\/api\/users":{"get":{"operationId":"api_users_get_collection","tags":["User"],"responses":{"200":{"description":"User collection","content":{"application\/ld+json":{"schema":{"type":"object","properties":{"member":{"type":"array","items":{"$ref":"#\/components\/schemas\/User.jsonld"}},"totalItems":{"type":"integer","minimum":0},"view":{"type":"object","properties":{"@id":{"type":"string","format":"iri-reference"},"@type":{"type":"string"},"first":{"type":"string","format":"iri-reference"},"last":{"type":"string","format":"iri-reference"},"previous":{"type":"string","format":"iri-reference"},"next":{"type":"string","format":"iri-reference"}},"example":{"@id":"string","type":"string","first":"string","last":"string","previous":"string","next":"string"}},"search":{"type":"object","properties":{"@type":{"type":"string"},"template":{"type":"string"},"variableRepresentation":{"type":"string"},"mapping":{"type":"array","items":{"type":"object","properties":{"@type":{"type":"string"},"variable":{"type":"string"},"property":{"type":["string","null"]},"required":{"type":"boolean"}}}}}}},"required":["member"]}},"application\/json":{"schema":{"type":"array","items":{"$ref":"#\/components\/schemas\/User"}}}}}},"summary":"Retrieves the collection of User resources.","description":"Retrieves the collection of User resources.","parameters":[{"name":"page","in":"query","description":"The collection page number","required":false,"deprecated":false,"allowEmptyValue":true,"schema":{"type":"integer","default":1},"style":"form","explode":false,"allowReserved":false}],"deprecated":false}},"\/api\/users\/{id}":{"get":{"operationId":"api_users_id_get","tags":["User"],"responses":{"200":{"description":"User resource","content":{"application\/ld+json":{"schema":{"$ref":"#\/components\/schemas\/User.jsonld"}},"application\/json":{"schema":{"$ref":"#\/components\/schemas\/User"}}}},"404":{"description":"Not found","content":{"application\/ld+json":{"schema":{"$ref":"#\/components\/schemas\/Error.jsonld"}},"application\/problem+json":{"schema":{"$ref":"#\/components\/schemas\/Error"}},"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}},"links":{}}},"summary":"Retrieves a User resource.","description":"Retrieves a User resource.","parameters":[{"name":"id","in":"path","description":"User identifier","required":true,"deprecated":false,"allowEmptyValue":false,"schema":{"type":"string"},"style":"simple","explode":false,"allowReserved":false}],"deprecated":false}}},"components":{"schemas":{"Address":{"type":"object","description":"","deprecated":false,"properties":{"id":{"readOnly":true,"type":"integer"},"name":{"type":["string","null"]},"address":{"type":["string","null"]},"city":{"type":["string","null"]},"province":{"type":["string","null"]},"country":{"type":["string","null"]},"postalCode":{"type":["string","null"]},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}}},"Address.jsonld":{"type":"object","description":"","deprecated":false,"properties":{"@context":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"object","properties":{"@vocab":{"type":"string"},"hydra":{"type":"string","enum":["http:\/\/www.w3.org\/ns\/hydra\/core#"]}},"required":["@vocab","hydra"],"additionalProperties":true}]},"@id":{"readOnly":true,"type":"string"},"@type":{"readOnly":true,"type":"string"},"id":{"readOnly":true,"type":"integer"},"name":{"type":["string","null"]},"address":{"type":["string","null"]},"city":{"type":["string","null"]},"province":{"type":["string","null"]},"country":{"type":["string","null"]},"postalCode":{"type":["string","null"]},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}}},"Benefit":{"type":"object","description":"","deprecated":false,"properties":{"id":{"readOnly":true,"type":"integer"},"provider":{"type":"string"},"name":{"type":"string"},"totalPrice":{"type":["integer","null"]},"companyRatio":{"type":["integer","null"]},"docs":{"type":"array","items":{"$ref":"#\/components\/schemas\/Document"}},"company":{"type":"string","format":"iri-reference","example":"https:\/\/example.com\/"}}},"Benefit.jsonld":{"type":"object","description":"","deprecated":false,"properties":{"@context":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"object","properties":{"@vocab":{"type":"string"},"hydra":{"type":"string","enum":["http:\/\/www.w3.org\/ns\/hydra\/core#"]}},"required":["@vocab","hydra"],"additionalProperties":true}]},"@id":{"readOnly":true,"type":"string"},"@type":{"readOnly":true,"type":"string"},"id":{"readOnly":true,"type":"integer"},"provider":{"type":"string"},"name":{"type":"string"},"totalPrice":{"type":["integer","null"]},"companyRatio":{"type":["integer","null"]},"docs":{"type":"array","items":{"$ref":"#\/components\/schemas\/Document.jsonld"}},"company":{"type":"string","format":"iri-reference","example":"https:\/\/example.com\/"}}},"BenefitEnrollment":{"type":"object","description":"","deprecated":false,"properties":{"id":{"readOnly":true,"type":"integer"},"employee":{"$ref":"#\/components\/schemas\/Employee"},"dateStart":{"type":"string","format":"date-time"},"dateEnd":{"type":["string","null"],"format":"date-time"},"benefit":{"$ref":"#\/components\/schemas\/Benefit"},"docs":{"type":"array","items":{"$ref":"#\/components\/schemas\/Document"}}}},"BenefitEnrollment.jsonld":{"type":"object","description":"","deprecated":false,"properties":{"@context":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"object","properties":{"@vocab":{"type":"string"},"hydra":{"type":"string","enum":["http:\/\/www.w3.org\/ns\/hydra\/core#"]}},"required":["@vocab","hydra"],"additionalProperties":true}]},"@id":{"readOnly":true,"type":"string"},"@type":{"readOnly":true,"type":"string"},"id":{"readOnly":true,"type":"integer"},"employee":{"$ref":"#\/components\/schemas\/Employee.jsonld"},"dateStart":{"type":"string","format":"date-time"},"dateEnd":{"type":["string","null"],"format":"date-time"},"benefit":{"$ref":"#\/components\/schemas\/Benefit.jsonld"},"docs":{"type":"array","items":{"$ref":"#\/components\/schemas\/Document.jsonld"}}}},"Company":{"type":"object","description":"","deprecated":false,"properties":{"id":{"readOnly":true,"type":"integer"},"name":{"type":"string"},"users":{"type":"array","items":{"type":"string","format":"iri-reference","example":"https:\/\/example.com\/"}},"invitations":{"type":"array","items":{"type":"string","format":"iri-reference","example":"https:\/\/example.com\/"}},"benefits":{"type":"array","items":{"$ref":"#\/components\/schemas\/Benefit"}},"profilePicture":{"anyOf":[{"$ref":"#\/components\/schemas\/Document"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}}},"Company.jsonld":{"type":"object","description":"","deprecated":false,"properties":{"@context":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"object","properties":{"@vocab":{"type":"string"},"hydra":{"type":"string","enum":["http:\/\/www.w3.org\/ns\/hydra\/core#"]}},"required":["@vocab","hydra"],"additionalProperties":true}]},"@id":{"readOnly":true,"type":"string"},"@type":{"readOnly":true,"type":"string"},"id":{"readOnly":true,"type":"integer"},"name":{"type":"string"},"users":{"type":"array","items":{"type":"string","format":"iri-reference","example":"https:\/\/example.com\/"}},"invitations":{"type":"array","items":{"type":"string","format":"iri-reference","example":"https:\/\/example.com\/"}},"benefits":{"type":"array","items":{"$ref":"#\/components\/schemas\/Benefit.jsonld"}},"profilePicture":{"anyOf":[{"$ref":"#\/components\/schemas\/Document.jsonld"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}}},"CompanyInvitation":{"type":"object","description":"","deprecated":false,"properties":{"id":{"readOnly":true,"type":"integer"},"email":{"format":"email","externalDocs":{"url":"https:\/\/schema.org\/email"},"type":"string"},"token":{"type":"string"},"company":{"type":"string","format":"iri-reference","example":"https:\/\/example.com\/"},"firstName":{"type":"string"},"lastName":{"type":"string"},"invitedBy":{"type":"string","format":"iri-reference","example":"https:\/\/example.com\/"},"roles":{"type":"array","items":{"type":"string"}},"expiresAt":{"type":"string","format":"date-time"},"acceptedAt":{"type":["string","null"],"format":"date-time"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["email"]},"CompanyInvitation.AcceptInvitationDTO":{"type":"object","description":"","deprecated":false,"required":["token","password","firstName","lastName"],"properties":{"token":{"type":"string"},"password":{"type":["string","null"]},"firstName":{"type":["string","null"]},"lastName":{"type":["string","null"]}}},"CompanyInvitation.AcceptInvitationDTO.jsonld":{"type":"object","description":"","deprecated":false,"required":["token","password","firstName","lastName"],"properties":{"token":{"type":"string"},"password":{"type":["string","null"]},"firstName":{"type":["string","null"]},"lastName":{"type":["string","null"]}}},"CompanyInvitation.InviteUserDTO":{"type":"object","description":"","deprecated":false,"properties":{"email":{"format":"email","externalDocs":{"url":"https:\/\/schema.org\/email"},"type":"string"},"firstName":{"type":"string"},"lastName":{"type":"string"}},"required":["firstName","lastName"]},"CompanyInvitation.InviteUserDTO.jsonld":{"type":"object","description":"","deprecated":false,"properties":{"email":{"format":"email","externalDocs":{"url":"https:\/\/schema.org\/email"},"type":"string"},"firstName":{"type":"string"},"lastName":{"type":"string"}},"required":["firstName","lastName"]},"CompanyInvitation.TokenDTO":{"type":"object","description":"","deprecated":false,"properties":{"token":{"type":"string"}}},"CompanyInvitation.TokenDTO.jsonld":{"type":"object","description":"","deprecated":false,"properties":{"@context":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"object","properties":{"@vocab":{"type":"string"},"hydra":{"type":"string","enum":["http:\/\/www.w3.org\/ns\/hydra\/core#"]}},"required":["@vocab","hydra"],"additionalProperties":true}]},"@id":{"readOnly":true,"type":"string"},"@type":{"readOnly":true,"type":"string"},"token":{"type":"string"}}},"CompanyInvitation.jsonld":{"type":"object","description":"","deprecated":false,"properties":{"@id":{"readOnly":true,"type":"string"},"@type":{"readOnly":true,"type":"string"},"@context":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"object","properties":{"@vocab":{"type":"string"},"hydra":{"type":"string","enum":["http:\/\/www.w3.org\/ns\/hydra\/core#"]}},"required":["@vocab","hydra"],"additionalProperties":true}]},"id":{"readOnly":true,"type":"integer"},"email":{"format":"email","externalDocs":{"url":"https:\/\/schema.org\/email"},"type":"string"},"token":{"type":"string"},"company":{"type":"string","format":"iri-reference","example":"https:\/\/example.com\/"},"firstName":{"type":"string"},"lastName":{"type":"string"},"invitedBy":{"type":"string","format":"iri-reference","example":"https:\/\/example.com\/"},"roles":{"type":"array","items":{"type":"string"}},"expiresAt":{"type":"string","format":"date-time"},"acceptedAt":{"type":["string","null"],"format":"date-time"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["email"]},"ConstraintViolation-json":{"type":"object","description":"Unprocessable entity","deprecated":false,"properties":{"status":{"default":422,"example":422,"type":"integer"},"violations":{"type":"array","items":{"type":"object","properties":{"propertyPath":{"type":"string","description":"The property path of the violation"},"message":{"type":"string","description":"The message associated with the violation"}}}},"detail":{"readOnly":true,"type":"string"},"type":{"readOnly":true,"type":"string"},"title":{"readOnly":true,"type":["string","null"]},"instance":{"readOnly":true,"type":["string","null"]}}},"ConstraintViolation.jsonld-jsonld":{"type":"object","description":"Unprocessable entity","deprecated":false,"properties":{"@context":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"object","properties":{"@vocab":{"type":"string"},"hydra":{"type":"string","enum":["http:\/\/www.w3.org\/ns\/hydra\/core#"]}},"required":["@vocab","hydra"],"additionalProperties":true}]},"@id":{"readOnly":true,"type":"string"},"@type":{"readOnly":true,"type":"string"},"status":{"default":422,"example":422,"type":"integer"},"violations":{"type":"array","items":{"type":"object","properties":{"propertyPath":{"type":"string","description":"The property path of the violation"},"message":{"type":"string","description":"The message associated with the violation"}}}},"detail":{"readOnly":true,"type":"string"},"description":{"readOnly":true,"type":"string"},"type":{"readOnly":true,"type":"string"},"title":{"readOnly":true,"type":["string","null"]},"instance":{"readOnly":true,"type":["string","null"]}}},"Contract":{"type":"object","description":"","deprecated":false,"properties":{"id":{"readOnly":true,"type":"integer"},"employee":{"$ref":"#\/components\/schemas\/Employee"},"type":{"type":"string","enum":["CDI","CDD","APPRENTISSAGE","STAGE","INTERIM","PRESTATION"]},"startDate":{"type":"string","format":"date-time"},"endDate":{"type":["string","null"],"format":"date-time"},"trialEndDate":{"type":["string","null"],"format":"date-time"},"workingTimeRatio":{"default":1,"example":1,"type":["number","null"]},"status":{"type":"string","enum":["CADRE","NON_CADRE"]},"collectiveAgreement":{"type":["string","null"]},"documents":{"type":"array","items":{"$ref":"#\/components\/schemas\/Document"}},"remuneration":{"anyOf":[{"$ref":"#\/components\/schemas\/Remuneration"},{"type":"null"}]},"jobTitle":{"type":"string"}}},"Contract.jsonld":{"type":"object","description":"","deprecated":false,"properties":{"@context":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"object","properties":{"@vocab":{"type":"string"},"hydra":{"type":"string","enum":["http:\/\/www.w3.org\/ns\/hydra\/core#"]}},"required":["@vocab","hydra"],"additionalProperties":true}]},"@id":{"readOnly":true,"type":"string"},"@type":{"readOnly":true,"type":"string"},"id":{"readOnly":true,"type":"integer"},"employee":{"$ref":"#\/components\/schemas\/Employee.jsonld"},"type":{"type":"string","enum":["CDI","CDD","APPRENTISSAGE","STAGE","INTERIM","PRESTATION"]},"startDate":{"type":"string","format":"date-time"},"endDate":{"type":["string","null"],"format":"date-time"},"trialEndDate":{"type":["string","null"],"format":"date-time"},"workingTimeRatio":{"default":1,"example":1,"type":["number","null"]},"status":{"type":"string","enum":["CADRE","NON_CADRE"]},"collectiveAgreement":{"type":["string","null"]},"documents":{"type":"array","items":{"$ref":"#\/components\/schemas\/Document.jsonld"}},"remuneration":{"anyOf":[{"$ref":"#\/components\/schemas\/Remuneration.jsonld"},{"type":"null"}]},"jobTitle":{"type":"string"}}},"Document":{"type":"object","description":"","deprecated":false,"properties":{"id":{"readOnly":true,"type":"integer"},"path":{"type":"string"},"originalName":{"type":"string"},"mimeType":{"type":["string","null"]},"size":{"type":["integer","null"]},"checksum":{"type":["string","null"]},"contract":{"anyOf":[{"$ref":"#\/components\/schemas\/Contract"},{"type":"null"}]},"benefitEnrollment":{"anyOf":[{"$ref":"#\/components\/schemas\/BenefitEnrollment"},{"type":"null"}]},"benefit":{"anyOf":[{"$ref":"#\/components\/schemas\/Benefit"},{"type":"null"}]}}},"Document.jsonld":{"type":"object","description":"","deprecated":false,"properties":{"@context":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"object","properties":{"@vocab":{"type":"string"},"hydra":{"type":"string","enum":["http:\/\/www.w3.org\/ns\/hydra\/core#"]}},"required":["@vocab","hydra"],"additionalProperties":true}]},"@id":{"readOnly":true,"type":"string"},"@type":{"readOnly":true,"type":"string"},"id":{"readOnly":true,"type":"integer"},"path":{"type":"string"},"originalName":{"type":"string"},"mimeType":{"type":["string","null"]},"size":{"type":["integer","null"]},"checksum":{"type":["string","null"]},"contract":{"anyOf":[{"$ref":"#\/components\/schemas\/Contract.jsonld"},{"type":"null"}]},"benefitEnrollment":{"anyOf":[{"$ref":"#\/components\/schemas\/BenefitEnrollment.jsonld"},{"type":"null"}]},"benefit":{"anyOf":[{"$ref":"#\/components\/schemas\/Benefit.jsonld"},{"type":"null"}]}}},"Employee":{"type":"object","description":"","deprecated":false,"properties":{"id":{"readOnly":true,"type":"integer"},"firstName":{"type":["string","null"]},"lastName":{"type":["string","null"]},"platformAccess":{"type":["string","null"],"format":"iri-reference","example":"https:\/\/example.com\/"},"birthDate":{"type":["string","null"],"format":"date-time"},"birthPlace":{"type":["string","null"]},"nationality":{"type":["string","null"]},"proEmail":{"type":["string","null"]},"proPhone":{"type":["string","null"]},"personalEmail":{"type":["string","null"]},"personalPhone":{"type":["string","null"]},"emergencyContactName":{"type":["string","null"]},"emergencyContactPhone":{"type":["string","null"]},"address":{"anyOf":[{"$ref":"#\/components\/schemas\/Address"},{"type":"null"}]},"contracts":{"type":"array","items":{"$ref":"#\/components\/schemas\/Contract"}},"benefitEnrollments":{"type":"array","items":{"$ref":"#\/components\/schemas\/BenefitEnrollment"}},"profilePicture":{"anyOf":[{"$ref":"#\/components\/schemas\/Document"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}}},"Employee.jsonld":{"type":"object","description":"","deprecated":false,"properties":{"@context":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"object","properties":{"@vocab":{"type":"string"},"hydra":{"type":"string","enum":["http:\/\/www.w3.org\/ns\/hydra\/core#"]}},"required":["@vocab","hydra"],"additionalProperties":true}]},"@id":{"readOnly":true,"type":"string"},"@type":{"readOnly":true,"type":"string"},"id":{"readOnly":true,"type":"integer"},"firstName":{"type":["string","null"]},"lastName":{"type":["string","null"]},"platformAccess":{"type":["string","null"],"format":"iri-reference","example":"https:\/\/example.com\/"},"birthDate":{"type":["string","null"],"format":"date-time"},"birthPlace":{"type":["string","null"]},"nationality":{"type":["string","null"]},"proEmail":{"type":["string","null"]},"proPhone":{"type":["string","null"]},"personalEmail":{"type":["string","null"]},"personalPhone":{"type":["string","null"]},"emergencyContactName":{"type":["string","null"]},"emergencyContactPhone":{"type":["string","null"]},"address":{"anyOf":[{"$ref":"#\/components\/schemas\/Address.jsonld"},{"type":"null"}]},"contracts":{"type":"array","items":{"$ref":"#\/components\/schemas\/Contract.jsonld"}},"benefitEnrollments":{"type":"array","items":{"$ref":"#\/components\/schemas\/BenefitEnrollment.jsonld"}},"profilePicture":{"anyOf":[{"$ref":"#\/components\/schemas\/Document.jsonld"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}}},"Error":{"type":"object","description":"A representation of common errors.","deprecated":false,"properties":{"title":{"readOnly":true,"description":"A short, human-readable summary of the problem.","type":"string"},"detail":{"readOnly":true,"description":"A human-readable explanation specific to this occurrence of the problem.","type":"string"},"status":{"type":"number","examples":[404],"default":400},"instance":{"readOnly":true,"description":"A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.","type":["string","null"]},"type":{"readOnly":true,"description":"A URI reference that identifies the problem type","type":"string"}}},"Error.jsonld":{"type":"object","description":"A representation of common errors.","deprecated":false,"properties":{"@context":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"object","properties":{"@vocab":{"type":"string"},"hydra":{"type":"string","enum":["http:\/\/www.w3.org\/ns\/hydra\/core#"]}},"required":["@vocab","hydra"],"additionalProperties":true}]},"@id":{"readOnly":true,"type":"string"},"@type":{"readOnly":true,"type":"string"},"title":{"readOnly":true,"description":"A short, human-readable summary of the problem.","type":"string"},"detail":{"readOnly":true,"description":"A human-readable explanation specific to this occurrence of the problem.","type":"string"},"status":{"type":"number","examples":[404],"default":400},"instance":{"readOnly":true,"description":"A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.","type":["string","null"]},"type":{"readOnly":true,"description":"A URI reference that identifies the problem type","type":"string"},"description":{"readOnly":true,"type":["string","null"]}}},"Remuneration":{"type":"object","description":"","deprecated":false,"properties":{"id":{"readOnly":true,"type":"integer"},"contract":{"$ref":"#\/components\/schemas\/Contract"},"grossSalary":{"type":["string","null"]},"hourlyRate":{"type":["string","null"]}}},"Remuneration.jsonld":{"type":"object","description":"","deprecated":false,"properties":{"@context":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"object","properties":{"@vocab":{"type":"string"},"hydra":{"type":"string","enum":["http:\/\/www.w3.org\/ns\/hydra\/core#"]}},"required":["@vocab","hydra"],"additionalProperties":true}]},"@id":{"readOnly":true,"type":"string"},"@type":{"readOnly":true,"type":"string"},"id":{"readOnly":true,"type":"integer"},"contract":{"$ref":"#\/components\/schemas\/Contract.jsonld"},"grossSalary":{"type":["string","null"]},"hourlyRate":{"type":["string","null"]}}},"User":{"type":"object","description":"","deprecated":false,"properties":{"id":{"readOnly":true,"type":"integer"},"email":{"type":"string"},"roles":{"description":"The user roles","type":"array","items":{"type":"string"}},"password":{"type":"string"},"company":{"type":"string","format":"iri-reference","example":"https:\/\/example.com\/"},"firstName":{"type":"string"},"lastName":{"type":"string"},"employee":{"anyOf":[{"$ref":"#\/components\/schemas\/Employee"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"userIdentifier":{"readOnly":true,"description":"A visual identifier that represents this user.","type":"string"}}},"User.RegisterUserDTO":{"type":"object","description":"","deprecated":false,"properties":{"email":{"format":"email","externalDocs":{"url":"https:\/\/schema.org\/email"},"type":"string"},"password":{"type":"string"},"firstName":{"type":"string"},"lastName":{"type":"string"},"companyName":{"type":"string"}},"required":["password","firstName","lastName","companyName"]},"User.RegisterUserDTO.jsonld":{"type":"object","description":"","deprecated":false,"properties":{"email":{"format":"email","externalDocs":{"url":"https:\/\/schema.org\/email"},"type":"string"},"password":{"type":"string"},"firstName":{"type":"string"},"lastName":{"type":"string"},"companyName":{"type":"string"}},"required":["password","firstName","lastName","companyName"]},"User.TokenDTO":{"type":"object","description":"","deprecated":false,"properties":{"token":{"type":"string"}}},"User.TokenDTO.jsonld":{"type":"object","description":"","deprecated":false,"properties":{"@context":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"object","properties":{"@vocab":{"type":"string"},"hydra":{"type":"string","enum":["http:\/\/www.w3.org\/ns\/hydra\/core#"]}},"required":["@vocab","hydra"],"additionalProperties":true}]},"@id":{"readOnly":true,"type":"string"},"@type":{"readOnly":true,"type":"string"},"token":{"type":"string"}}},"User.jsonld":{"type":"object","description":"","deprecated":false,"properties":{"@id":{"readOnly":true,"type":"string"},"@type":{"readOnly":true,"type":"string"},"@context":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"object","properties":{"@vocab":{"type":"string"},"hydra":{"type":"string","enum":["http:\/\/www.w3.org\/ns\/hydra\/core#"]}},"required":["@vocab","hydra"],"additionalProperties":true}]},"id":{"readOnly":true,"type":"integer"},"email":{"type":"string"},"roles":{"description":"The user roles","type":"array","items":{"type":"string"}},"password":{"type":"string"},"company":{"type":"string","format":"iri-reference","example":"https:\/\/example.com\/"},"firstName":{"type":"string"},"lastName":{"type":"string"},"employee":{"anyOf":[{"$ref":"#\/components\/schemas\/Employee.jsonld"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"userIdentifier":{"readOnly":true,"description":"A visual identifier that represents this user.","type":"string"}}}},"responses":{},"parameters":{},"examples":{},"requestBodies":{},"headers":{},"securitySchemes":{"JWT":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}}},"security":[],"tags":[{"name":"Company"},{"name":"CompanyInvitation"},{"name":"User"}],"webhooks":{}}
What version of external packages are you using(@tanstack-query
, MSW
, React
, Vue
, ...)
What steps can reproduce the bug?
When I generate the zod file from the specified schema, the key on the omit are not escaped resulting in something like
export const apiCompaniesPostMutationRequestSchema = companyJsonldSchema.omit({ @context: true,@id: true,@type: true,id: true }) as unknown as ToZod<ApiCompaniesPostMutationRequest>
So we have build error.
How often does this bug happen?
Every time
What is the expected behaviour?
The omit key should be escaped.
Additional information
No response
dosubot