Skip to content

Instantly share code, notes, and snippets.

@oleg-andreyev
Created January 9, 2020 22:26
Show Gist options
  • Save oleg-andreyev/b5d53144c88fad82324f817e839ba927 to your computer and use it in GitHub Desktop.
Save oleg-andreyev/b5d53144c88fad82324f817e839ba927 to your computer and use it in GitHub Desktop.
APIP YAML reference
<FQCN>:
shortName: <string>
description: <string>
iri: <string>
itemOperations:
get:
method: GET
produces: ~
summary: ~
description: ~
responses: ~
parameters:
-
name:
in: query
required: true
type:
schema:
style:
explode:
deprecation_reason:
route_name: <string>
operationId: <string>
output_formats:
json: <mime>
input_formats:
json: <mime>
input:
name: <string>
class: <string>
output:
name: <string>
class: <string>
deserialize:
validate:
status:
collectionOperations:
get:
method: GET
input:
name: <string>
class: <string>
output:
name: <string>
class: <string>
deserialize:
validate:
status:
subresourceOperations: ???
graphql:
get:
method: GET
input:
name: <string>
class: <string>
output:
name: <string>
class: <string>
deserialize:
validate:
status:
attributes: ???
properties:
<propertyName>:
description: <string>
readable: <bool>
writable: <bool>
readableLink: <bool>
writableLink: <bool>
required: <bool>
identifier: <bool>
iri: <string>
attributes: ???
subresource: ???
@bochkarev-artem
Copy link

bochkarev-artem commented Feb 5, 2020

i think parameters on line 12 should be under openapi_context:, it will not work otherwise (just checked it on latest api_platform version)
Docs for this: https://api-platform.com/docs/core/swagger/#changing-operations-in-the-openapi-documentation

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