RetailCRM-Mirror/NelmioApiDocBundle
1
0
Fork 0
mirror of https://github.com/retailcrm/NelmioApiDocBundle.git synced 2025-02-02 15:51:48 +03:00
Code Issues Projects Releases Wiki Activity
NelmioApiDocBundle/Tests/Formatter/testFormat-result.markdown
Vitaliy Chesnokov 1c4f003e76
Doc generation for the specific API version
2019-04-25 21:50:28 +03:00

11 KiB
Raw Blame History

Popo

GET /popos

Retrieves the collection of Popo resources.

Response

foo:

  • type: string

POST /popos

Creates a Popo resource.

Parameters

foo:

  • type: string
  • required: false

Response

foo:

  • type: string

DELETE /popos/{id}

Deletes the Popo resource.

Requirements

id

  • Type: string

GET /popos/{id}

Retrieves Popo resource.

Requirements

id

  • Type: int

Response

foo:

  • type: string

PUT /popos/{id}

Replaces the Popo resource.

Requirements

id

  • Type: string

Parameters

foo:

  • type: string
  • required: false

Response

foo:

  • type: string

/api/other-resources

GET /api/other-resources.{_format}

List another resource.

Requirements

_format

  • Requirement: json|xml|html

Response

[]:

  • type: array of objects (JmsTest)

[][foo]:

  • type: string

[][bar]:

  • type: DateTime

[][number]:

  • type: double

[][arr]:

  • type: array

[][nested]:

  • type: object (JmsNested)

[][nested][foo]:

  • type: DateTime

[][nested][bar]:

  • type: string

[][nested][baz][]:

  • type: array of integers
  • description: Epic description.

With multiple lines.

[][nested][circular]:

  • type: object (JmsNested)

[][nested][parent]:

  • type: object (JmsTest)

[][nested][parent][foo]:

  • type: string

[][nested][parent][bar]:

  • type: DateTime

[][nested][parent][number]:

  • type: double

[][nested][parent][arr]:

  • type: array

[][nested][parent][nested]:

  • type: object (JmsNested)

[][nested][parent][nested_array][]:

  • type: array of objects (JmsNested)

[][nested][since]:

  • type: string
  • versions: >=0.2

[][nested][until]:

  • type: string
  • versions: <=0.3

[][nested][since_and_until]:

  • type: string
  • versions: >=0.4,<=0.5

[][nested_array][]:

  • type: array of objects (JmsNested)

PUT|PATCH /api/other-resources/{id}.{_format}

Update a resource bu ID.

Requirements

_format

  • Requirement: json|xml|html id

/api/resources

GET /api/resources.{_format}

List resources.

Requirements

_format

  • Requirement: json|xml|html

Response

tests[]:

  • type: array of objects (Test)

tests[][a]:

  • type: string

tests[][b]:

  • type: DateTime

POST /api/resources.{_format}

Create a new resource.

Requirements

_format

  • Requirement: json|xml|html

Parameters

a:

  • type: string
  • required: true
  • description: Something that describes A.

b:

  • type: float
  • required: true

c:

  • type: choice
  • required: true

d:

  • type: datetime
  • required: true

e:

  • type: date
  • required: true

g:

  • type: string
  • required: true

Response

foo:

  • type: DateTime

bar:

  • type: string

baz[]:

  • type: array of integers
  • description: Epic description.

With multiple lines.

circular:

  • type: object (JmsNested)

circular[foo]:

  • type: DateTime

circular[bar]:

  • type: string

circular[baz][]:

  • type: array of integers
  • description: Epic description.

With multiple lines.

circular[circular]:

  • type: object (JmsNested)

circular[parent]:

  • type: object (JmsTest)

circular[parent][foo]:

  • type: string

circular[parent][bar]:

  • type: DateTime

circular[parent][number]:

  • type: double

circular[parent][arr]:

  • type: array

circular[parent][nested]:

  • type: object (JmsNested)

circular[parent][nested_array][]:

  • type: array of objects (JmsNested)

circular[since]:

  • type: string
  • versions: >=0.2

circular[until]:

  • type: string
  • versions: <=0.3

circular[since_and_until]:

  • type: string
  • versions: >=0.4,<=0.5

parent:

  • type: object (JmsTest)

parent[foo]:

  • type: string

parent[bar]:

  • type: DateTime

parent[number]:

  • type: double

parent[arr]:

  • type: array

parent[nested]:

  • type: object (JmsNested)

parent[nested_array][]:

  • type: array of objects (JmsNested)

since:

  • type: string
  • versions: >=0.2

until:

  • type: string
  • versions: <=0.3

since_and_until:

  • type: string
  • versions: >=0.4,<=0.5

DELETE /api/resources/{id}.{_format}

Delete a resource by ID.

Requirements

_format

  • Requirement: json|xml|html id

GET /api/resources/{id}.{_format}

Retrieve a resource by ID.

Requirements

_format

  • Requirement: json|xml|html id

/tests

GET /tests.{_format}

index action

Requirements

_format

Filters

a:

  • DataType: integer

b:

  • DataType: string
  • Arbitrary: ["arg1","arg2"]

GET /tests.{_format}

index action

Requirements

_format

Filters

a:

  • DataType: integer

b:

  • DataType: string
  • Arbitrary: ["arg1","arg2"]

POST /tests.{_format}

create test

Requirements

_format

Parameters

a:

  • type: string
  • required: true
  • description: A nice description

b:

  • type: string
  • required: false

c:

  • type: boolean
  • required: true

d:

  • type: string
  • required: true
  • default value: DefaultTest

POST /tests.{_format}

create test

Requirements

_format

Parameters

a:

  • type: string
  • required: true
  • description: A nice description

b:

  • type: string
  • required: false

c:

  • type: boolean
  • required: true

d:

  • type: string
  • required: true
  • default value: DefaultTest

/tests2

POST /tests2.{_format}

post test 2

Requirements

_format

TestResource

ANY /named-resource

POST /another-post

create another test

Parameters

dependency_type:

  • type: object (DependencyType)
  • required: true

dependency_type[a]:

  • type: string
  • required: true
  • description: A nice description

ANY /any

Action without HTTP verb

ANY /any/{foo}

Action without HTTP verb

Requirements

foo

ANY /authenticated

POST /jms-input-test

Testing JMS

Parameters

foo:

  • type: string
  • required: false

number:

  • type: double
  • required: false

arr:

  • type: array
  • required: false

nested:

  • type: object (JmsNested)
  • required: false

nested[bar]:

  • type: string
  • required: false
  • default value: baz

nested[baz][]:

  • type: array of integers
  • required: false
  • description: Epic description.

With multiple lines.

nested[circular]:

  • type: object (JmsNested)
  • required: false

nested[parent]:

  • type: object (JmsTest)
  • required: false

nested[parent][foo]:

  • type: string
  • required: false

nested[parent][number]:

  • type: double
  • required: false

nested[parent][arr]:

  • type: array
  • required: false

nested[parent][nested]:

  • type: object (JmsNested)
  • required: false

nested[parent][nested_array][]:

  • type: array of objects (JmsNested)
  • required: false

nested[since]:

  • type: string
  • required: false

nested[until]:

  • type: string
  • required: false

nested[since_and_until]:

  • type: string
  • required: false

nested_array[]:

  • type: array of objects (JmsNested)
  • required: false

GET /jms-return-test

Testing return

Response

dependency_type:

  • type: object (DependencyType)

dependency_type[a]:

  • type: string
  • description: A nice description

ANY /my-commented/{id}/{page}/{paramType}/{param}

This method is useful to test if the getDocComment works.

Requirements

id

  • Type: int

  • Description: A nice comment page

  • Type: int paramType

  • Type: int

  • Description: The param type param

  • Type: int

  • Description: The param id

ANY /return-nested-output

Response

foo:

  • type: string

bar:

  • type: DateTime

number:

  • type: double

arr:

  • type: array

nested:

  • type: object (JmsNested)

nested[foo]:

  • type: DateTime

nested[bar]:

  • type: string

nested[baz][]:

  • type: array of integers
  • description: Epic description.

With multiple lines.

nested[circular]:

  • type: object (JmsNested)

nested[parent]:

  • type: object (JmsTest)

nested[parent][foo]:

  • type: string

nested[parent][bar]:

  • type: DateTime

nested[parent][number]:

  • type: double

nested[parent][arr]:

  • type: array

nested[parent][nested]:

  • type: object (JmsNested)

nested[parent][nested_array][]:

  • type: array of objects (JmsNested)

nested[since]:

  • type: string
  • versions: >=0.2

nested[until]:

  • type: string
  • versions: <=0.3

nested[since_and_until]:

  • type: string
  • versions: >=0.4,<=0.5

nested_array[]:

  • type: array of objects (JmsNested)

GET /route_with_host.{_format}

Route with host placeholder

Requirements

domain

  • Requirement: test.dev|test.com _format

ANY /secure-route

ANY /yet-another/{id}

Requirements

id

  • Requirement: \d+

GET /z-action-with-deprecated-indicator

This method is deprecated

POST /z-action-with-nullable-request-param

Parameters

param1:

  • type: string
  • required: false
  • description: Param1 description.

GET /z-action-with-query-param

Filters

page:

  • Requirement: \d+
  • Description: Page of the overview.
  • Default: 1

GET /z-action-with-query-param-no-default

Filters

page:

  • Requirement: \d+
  • Description: Page of the overview.

GET /z-action-with-query-param-strict

Requirements

page

  • Requirement: \d+
  • Description: Page of the overview.

POST /z-action-with-request-param

Parameters

param1:

  • type: string
  • required: true
  • description: Param1 description.

ANY /z-return-jms-and-validator-output

Response

bar:

  • type: DateTime

objects[]:

  • type: array of objects (Test)

objects[][a]:

  • type: string

objects[][b]:

  • type: DateTime

number:

  • type: DateTime

related:

  • type: object (Test)

related[a]:

  • type: string

related[b]:

  • type: DateTime

ANY /z-return-selected-parsers-input

Parameters

a:

  • type: string
  • required: true
  • description: A nice description

b:

  • type: string
  • required: false

c:

  • type: boolean
  • required: true

d:

  • type: string
  • required: true
  • default value: DefaultTest

ANY /z-return-selected-parsers-output

Response

bar:

  • type: DateTime

objects[]:

  • type: array of objects (Test)

objects[][a]:

  • type: string

objects[][b]:

  • type: DateTime

number:

  • type: DateTime

related:

  • type: object (Test)

related[a]:

  • type: string

related[b]:

  • type: DateTime

POST /zcached

POST /zsecured

GET /zz-tests-route-version.{_format}

Requirements

_format