immorechner/openapi.json

{"openapi":"3.1.0","info":{"title":"Hello API Platform","description":"","version":"1.0.0"},"servers":[{"url":"\/","description":""}],"paths":{"\/api\/immobilies":{"get":{"operationId":"api_immobilies_get_collection","tags":["Immobilie"],"responses":{"200":{"description":"Immobilie collection","content":{"application\/ld+json":{"schema":{"type":"object","description":"Immobilie.jsonld collection.","allOf":[{"$ref":"#\/components\/schemas\/HydraCollectionBaseSchema"},{"type":"object","required":["member"],"properties":{"member":{"type":"array","items":{"$ref":"#\/components\/schemas\/Immobilie.jsonld"}}}}]}}}}},"summary":"Retrieves the collection of Immobilie resources.","description":"Retrieves the collection of Immobilie resources.","parameters":[{"name":"page","in":"query","description":"The collection page number","required":false,"deprecated":false,"schema":{"type":"integer","default":1},"style":"form","explode":false}]},"post":{"operationId":"api_immobilies_post","tags":["Immobilie"],"responses":{"201":{"description":"Immobilie resource created","content":{"application\/ld+json":{"schema":{"$ref":"#\/components\/schemas\/Immobilie.jsonld"}}},"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"}},"application\/problem+json":{"schema":{"$ref":"#\/components\/schemas\/ConstraintViolation"}},"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ConstraintViolation"}}},"links":{}}},"summary":"Creates a Immobilie resource.","description":"Creates a Immobilie resource.","parameters":[],"requestBody":{"description":"The new Immobilie resource","content":{"application\/ld+json":{"schema":{"$ref":"#\/components\/schemas\/Immobilie"}}},"required":true}}},"\/api\/immobilies\/{id}":{"get":{"operationId":"api_immobilies_id_get","tags":["Immobilie"],"responses":{"200":{"description":"Immobilie resource","content":{"application\/ld+json":{"schema":{"$ref":"#\/components\/schemas\/Immobilie.jsonld"}}}},"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 Immobilie resource.","description":"Retrieves a Immobilie resource.","parameters":[{"name":"id","in":"path","description":"Immobilie identifier","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false}]},"delete":{"operationId":"api_immobilies_id_delete","tags":["Immobilie"],"responses":{"204":{"description":"Immobilie 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 Immobilie resource.","description":"Removes the Immobilie resource.","parameters":[{"name":"id","in":"path","description":"Immobilie identifier","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false}]},"patch":{"operationId":"api_immobilies_id_patch","tags":["Immobilie"],"responses":{"200":{"description":"Immobilie resource updated","content":{"application\/ld+json":{"schema":{"$ref":"#\/components\/schemas\/Immobilie.jsonld"}}},"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"}},"application\/problem+json":{"schema":{"$ref":"#\/components\/schemas\/ConstraintViolation"}},"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ConstraintViolation"}}},"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 Immobilie resource.","description":"Updates the Immobilie resource.","parameters":[{"name":"id","in":"path","description":"Immobilie identifier","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false}],"requestBody":{"description":"The updated Immobilie resource","content":{"application\/merge-patch+json":{"schema":{"$ref":"#\/components\/schemas\/Immobilie.jsonMergePatch"}}},"required":true}}},"\/api\/users":{"get":{"operationId":"api_users_get_collection","tags":["User"],"responses":{"200":{"description":"User collection","content":{"application\/ld+json":{"schema":{"type":"object","description":"User.jsonld collection.","allOf":[{"$ref":"#\/components\/schemas\/HydraCollectionBaseSchema"},{"type":"object","required":["member"],"properties":{"member":{"type":"array","items":{"$ref":"#\/components\/schemas\/User.jsonld"}}}}]}}}}},"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,"schema":{"type":"integer","default":1},"style":"form","explode":false}]},"post":{"operationId":"api_users_post","tags":["User"],"responses":{"201":{"description":"User resource created","content":{"application\/ld+json":{"schema":{"$ref":"#\/components\/schemas\/User.jsonld"}}},"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"}},"application\/problem+json":{"schema":{"$ref":"#\/components\/schemas\/ConstraintViolation"}},"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ConstraintViolation"}}},"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"}}},"required":true}}},"\/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"}}}},"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,"schema":{"type":"string"},"style":"simple","explode":false}]},"put":{"operationId":"api_users_id_put","tags":["User"],"responses":{"200":{"description":"User resource updated","content":{"application\/ld+json":{"schema":{"$ref":"#\/components\/schemas\/User.jsonld"}}},"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"}},"application\/problem+json":{"schema":{"$ref":"#\/components\/schemas\/ConstraintViolation"}},"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ConstraintViolation"}}},"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":"Replaces the User resource.","description":"Replaces the User resource.","parameters":[{"name":"id","in":"path","description":"User identifier","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false}],"requestBody":{"description":"The updated User resource","content":{"application\/ld+json":{"schema":{"$ref":"#\/components\/schemas\/User"}}},"required":true}},"delete":{"operationId":"api_users_id_delete","tags":["User"],"responses":{"204":{"description":"User 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 User resource.","description":"Removes the User resource.","parameters":[{"name":"id","in":"path","description":"User identifier","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false}]}}},"components":{"schemas":{"ConstraintViolation":{"type":"object","description":"Unprocessable entity","properties":{"status":{"default":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":{"allOf":[{"$ref":"#\/components\/schemas\/HydraItemBaseSchema"},{"type":"object","properties":{"status":{"default":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"]}}}],"description":"Unprocessable entity"},"Error":{"type":"object","description":"A representation of common errors.","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":{"allOf":[{"$ref":"#\/components\/schemas\/HydraItemBaseSchema"},{"type":"object","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"},"description":{"readOnly":true,"type":["string","null"]}}}],"description":"A representation of common errors."},"HydraCollectionBaseSchema":{"type":"object","properties":{"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"}}}}}}}},"HydraItemBaseSchema":{"type":"object","properties":{"@context":{"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":{"type":"string"},"@type":{"type":"string"}},"required":["@id","@type"]},"Immobilie":{"type":"object","properties":{"id":{"readOnly":true,"type":"integer"},"verwalter":{"type":"string","format":"iri-reference","example":"https:\/\/example.com\/"},"adresse":{"minLength":5,"maxLength":255,"type":"string"},"preis":{"type":"string"},"flaeche":{"type":"string"},"garage":{"default":false,"type":"boolean"},"zimmer":{"minimum":0,"exclusiveMinimum":0,"type":"integer"},"baujahr":{"minimum":1800,"maximum":2100,"type":["integer","null"]},"typ":{"type":"string","enum":["wohnung","haus","grundstueck","gewerbe","buero"]},"beschreibung":{"type":["string","null"]},"verfuegbar":{"default":true,"type":"boolean"},"balkonFlaeche":{"minimum":0,"type":["integer","null"]},"kellerFlaeche":{"minimum":0,"type":["integer","null"]},"etage":{"type":["integer","null"]},"heizungstyp":{"type":["string","null"]},"nebenkosten":{"type":["string","null"]},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"preisProQm":{"readOnly":true,"description":"Berechnet den Preis pro Quadratmeter","type":"number"},"gesamtflaeche":{"readOnly":true,"description":"Berechnet die Gesamtfläche inkl. Balkon und Keller","type":"number"}},"required":["verwalter","adresse","preis","flaeche","zimmer"]},"Immobilie.jsonMergePatch":{"type":"object","properties":{"id":{"readOnly":true,"type":"integer"},"verwalter":{"type":"string","format":"iri-reference","example":"https:\/\/example.com\/"},"adresse":{"minLength":5,"maxLength":255,"type":"string"},"preis":{"type":"string"},"flaeche":{"type":"string"},"garage":{"default":false,"type":"boolean"},"zimmer":{"minimum":0,"exclusiveMinimum":0,"type":"integer"},"baujahr":{"minimum":1800,"maximum":2100,"type":["integer","null"]},"typ":{"type":"string","enum":["wohnung","haus","grundstueck","gewerbe","buero"]},"beschreibung":{"type":["string","null"]},"verfuegbar":{"default":true,"type":"boolean"},"balkonFlaeche":{"minimum":0,"type":["integer","null"]},"kellerFlaeche":{"minimum":0,"type":["integer","null"]},"etage":{"type":["integer","null"]},"heizungstyp":{"type":["string","null"]},"nebenkosten":{"type":["string","null"]},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"preisProQm":{"readOnly":true,"description":"Berechnet den Preis pro Quadratmeter","type":"number"},"gesamtflaeche":{"readOnly":true,"description":"Berechnet die Gesamtfläche inkl. Balkon und Keller","type":"number"}}},"Immobilie.jsonld":{"allOf":[{"$ref":"#\/components\/schemas\/HydraItemBaseSchema"},{"type":"object","properties":{"id":{"readOnly":true,"type":"integer"},"verwalter":{"type":"string","format":"iri-reference","example":"https:\/\/example.com\/"},"adresse":{"minLength":5,"maxLength":255,"type":"string"},"preis":{"type":"string"},"flaeche":{"type":"string"},"garage":{"default":false,"type":"boolean"},"zimmer":{"minimum":0,"exclusiveMinimum":0,"type":"integer"},"baujahr":{"minimum":1800,"maximum":2100,"type":["integer","null"]},"typ":{"type":"string","enum":["wohnung","haus","grundstueck","gewerbe","buero"]},"beschreibung":{"type":["string","null"]},"verfuegbar":{"default":true,"type":"boolean"},"balkonFlaeche":{"minimum":0,"type":["integer","null"]},"kellerFlaeche":{"minimum":0,"type":["integer","null"]},"etage":{"type":["integer","null"]},"heizungstyp":{"type":["string","null"]},"nebenkosten":{"type":["string","null"]},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"preisProQm":{"readOnly":true,"description":"Berechnet den Preis pro Quadratmeter","type":"number"},"gesamtflaeche":{"readOnly":true,"description":"Berechnet die Gesamtfläche inkl. Balkon und Keller","type":"number"}},"required":["verwalter","adresse","preis","flaeche","zimmer"]}]},"User":{"type":"object","properties":{"id":{"readOnly":true,"type":"integer"},"name":{"minLength":2,"maxLength":255,"type":"string"},"email":{"format":"email","externalDocs":{"url":"https:\/\/schema.org\/email"},"type":"string"},"role":{"type":"string","enum":["user","admin","moderator"]},"createdAt":{"type":"string","format":"date-time"},"immobilien":{"readOnly":true,"type":"array","items":{"type":"string","format":"iri-reference","example":"https:\/\/example.com\/"}}},"required":["name","email"]},"User.jsonld":{"allOf":[{"$ref":"#\/components\/schemas\/HydraItemBaseSchema"},{"type":"object","properties":{"id":{"readOnly":true,"type":"integer"},"name":{"minLength":2,"maxLength":255,"type":"string"},"email":{"format":"email","externalDocs":{"url":"https:\/\/schema.org\/email"},"type":"string"},"role":{"type":"string","enum":["user","admin","moderator"]},"createdAt":{"type":"string","format":"date-time"},"immobilien":{"readOnly":true,"type":"array","items":{"type":"string","format":"iri-reference","example":"https:\/\/example.com\/"}}},"required":["name","email"]}]}},"responses":{},"parameters":{},"examples":{},"requestBodies":{},"headers":{},"securitySchemes":{}},"security":[],"tags":[{"name":"Immobilie","description":"Resource \u0027Immobilie\u0027 operations."},{"name":"User","description":"Resource \u0027User\u0027 operations."}],"webhooks":{}}