Skip to content

create-client: Quasar Framework Generator #393

@suntong

Description

@suntong

API Platform version(s) affected: x.y.z

api-platform/create-client: 0.10.0

Description

So many issues with the create-client of the Quasar Framework Generator.

How to reproduce

In short, by following https://api-platform.com/docs/create-client/quasar/.

Details:

npm init quasar 
npm i -D @api-platform/create-client 
npx create-client --generator quasar --format openapi3 https://demo.api-platform.com/docs.jsonopenapi src/

Then,

npx quasar dev

Issues:

  • Eslint gives loads of warnings/errors.
  • There'are also loads of run-time errors as well, albeit the book list is at least showing.
  • The openapi3 spec defines specific security mechanisms in the components/securitySchemes section -- Specific endpoints—particularly those under the /admin prefix—are tagged with security requirements. In the spec, these operations have a security property that references the schemes above. Yet, the code generated
    • accessed api("users" instead of the api("admin/users"
    • and there's no security mechanisms provided to access the Scoped Access areas.
    • Ref: code here.

Moreover, the link right at the description area on site https://github.com/api-platform/create-client/, which points to https://api-platform.com/docs/client-generator/, is broken.

Possible Solution

N.A.

Additional Context

My devDependencies:

  "devDependencies": {
    "@api-platform/create-client": "^0.10.0",
    "@eslint/js": "^9.14.0",
    "@intlify/unplugin-vue-i18n": "^4.0.0",
    "@quasar/app-vite": "^2.1.0",
    "@types/node": "^20.5.9",
    "@vue/eslint-config-prettier": "^10.1.0",
    "@vue/eslint-config-typescript": "^14.4.0",
    "autoprefixer": "^10.4.2",
    "dayjs": "^1.11.19",
    "eslint": "^9.14.0",
    "eslint-plugin-vue": "^10.4.0",
    "globals": "^16.4.0",
    "prettier": "^3.3.3",
    "typescript": "^5.9.2",
    "vite-plugin-checker": "^0.11.0",
    "vue-eslint-parser": "^10.2.0",
    "vue-tsc": "^3.0.7"
  },

The OpenAPI v3 document as of today:

OpenAPI v3 Book
{"openapi":"3.1.0","info":{"title":"API Platform\u0027s demo","description":"This is a demo application of the [API Platform](https:\/\/api-platform.com) framework.\n[Its source code](https:\/\/github.com\/api-platform\/demo) includes various examples, check it out!\nYou may also be interested by [the GraphQL entrypoint](\/graphql).\n[A PWA](\/books) and [an admin](\/admin) are consuming this API.","version":"4.2.16"},"servers":[{"url":"\/","description":""}],"paths":{"\/admin\/books":{"get":{"operationId":"api_adminbooks_get_collection","tags":["Book"],"responses":{"200":{"description":"Book collection","content":{"application\/ld+json":{"schema":{"type":"object","description":"Book.jsonld-Book.read.admin_Enum.read collection.","allOf":[{"$ref":"#\/components\/schemas\/HydraCollectionBaseSchema"},{"type":"object","required":["hydra:member"],"properties":{"hydra:member":{"type":"array","items":{"$ref":"#\/components\/schemas\/Book.jsonld-Book.read.admin_Enum.read"}}}}]}},"application\/json":{"schema":{"type":"array","items":{"$ref":"#\/components\/schemas\/Book-Book.read.admin_Enum.read"}}}}},"403":{"description":"Forbidden","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 the collection of Book resources.","description":"Retrieves the collection of Book resources.","parameters":[{"name":"page","in":"query","description":"The collection page number","required":false,"deprecated":false,"schema":{"type":"integer","default":1},"style":"form","explode":false},{"name":"itemsPerPage","in":"query","description":"The number of items per page","required":false,"deprecated":false,"schema":{"type":"integer","default":30,"minimum":0,"maximum":30},"style":"form","explode":false},{"name":"order[title]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"string","default":"asc","enum":["asc","desc"]},"style":"form","explode":false},{"name":"title","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"string"},"style":"form","explode":false},{"name":"author","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"string"},"style":"form","explode":false},{"name":"condition","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"string"},"style":"form","explode":false},{"name":"condition[]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true}]},"post":{"operationId":"api_adminbooks_post","tags":["Book"],"responses":{"201":{"description":"Book resource created","content":{"application\/ld+json":{"schema":{"$ref":"#\/components\/schemas\/Book.jsonld-Book.read.admin_Enum.read"}},"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Book-Book.read.admin_Enum.read"}}},"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":{}},"403":{"description":"Forbidden","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":"Creates a Book resource.","description":"Creates a Book resource.","parameters":[],"requestBody":{"description":"The new Book resource","content":{"application\/ld+json":{"schema":{"$ref":"#\/components\/schemas\/Book-Book.write"}},"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Book-Book.write"}}},"required":true}}},"\/admin\/books\/{id}":{"get":{"operationId":"api_adminbooks_id_get","tags":["Book"],"responses":{"200":{"description":"Book resource","content":{"application\/ld+json":{"schema":{"$ref":"#\/components\/schemas\/Book.jsonld-Book.read.admin_Enum.read"}},"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Book-Book.read.admin_Enum.read"}}}},"403":{"description":"Forbidden","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":{}},"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 Book resource.","description":"Retrieves a Book resource.","parameters":[{"name":"id","in":"path","description":"Book identifier","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false}]},"delete":{"operationId":"api_adminbooks_id_delete","tags":["Book"],"responses":{"204":{"description":"Book resource deleted"},"403":{"description":"Forbidden","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":{}},"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 Book resource.","description":"Removes the Book resource.","parameters":[{"name":"id","in":"path","description":"Book identifier","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false}]},"patch":{"operationId":"api_adminbooks_id_patch","tags":["Book"],"responses":{"200":{"description":"Book resource updated","content":{"application\/ld+json":{"schema":{"$ref":"#\/components\/schemas\/Book.jsonld-Book.read.admin_Enum.read"}},"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Book-Book.read.admin_Enum.read"}}},"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":{}},"403":{"description":"Forbidden","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":{}},"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 Book resource.","description":"Updates the Book resource.","parameters":[{"name":"id","in":"path","description":"Book identifier","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false}],"requestBody":{"description":"The updated Book resource","content":{"application\/merge-patch+json":{"schema":{"$ref":"#\/components\/schemas\/Book-Book.write.jsonMergePatch"}}},"required":true}}},"\/books":{"get":{"operationId":"api_books_get_collection","tags":["Book"],"responses":{"200":{"description":"Book collection","content":{"application\/ld+json":{"schema":{"type":"object","description":"Book.jsonld-Book.read_Enum.read collection.","allOf":[{"$ref":"#\/components\/schemas\/HydraCollectionBaseSchema"},{"type":"object","required":["hydra:member"],"properties":{"hydra:member":{"type":"array","items":{"$ref":"#\/components\/schemas\/Book.jsonld-Book.read_Enum.read"}}}}]}},"application\/json":{"schema":{"type":"array","items":{"$ref":"#\/components\/schemas\/Book-Book.read_Enum.read"}}}}}},"summary":"Retrieves the collection of Book resources.","description":"Retrieves the collection of Book resources.","parameters":[{"name":"page","in":"query","description":"The collection page number","required":false,"deprecated":false,"schema":{"type":"integer","default":1},"style":"form","explode":false},{"name":"order[title]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"string","default":"asc","enum":["asc","desc"]},"style":"form","explode":false},{"name":"title","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"string"},"style":"form","explode":false},{"name":"author","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"string"},"style":"form","explode":false},{"name":"condition","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"string"},"style":"form","explode":false},{"name":"condition[]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true}]}},"\/books\/{id}":{"get":{"operationId":"api_books_id_get","tags":["Book"],"responses":{"200":{"description":"Book resource","content":{"application\/ld+json":{"schema":{"$ref":"#\/components\/schemas\/Book.jsonld-Book.read_Enum.read"}},"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Book-Book.read_Enum.read"}}}},"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 Book resource.","description":"Retrieves a Book resource.","parameters":[{"name":"id","in":"path","description":"Book identifier","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false}]}},"\/bookmarks":{"get":{"operationId":"api_bookmarks_get_collection","tags":["Bookmark"],"responses":{"200":{"description":"Bookmark collection","content":{"application\/ld+json":{"schema":{"type":"object","description":"Bookmark.jsonld-Bookmark.read collection.","allOf":[{"$ref":"#\/components\/schemas\/HydraCollectionBaseSchema"},{"type":"object","required":["hydra:member"],"properties":{"hydra:member":{"type":"array","items":{"$ref":"#\/components\/schemas\/Bookmark.jsonld-Bookmark.read"}}}}]}},"application\/json":{"schema":{"type":"array","items":{"$ref":"#\/components\/schemas\/Bookmark-Bookmark.read"}}}}},"403":{"description":"Forbidden","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 the collection of Bookmark resources.","description":"Retrieves the collection of Bookmark resources.","parameters":[{"name":"page","in":"query","description":"The collection page number","required":false,"deprecated":false,"schema":{"type":"integer","default":1},"style":"form","explode":false},{"name":"book","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"string"},"style":"form","explode":false},{"name":"book[]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true}]},"post":{"operationId":"api_bookmarks_post","tags":["Bookmark"],"responses":{"201":{"description":"Bookmark resource created","content":{"application\/ld+json":{"schema":{"$ref":"#\/components\/schemas\/Bookmark.jsonld-Bookmark.read"}},"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Bookmark-Bookmark.read"}}},"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":{}},"403":{"description":"Forbidden","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":"Creates a Bookmark resource.","description":"Creates a Bookmark resource.","parameters":[],"requestBody":{"description":"The new Bookmark resource","content":{"application\/ld+json":{"schema":{"$ref":"#\/components\/schemas\/Bookmark-Bookmark.write"}},"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Bookmark-Bookmark.write"}}},"required":true}}},"\/bookmarks\/{id}":{"delete":{"operationId":"api_bookmarks_id_delete","tags":["Bookmark"],"responses":{"204":{"description":"Bookmark resource deleted"},"403":{"description":"Forbidden","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":{}},"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 Bookmark resource.","description":"Removes the Bookmark resource.","parameters":[{"name":"id","in":"path","description":"Bookmark identifier","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false}]}},"\/parchments":{"get":{"operationId":"api_parchments_get_collection","tags":["Parchment"],"responses":{"200":{"description":"Parchment collection","content":{"application\/ld+json":{"schema":{"type":"object","description":"Parchment.jsonld collection.","allOf":[{"$ref":"#\/components\/schemas\/HydraCollectionBaseSchema"},{"type":"object","required":["hydra:member"],"properties":{"hydra:member":{"type":"array","items":{"$ref":"#\/components\/schemas\/Parchment.jsonld"}}}}]}},"application\/json":{"schema":{"type":"array","items":{"$ref":"#\/components\/schemas\/Parchment"}}}}}},"summary":"Retrieves the collection of Parchment resources.","description":"Retrieves the collection of Parchment resources.","parameters":[{"name":"page","in":"query","description":"The collection page number","required":false,"deprecated":false,"schema":{"type":"integer","default":1},"style":"form","explode":false}],"deprecated":true},"post":{"operationId":"api_parchments_post","tags":["Parchment"],"responses":{"201":{"description":"Parchment resource created","content":{"application\/ld+json":{"schema":{"$ref":"#\/components\/schemas\/Parchment.jsonld"}},"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Parchment"}}},"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 Parchment resource.","description":"Creates a Parchment resource.","parameters":[],"requestBody":{"description":"The new Parchment resource","content":{"application\/ld+json":{"schema":{"$ref":"#\/components\/schemas\/Parchment"}},"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Parchment"}}},"required":true},"deprecated":true}},"\/parchments\/{id}":{"get":{"operationId":"api_parchments_id_get","tags":["Parchment"],"responses":{"200":{"description":"Parchment resource","content":{"application\/ld+json":{"schema":{"$ref":"#\/components\/schemas\/Parchment.jsonld"}},"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Parchment"}}}},"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 Parchment resource.","description":"Retrieves a Parchment resource.","parameters":[{"name":"id","in":"path","description":"Parchment identifier","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false}],"deprecated":true},"delete":{"operationId":"api_parchments_id_delete","tags":["Parchment"],"responses":{"204":{"description":"Parchment 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 Parchment resource.","description":"Removes the Parchment resource.","parameters":[{"name":"id","in":"path","description":"Parchment identifier","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false}],"deprecated":true},"patch":{"operationId":"api_parchments_id_patch","tags":["Parchment"],"responses":{"200":{"description":"Parchment resource updated","content":{"application\/ld+json":{"schema":{"$ref":"#\/components\/schemas\/Parchment.jsonld"}},"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Parchment"}}},"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 Parchment resource.","description":"Updates the Parchment resource.","parameters":[{"name":"id","in":"path","description":"Parchment identifier","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false}],"requestBody":{"description":"The updated Parchment resource","content":{"application\/merge-patch+json":{"schema":{"$ref":"#\/components\/schemas\/Parchment.jsonMergePatch"}}},"required":true},"deprecated":true}},"\/admin\/reviews":{"get":{"operationId":"api_adminreviews_get_collection","tags":["Review"],"responses":{"200":{"description":"Review collection","content":{"application\/ld+json":{"schema":{"type":"object","description":"Review.jsonld-Review.read_Review.read.admin collection.","allOf":[{"$ref":"#\/components\/schemas\/HydraCollectionBaseSchema"},{"type":"object","required":["hydra:member"],"properties":{"hydra:member":{"type":"array","items":{"$ref":"#\/components\/schemas\/Review.jsonld-Review.read_Review.read.admin"}}}}]}},"application\/json":{"schema":{"type":"array","items":{"$ref":"#\/components\/schemas\/Review-Review.read_Review.read.admin"}}}}},"403":{"description":"Forbidden","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 the collection of Review resources.","description":"Retrieves the collection of Review resources.","parameters":[{"name":"page","in":"query","description":"The collection page number","required":false,"deprecated":false,"schema":{"type":"integer","default":1},"style":"form","explode":false},{"name":"itemsPerPage","in":"query","description":"The number of items per page","required":false,"deprecated":false,"schema":{"type":"integer","default":30,"minimum":0,"maximum":30},"style":"form","explode":false},{"name":"user","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"string"},"style":"form","explode":false},{"name":"user[]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true},{"name":"book","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"string"},"style":"form","explode":false},{"name":"book[]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true},{"name":"rating","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"integer"},"style":"form","explode":false},{"name":"rating[]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"array","items":{"type":"integer"}},"style":"form","explode":true}]}},"\/admin\/reviews\/{id}":{"get":{"operationId":"api_adminreviews_id_get","tags":["Review"],"responses":{"200":{"description":"Review resource","content":{"application\/ld+json":{"schema":{"$ref":"#\/components\/schemas\/Review.jsonld-Review.read_Review.read.admin"}},"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Review-Review.read_Review.read.admin"}}}},"403":{"description":"Forbidden","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":{}},"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 Review resource.","description":"Retrieves a Review resource.","parameters":[{"name":"id","in":"path","description":"Review identifier","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false}]},"delete":{"operationId":"api_adminreviews_id_delete","tags":["Review"],"responses":{"204":{"description":"Review resource deleted"},"403":{"description":"Forbidden","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":{}},"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 Review resource.","description":"Removes the Review resource.","parameters":[{"name":"id","in":"path","description":"Review identifier","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false}]},"patch":{"operationId":"api_adminreviews_id_patch","tags":["Review"],"responses":{"200":{"description":"Review resource updated","content":{"application\/ld+json":{"schema":{"$ref":"#\/components\/schemas\/Review.jsonld-Review.read_Review.read.admin"}},"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Review-Review.read_Review.read.admin"}}},"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":{}},"403":{"description":"Forbidden","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":{}},"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 Review resource.","description":"Updates the Review resource.","parameters":[{"name":"id","in":"path","description":"Review identifier","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false}],"requestBody":{"description":"The updated Review resource","content":{"application\/merge-patch+json":{"schema":{"$ref":"#\/components\/schemas\/Review-Review.write_Review.write.admin.jsonMergePatch"}}},"required":true}}},"\/books\/{bookId}\/reviews":{"get":{"operationId":"api_books_bookIdreviews_get_collection","tags":["Review"],"responses":{"200":{"description":"Review collection","content":{"application\/ld+json":{"schema":{"type":"object","description":"Review.jsonld-Review.read collection.","allOf":[{"$ref":"#\/components\/schemas\/HydraCollectionBaseSchema"},{"type":"object","required":["hydra:member"],"properties":{"hydra:member":{"type":"array","items":{"$ref":"#\/components\/schemas\/Review.jsonld-Review.read"}}}}]}},"application\/json":{"schema":{"type":"array","items":{"$ref":"#\/components\/schemas\/Review-Review.read"}}}}}},"summary":"Retrieves the collection of Review resources.","description":"Retrieves the collection of Review resources.","parameters":[{"name":"bookId","in":"path","description":"Review identifier","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false},{"name":"page","in":"query","description":"The collection page number","required":false,"deprecated":false,"schema":{"type":"integer","default":1},"style":"form","explode":false},{"name":"itemsPerPage","in":"query","description":"The number of items per page","required":false,"deprecated":false,"schema":{"type":"integer","default":30,"minimum":0,"maximum":30},"style":"form","explode":false}]},"post":{"operationId":"api_books_bookIdreviews_post","tags":["Review"],"responses":{"201":{"description":"Review resource created","content":{"application\/ld+json":{"schema":{"$ref":"#\/components\/schemas\/Review.jsonld-Review.read"}},"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Review-Review.read"}}},"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":{}},"403":{"description":"Forbidden","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":"Creates a Review resource.","description":"Creates a Review resource.","parameters":[{"name":"bookId","in":"path","description":"Review identifier","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false}],"requestBody":{"description":"The new Review resource","content":{"application\/ld+json":{"schema":{"$ref":"#\/components\/schemas\/Review-Review.write"}},"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Review-Review.write"}}},"required":true}}},"\/books\/{bookId}\/reviews\/{id}":{"delete":{"operationId":"api_books_bookIdreviews_id_delete","tags":["Review"],"responses":{"204":{"description":"Review resource deleted"},"403":{"description":"Forbidden","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":{}},"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 Review resource.","description":"Removes the Review resource.","parameters":[{"name":"bookId","in":"path","description":"Review identifier","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false},{"name":"id","in":"path","description":"Review identifier","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false}]},"patch":{"operationId":"api_books_bookIdreviews_id_patch","tags":["Review"],"responses":{"200":{"description":"Review resource updated","content":{"application\/ld+json":{"schema":{"$ref":"#\/components\/schemas\/Review.jsonld-Review.read"}},"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Review-Review.read"}}},"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":{}},"403":{"description":"Forbidden","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":{}},"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 Review resource.","description":"Updates the Review resource.","parameters":[{"name":"bookId","in":"path","description":"Review identifier","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false},{"name":"id","in":"path","description":"Review identifier","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false}],"requestBody":{"description":"The updated Review resource","content":{"application\/merge-patch+json":{"schema":{"$ref":"#\/components\/schemas\/Review-Review.write.jsonMergePatch"}}},"required":true}}},"\/admin\/users":{"get":{"operationId":"api_adminusers_get_collection","tags":["User"],"responses":{"200":{"description":"User collection","content":{"application\/ld+json":{"schema":{"type":"object","description":"User.jsonld-User.read collection.","allOf":[{"$ref":"#\/components\/schemas\/HydraCollectionBaseSchema"},{"type":"object","required":["hydra:member"],"properties":{"hydra:member":{"type":"array","items":{"$ref":"#\/components\/schemas\/User.jsonld-User.read"}}}}]}},"application\/json":{"schema":{"type":"array","items":{"$ref":"#\/components\/schemas\/User-User.read"}}}}},"403":{"description":"Forbidden","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 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},{"name":"itemsPerPage","in":"query","description":"The number of items per page","required":false,"deprecated":false,"schema":{"type":"integer","default":30,"minimum":0,"maximum":30},"style":"form","explode":false},{"name":"name","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"string"},"style":"form","explode":false}]}},"\/admin\/users\/{id}":{"get":{"operationId":"api_adminusers_id_get","tags":["User"],"responses":{"200":{"description":"User resource","content":{"application\/ld+json":{"schema":{"$ref":"#\/components\/schemas\/User.jsonld-User.read"}},"application\/json":{"schema":{"$ref":"#\/components\/schemas\/User-User.read"}}}},"403":{"description":"Forbidden","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":{}},"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}]}},"\/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-User.read"}},"application\/json":{"schema":{"$ref":"#\/components\/schemas\/User-User.read"}}}},"403":{"description":"Forbidden","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":{}},"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}]}}},"components":{"schemas":{"Book-Book.read.admin_Enum.read":{"type":"object","externalDocs":{"url":"https:\/\/schema.org\/Book"},"required":["book","condition"],"properties":{"book":{"format":"uri","externalDocs":{"url":"https:\/\/schema.org\/itemOffered"},"example":"https:\/\/openlibrary.org\/books\/OL2055137M.json","type":"string"},"title":{"example":"Hyperion","type":"string"},"author":{"externalDocs":{"url":"https:\/\/schema.org\/author"},"example":"Dan Simmons","type":["string","null"]},"condition":{"externalDocs":{"url":"https:\/\/schema.org\/OfferItemCondition"},"example":"https:\/\/schema.org\/NewCondition","type":"string","enum":["https:\/\/schema.org\/NewCondition","https:\/\/schema.org\/RefurbishedCondition","https:\/\/schema.org\/DamagedCondition","https:\/\/schema.org\/UsedCondition"]},"rating":{"externalDocs":{"url":"https:\/\/schema.org\/aggregateRating"},"example":1,"type":["integer","null"]}}},"Book-Book.read_Enum.read":{"type":"object","externalDocs":{"url":"https:\/\/schema.org\/Book"},"required":["book","condition"],"properties":{"book":{"format":"uri","externalDocs":{"url":"https:\/\/schema.org\/itemOffered"},"example":"https:\/\/openlibrary.org\/books\/OL2055137M.json","type":"string"},"title":{"example":"Hyperion","type":"string"},"author":{"externalDocs":{"url":"https:\/\/schema.org\/author"},"example":"Dan Simmons","type":["string","null"]},"condition":{"externalDocs":{"url":"https:\/\/schema.org\/OfferItemCondition"},"example":"https:\/\/schema.org\/NewCondition","type":"string","enum":["https:\/\/schema.org\/NewCondition","https:\/\/schema.org\/RefurbishedCondition","https:\/\/schema.org\/DamagedCondition","https:\/\/schema.org\/UsedCondition"]},"reviews":{"readOnly":true,"externalDocs":{"url":"https:\/\/schema.org\/reviews"},"example":"\/books\/6acacc80-8321-4d83-9b02-7f2c7bf6eb1d\/reviews","type":"string","format":"iri-reference"},"rating":{"externalDocs":{"url":"https:\/\/schema.org\/aggregateRating"},"example":1,"type":["integer","null"]}}},"Book-Book.write":{"type":"object","externalDocs":{"url":"https:\/\/schema.org\/Book"},"required":["book","condition"],"properties":{"book":{"format":"uri","externalDocs":{"url":"https:\/\/schema.org\/itemOffered"},"example":"https:\/\/openlibrary.org\/books\/OL2055137M.json","type":"string"},"condition":{"externalDocs":{"url":"https:\/\/schema.org\/OfferItemCondition"},"example":"https:\/\/schema.org\/NewCondition","type":"string","enum":["https:\/\/schema.org\/NewCondition","https:\/\/schema.org\/RefurbishedCondition","https:\/\/schema.org\/DamagedCondition","https:\/\/schema.org\/UsedCondition"]}}},"Book-Book.write.jsonMergePatch":{"type":"object","externalDocs":{"url":"https:\/\/schema.org\/Book"},"properties":{"book":{"format":"uri","externalDocs":{"url":"https:\/\/schema.org\/itemOffered"},"example":"https:\/\/openlibrary.org\/books\/OL2055137M.json","type":"string"},"condition":{"externalDocs":{"url":"https:\/\/schema.org\/OfferItemCondition"},"example":"https:\/\/schema.org\/NewCondition","type":"string","enum":["https:\/\/schema.org\/NewCondition","https:\/\/schema.org\/RefurbishedCondition","https:\/\/schema.org\/DamagedCondition","https:\/\/schema.org\/UsedCondition"]}}},"Book-Bookmark.read":{"type":"object","required":["book","condition"],"properties":{"book":{"format":"uri","externalDocs":{"url":"https:\/\/schema.org\/itemOffered"},"example":"https:\/\/openlibrary.org\/books\/OL2055137M.json","type":"string"},"title":{"example":"Hyperion","type":"string"},"author":{"externalDocs":{"url":"https:\/\/schema.org\/author"},"example":"Dan Simmons","type":["string","null"]},"condition":{"externalDocs":{"url":"https:\/\/schema.org\/OfferItemCondition"},"example":"https:\/\/schema.org\/NewCondition","type":"string","enum":["https:\/\/schema.org\/NewCondition","https:\/\/schema.org\/RefurbishedCondition","https:\/\/schema.org\/DamagedCondition","https:\/\/schema.org\/UsedCondition"]},"reviews":{"readOnly":true,"externalDocs":{"url":"https:\/\/schema.org\/reviews"},"example":"\/books\/6acacc80-8321-4d83-9b02-7f2c7bf6eb1d\/reviews","type":"string","format":"iri-reference"},"rating":{"externalDocs":{"url":"https:\/\/schema.org\/aggregateRating"},"example":1,"type":["integer","null"]}}},"Book-Review.read_Review.read.admin":{"type":"object","properties":{"title":{"example":"Hyperion","type":"string"},"author":{"externalDocs":{"url":"https:\/\/schema.org\/author"},"example":"Dan Simmons","type":["string","null"]}}},"Book.jsonld-Book.read.admin_Enum.read":{"allOf":[{"$ref":"#\/components\/schemas\/HydraItemBaseSchema"},{"type":"object","externalDocs":{"url":"https:\/\/schema.org\/Book"},"required":["book","condition"],"properties":{"book":{"format":"uri","externalDocs":{"url":"https:\/\/schema.org\/itemOffered"},"example":"https:\/\/openlibrary.org\/books\/OL2055137M.json","type":"string"},"title":{"example":"Hyperion","type":"string"},"author":{"externalDocs":{"url":"https:\/\/schema.org\/author"},"example":"Dan Simmons","type":["string","null"]},"condition":{"externalDocs":{"url":"https:\/\/schema.org\/OfferItemCondition"},"example":"https:\/\/schema.org\/NewCondition","type":"string","enum":["https:\/\/schema.org\/NewCondition","https:\/\/schema.org\/RefurbishedCondition","https:\/\/schema.org\/DamagedCondition","https:\/\/schema.org\/UsedCondition"]},"rating":{"externalDocs":{"url":"https:\/\/schema.org\/aggregateRating"},"example":1,"type":["integer","null"]}}}]},"Book.jsonld-Book.read_Enum.read":{"allOf":[{"$ref":"#\/components\/schemas\/HydraItemBaseSchema"},{"type":"object","externalDocs":{"url":"https:\/\/schema.org\/Book"},"required":["book","condition"],"properties":{"book":{"format":"uri","externalDocs":{"url":"https:\/\/schema.org\/itemOffered"},"example":"https:\/\/openlibrary.org\/books\/OL2055137M.json","type":"string"},"title":{"example":"Hyperion","type":"string"},"author":{"externalDocs":{"url":"https:\/\/schema.org\/author"},"example":"Dan Simmons","type":["string","null"]},"condition":{"externalDocs":{"url":"https:\/\/schema.org\/OfferItemCondition"},"example":"https:\/\/schema.org\/NewCondition","type":"string","enum":["https:\/\/schema.org\/NewCondition","https:\/\/schema.org\/RefurbishedCondition","https:\/\/schema.org\/DamagedCondition","https:\/\/schema.org\/UsedCondition"]},"reviews":{"readOnly":true,"externalDocs":{"url":"https:\/\/schema.org\/reviews"},"example":"\/books\/6acacc80-8321-4d83-9b02-7f2c7bf6eb1d\/reviews","type":"string","format":"iri-reference"},"rating":{"externalDocs":{"url":"https:\/\/schema.org\/aggregateRating"},"example":1,"type":["integer","null"]}}}]},"Book.jsonld-Bookmark.read":{"allOf":[{"$ref":"#\/components\/schemas\/HydraItemBaseSchema"},{"type":"object","externalDocs":{"url":"https:\/\/schema.org\/Book"},"required":["book","condition"],"properties":{"book":{"format":"uri","externalDocs":{"url":"https:\/\/schema.org\/itemOffered"},"example":"https:\/\/openlibrary.org\/books\/OL2055137M.json","type":"string"},"title":{"example":"Hyperion","type":"string"},"author":{"externalDocs":{"url":"https:\/\/schema.org\/author"},"example":"Dan Simmons","type":["string","null"]},"condition":{"externalDocs":{"url":"https:\/\/schema.org\/OfferItemCondition"},"example":"https:\/\/schema.org\/NewCondition","type":"string","enum":["https:\/\/schema.org\/NewCondition","https:\/\/schema.org\/RefurbishedCondition","https:\/\/schema.org\/DamagedCondition","https:\/\/schema.org\/UsedCondition"]},"reviews":{"readOnly":true,"externalDocs":{"url":"https:\/\/schema.org\/reviews"},"example":"\/books\/6acacc80-8321-4d83-9b02-7f2c7bf6eb1d\/reviews","type":"string","format":"iri-reference"},"rating":{"externalDocs":{"url":"https:\/\/schema.org\/aggregateRating"},"example":1,"type":["integer","null"]}}}]},"Book.jsonld-Review.read_Review.read.admin":{"allOf":[{"$ref":"#\/components\/schemas\/HydraItemBaseSchema"},{"type":"object","externalDocs":{"url":"https:\/\/schema.org\/Book"},"properties":{"title":{"example":"Hyperion","type":"string"},"author":{"externalDocs":{"url":"https:\/\/schema.org\/author"},"example":"Dan Simmons","type":["string","null"]}}}]},"Bookmark-Bookmark.read":{"type":"object","externalDocs":{"url":"https:\/\/schema.org\/BookmarkAction"},"required":["book"],"properties":{"book":{"$ref":"#\/components\/schemas\/Book-Bookmark.read"},"bookmarkedAt":{"externalDocs":{"url":"https:\/\/schema.org\/startTime"},"type":"string","format":"date-time"}}},"Bookmark-Bookmark.write":{"type":"object","externalDocs":{"url":"https:\/\/schema.org\/BookmarkAction"},"required":["book"],"properties":{"book":{"externalDocs":{"url":"https:\/\/schema.org\/object"},"type":"string","format":"iri-reference","example":"https:\/\/example.com\/"}}},"Bookmark.jsonld-Bookmark.read":{"allOf":[{"$ref":"#\/components\/schemas\/HydraItemBaseSchema"},{"type":"object","externalDocs":{"url":"https:\/\/schema.org\/BookmarkAction"},"required":["book"],"properties":{"book":{"$ref":"#\/components\/schemas\/Book.jsonld-Bookmark.read"},"bookmarkedAt":{"externalDocs":{"url":"https:\/\/schema.org\/startTime"},"type":"string","format":"date-time"}}}]},"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"},"code":{"type":"string","description":"The code of the violation"},"hint":{"type":"string","description":"An extra hint to understand the violation"},"payload":{"type":"object","additionalProperties":true,"description":"The serialized payload of the violation"}},"required":["propertyPath","message"]}},"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"},"code":{"type":"string","description":"The code of the violation"},"hint":{"type":"string","description":"An extra hint to understand the violation"},"payload":{"type":"object","additionalProperties":true,"description":"The serialized payload of the violation"}},"required":["propertyPath","message"]}},"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","null"]},"detail":{"readOnly":true,"description":"A human-readable explanation specific to this occurrence of the problem.","type":["string","null"]},"status":{"type":["number","null"],"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","null"]},"detail":{"readOnly":true,"description":"A human-readable explanation specific to this occurrence of the problem.","type":["string","null"]},"status":{"type":["number","null"],"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":{"allOf":[{"$ref":"#\/components\/schemas\/HydraCollectionBaseSchemaNoPagination"},{"type":"object","properties":{"hydra:view":{"type":"object","properties":{"@id":{"type":"string","format":"iri-reference"},"@type":{"type":"string"},"hydra:first":{"type":"string","format":"iri-reference"},"hydra:last":{"type":"string","format":"iri-reference"},"hydra:previous":{"type":"string","format":"iri-reference"},"hydra:next":{"type":"string","format":"iri-reference"}},"example":{"@id":"string","type":"string","hydra:first":"string","hydra:last":"string","hydra:previous":"string","hydra:next":"string"}}}}]},"HydraCollectionBaseSchemaNoPagination":{"type":"object","properties":{"hydra:totalItems":{"type":"integer","minimum":0},"hydra:search":{"type":"object","properties":{"@type":{"type":"string"},"hydra:template":{"type":"string"},"hydra:variableRepresentation":{"type":"string"},"hydra: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"]},"Parchment":{"type":"object","deprecated":true,"properties":{"id":{"readOnly":true,"externalDocs":{"url":"https:\/\/schema.org\/identifier"},"type":"string","format":"uuid"},"title":{"type":"string"},"description":{"type":"string"}},"required":["title","description"]},"Parchment.jsonMergePatch":{"type":"object","deprecated":true,"properties":{"id":{"readOnly":true,"externalDocs":{"url":"https:\/\/schema.org\/identifier"},"type":"string","format":"uuid"},"title":{"type":"string"},"description":{"type":"string"}}},"Parchment.jsonld":{"allOf":[{"$ref":"#\/components\/schemas\/HydraItemBaseSchema"},{"type":"object","deprecated":true,"properties":{"id":{"readOnly":true,"externalDocs":{"url":"https:\/\/schema.org\/identifier"},"type":"string","format":"uuid"},"title":{"type":"string"},"description":{"type":"string"}},"required":["title","description"]}]},"Review-Review.read":{"type":"object","externalDocs":{"url":"https:\/\/schema.org\/Review"},"properties":{"user":{"$ref":"#\/components\/schemas\/User-Review.read"},"book":{"externalDocs":{"url":"https:\/\/schema.org\/itemReviewed"},"type":"string","format":"iri-reference","example":"https:\/\/example.com\/"},"publishedAt":{"externalDocs":{"url":"https:\/\/schema.org\/datePublished"},"type":"string","format":"date-time"},"body":{"externalDocs":{"url":"https:\/\/schema.org\/reviewBody"},"type":"string"},"rating":{"minimum":0,"maximum":5,"externalDocs":{"url":"https:\/\/schema.org\/reviewRating"},"type":"integer"},"letter":{"enum":["a","b","c","d"],"deprecated":true,"type":["string","null"]}},"required":["book","body","rating"]},"Review-Review.read_Review.read.admin":{"type":"object","externalDocs":{"url":"https:\/\/schema.org\/Review"},"properties":{"user":{"$ref":"#\/components\/schemas\/User-Review.read_Review.read.admin"},"book":{"$ref":"#\/components\/schemas\/Book-Review.read_Review.read.admin"},"publishedAt":{"externalDocs":{"url":"https:\/\/schema.org\/datePublished"},"type":"string","format":"date-time"},"body":{"externalDocs":{"url":"https:\/\/schema.org\/reviewBody"},"type":"string"},"rating":{"minimum":0,"maximum":5,"externalDocs":{"url":"https:\/\/schema.org\/reviewRating"},"type":"integer"},"letter":{"enum":["a","b","c","d"],"deprecated":true,"type":["string","null"]}},"required":["book","body","rating"]},"Review-Review.write":{"type":"object","externalDocs":{"url":"https:\/\/schema.org\/Review"},"required":["body","rating"],"properties":{"body":{"externalDocs":{"url":"https:\/\/schema.org\/reviewBody"},"type":"string"},"rating":{"minimum":0,"maximum":5,"externalDocs":{"url":"https:\/\/schema.org\/reviewRating"},"type":"integer"},"letter":{"enum":["a","b","c","d"],"deprecated":true,"type":["string","null"]}}},"Review-Review.write.jsonMergePatch":{"type":"object","externalDocs":{"url":"https:\/\/schema.org\/Review"},"properties":{"body":{"externalDocs":{"url":"https:\/\/schema.org\/reviewBody"},"type":"string"},"rating":{"minimum":0,"maximum":5,"externalDocs":{"url":"https:\/\/schema.org\/reviewRating"},"type":"integer"},"letter":{"enum":["a","b","c","d"],"deprecated":true,"type":["string","null"]}}},"Review-Review.write_Review.write.admin.jsonMergePatch":{"type":"object","externalDocs":{"url":"https:\/\/schema.org\/Review"},"properties":{"book":{"externalDocs":{"url":"https:\/\/schema.org\/itemReviewed"},"type":"string","format":"iri-reference","example":"https:\/\/example.com\/"},"body":{"externalDocs":{"url":"https:\/\/schema.org\/reviewBody"},"type":"string"},"rating":{"minimum":0,"maximum":5,"externalDocs":{"url":"https:\/\/schema.org\/reviewRating"},"type":"integer"},"letter":{"enum":["a","b","c","d"],"deprecated":true,"type":["string","null"]}}},"Review.jsonld-Review.read":{"allOf":[{"$ref":"#\/components\/schemas\/HydraItemBaseSchema"},{"type":"object","externalDocs":{"url":"https:\/\/schema.org\/Review"},"properties":{"user":{"$ref":"#\/components\/schemas\/User.jsonld-Review.read"},"book":{"externalDocs":{"url":"https:\/\/schema.org\/itemReviewed"},"type":"string","format":"iri-reference","example":"https:\/\/example.com\/"},"publishedAt":{"externalDocs":{"url":"https:\/\/schema.org\/datePublished"},"type":"string","format":"date-time"},"body":{"externalDocs":{"url":"https:\/\/schema.org\/reviewBody"},"type":"string"},"rating":{"minimum":0,"maximum":5,"externalDocs":{"url":"https:\/\/schema.org\/reviewRating"},"type":"integer"},"letter":{"enum":["a","b","c","d"],"deprecated":true,"type":["string","null"]}},"required":["book","body","rating"]}]},"Review.jsonld-Review.read_Review.read.admin":{"allOf":[{"$ref":"#\/components\/schemas\/HydraItemBaseSchema"},{"type":"object","externalDocs":{"url":"https:\/\/schema.org\/Review"},"properties":{"user":{"$ref":"#\/components\/schemas\/User.jsonld-Review.read_Review.read.admin"},"book":{"$ref":"#\/components\/schemas\/Book.jsonld-Review.read_Review.read.admin"},"publishedAt":{"externalDocs":{"url":"https:\/\/schema.org\/datePublished"},"type":"string","format":"date-time"},"body":{"externalDocs":{"url":"https:\/\/schema.org\/reviewBody"},"type":"string"},"rating":{"minimum":0,"maximum":5,"externalDocs":{"url":"https:\/\/schema.org\/reviewRating"},"type":"integer"},"letter":{"enum":["a","b","c","d"],"deprecated":true,"type":["string","null"]}},"required":["book","body","rating"]}]},"User-Review.read":{"type":"object","properties":{"firstName":{"externalDocs":{"url":"https:\/\/schema.org\/givenName"},"type":"string"},"lastName":{"externalDocs":{"url":"https:\/\/schema.org\/familyName"},"type":"string"},"name":{"readOnly":true,"type":"string"}}},"User-Review.read_Review.read.admin":{"type":"object","properties":{"firstName":{"externalDocs":{"url":"https:\/\/schema.org\/givenName"},"type":"string"},"lastName":{"externalDocs":{"url":"https:\/\/schema.org\/familyName"},"type":"string"},"name":{"readOnly":true,"type":"string"}}},"User-User.read":{"type":"object","externalDocs":{"url":"https:\/\/schema.org\/Person"},"properties":{"firstName":{"externalDocs":{"url":"https:\/\/schema.org\/givenName"},"type":"string"},"lastName":{"externalDocs":{"url":"https:\/\/schema.org\/familyName"},"type":"string"},"name":{"readOnly":true,"type":"string"}}},"User.jsonld-Review.read":{"allOf":[{"$ref":"#\/components\/schemas\/HydraItemBaseSchema"},{"type":"object","externalDocs":{"url":"https:\/\/schema.org\/Person"},"properties":{"firstName":{"externalDocs":{"url":"https:\/\/schema.org\/givenName"},"type":"string"},"lastName":{"externalDocs":{"url":"https:\/\/schema.org\/familyName"},"type":"string"},"name":{"readOnly":true,"type":"string"}}}]},"User.jsonld-Review.read_Review.read.admin":{"allOf":[{"$ref":"#\/components\/schemas\/HydraItemBaseSchema"},{"type":"object","externalDocs":{"url":"https:\/\/schema.org\/Person"},"properties":{"firstName":{"externalDocs":{"url":"https:\/\/schema.org\/givenName"},"type":"string"},"lastName":{"externalDocs":{"url":"https:\/\/schema.org\/familyName"},"type":"string"},"name":{"readOnly":true,"type":"string"}}}]},"User.jsonld-User.read":{"allOf":[{"$ref":"#\/components\/schemas\/HydraItemBaseSchema"},{"type":"object","externalDocs":{"url":"https:\/\/schema.org\/Person"},"properties":{"firstName":{"externalDocs":{"url":"https:\/\/schema.org\/givenName"},"type":"string"},"lastName":{"externalDocs":{"url":"https:\/\/schema.org\/familyName"},"type":"string"},"name":{"readOnly":true,"type":"string"}}}]}},"responses":{},"parameters":{},"examples":{},"requestBodies":{},"headers":{},"securitySchemes":{"oauth":{"type":"oauth2","description":"OAuth 2.0 authorization code Grant","flows":{"authorizationCode":{"authorizationUrl":"https:\/\/demo.api-platform.com\/oidc\/realms\/demo\/protocol\/openid-connect\/auth","tokenUrl":"https:\/\/demo.api-platform.com\/oidc\/realms\/demo\/protocol\/openid-connect\/token","scopes":{"openid":"(required) Indicates that the application intends to use OIDC to verify the user\u0027s identity"}}}}}},"security":[{"oauth":[]}],"tags":[{"name":"Book","description":"Resource \u0027Book\u0027 operations."},{"name":"Bookmark","description":"Resource \u0027Bookmark\u0027 operations."},{"name":"Parchment","description":"Resource \u0027Parchment\u0027 operations."},{"name":"Review","description":"Resource \u0027Review\u0027 operations."},{"name":"User","description":"Resource \u0027User\u0027 operations."}],"webhooks":{}}

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions