Last active
February 9, 2025 20:52
-
-
Save soyuka/20d0d216c3fce1b68165dbbf58381e02 to your computer and use it in GitHub Desktop.
API Platform OpenAPI generated specification
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
openapi: 3.1.0 | |
info: | |
title: 'My Dummy API' | |
description: |- | |
This is a test API. | |
Made with love | |
version: 0.0.0 | |
servers: | |
- | |
url: / | |
description: '' | |
paths: | |
'/books/by_isbn/{isbn}': | |
get: | |
operationId: api_booksby_isbn_isbn_get | |
tags: | |
- Book | |
responses: | |
'200': | |
description: 'Book resource' | |
content: | |
application/ld+json: | |
schema: | |
$ref: '#/components/schemas/Book' | |
application/hal+json: | |
schema: | |
$ref: '#/components/schemas/Book' | |
application/vnd.api+json: | |
schema: | |
$ref: '#/components/schemas/Book' | |
application/xml: { } | |
text/xml: { } | |
application/json: | |
schema: | |
$ref: '#/components/schemas/Book' | |
text/html: { } | |
application/graphql: { } | |
multipart/form-data: { } | |
'404': | |
description: 'Not found' | |
content: | |
application/vnd.api+json: | |
schema: | |
$ref: '#/components/schemas/Error' | |
application/ld+json: | |
schema: | |
$ref: '#/components/schemas/Error' | |
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: isbn | |
in: path | |
description: 'Book identifier' | |
required: true | |
deprecated: false | |
allowEmptyValue: false | |
schema: | |
type: string | |
style: simple | |
explode: false | |
allowReserved: false | |
deprecated: false | |
'/books/{id}': | |
get: | |
operationId: api_books_id_get | |
tags: | |
- Book | |
responses: | |
'200': | |
description: 'Book resource' | |
content: | |
application/ld+json: | |
schema: | |
$ref: '#/components/schemas/Book' | |
application/hal+json: | |
schema: | |
$ref: '#/components/schemas/Book' | |
application/vnd.api+json: | |
schema: | |
$ref: '#/components/schemas/Book' | |
application/xml: { } | |
text/xml: { } | |
application/json: | |
schema: | |
$ref: '#/components/schemas/Book' | |
text/html: { } | |
application/graphql: { } | |
multipart/form-data: { } | |
'404': | |
description: 'Not found' | |
content: | |
application/vnd.api+json: | |
schema: | |
$ref: '#/components/schemas/Error' | |
application/ld+json: | |
schema: | |
$ref: '#/components/schemas/Error' | |
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 | |
allowEmptyValue: false | |
schema: | |
type: string | |
style: simple | |
explode: false | |
allowReserved: false | |
deprecated: false | |
components: | |
schemas: | |
Book: | |
type: object | |
description: Book. | |
$id: /schemas/Book | |
deprecated: false | |
properties: | |
id: | |
readOnly: true | |
type: integer | |
name: | |
type: string | |
isbn: | |
type: string | |
Book.jsonapi: | |
properties: | |
data: | |
type: object | |
properties: | |
id: | |
type: string | |
type: | |
type: string | |
attributes: | |
$ref: /schemas/Book | |
required: | |
- type | |
- id | |
Book.jsonhal: | |
allOf: | |
- | |
type: object | |
properties: | |
_links: | |
type: object | |
properties: | |
self: | |
type: object | |
properties: { href: { type: string, format: iri-reference } } | |
- | |
$ref: /schemas/Book | |
Book.jsonld: | |
allOf: | |
- | |
type: object | |
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 | |
- | |
$ref: /schemas/Book | |
Error: | |
type: object | |
description: 'A representation of common errors.' | |
$id: /schemas/Error | |
deprecated: false | |
properties: | |
id: | |
type: | |
- string | |
- 'null' | |
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 | |
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 | |
meta: | |
type: object | |
source: | |
type: object | |
properties: | |
pointer: | |
type: string | |
parameter: | |
type: string | |
header: | |
type: string | |
Error.jsonapi: | |
properties: | |
errors: | |
type: array | |
items: | |
allOf: | |
- | |
$ref: /schemas/Error | |
- | |
type: object | |
properties: | |
source: { type: object } | |
status: { type: string } | |
Error.jsonld: | |
allOf: | |
- | |
type: object | |
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 | |
- | |
$ref: /schemas/Error | |
responses: { } | |
parameters: { } | |
examples: { } | |
requestBodies: { } | |
headers: { } | |
securitySchemes: | |
oauth: | |
type: oauth2 | |
description: 'OAuth 2.0 implicit Grant' | |
flows: | |
implicit: | |
authorizationUrl: 'http://my-custom-server/openid-connect/auth' | |
scopes: { } | |
Some_Authorization_Name: | |
type: apiKey | |
description: 'Value for the Authorization header parameter.' | |
name: Authorization | |
in: header | |
security: | |
- | |
oauth: [] | |
- | |
Some_Authorization_Name: [] | |
tags: | |
- | |
name: Book | |
description: Book. | |
webhooks: { } |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment