/foo/:name/:type

lorem ipsum
Path-ParametersPath

GET

Returns a collection
Operation-Idlist.foo
Query-ParametersGetQuery
Response 200EntryCollection

POST

Operation-Idcreate.foo
RequestEntryCreate
Response 201EntryMessage

PUT

RequestEntryUpdate
Response 200EntryMessage

DELETE

RequestEntryDelete
Response 200EntryMessage

PATCH

RequestEntryPatch
Response 200EntryMessage

Path

{
  "name": String,
  "type": String,
}
FieldDescription
nameString
Name parameter
MaxLength
16
Pattern
[A-z]+
typeString
Enum
  • "foo"
  • "bar"

GetQuery

{
  "startIndex": Integer,
  "float": Number,
  "boolean": Boolean,
  "date": Date,
  "datetime": DateTime,
}
FieldDescription
startIndexInteger
startIndex parameter
Maximum
32
floatNumber
booleanBoolean
dateDate
datetimeDateTime

EntryCollection

{
  "entry": Array (Entry),
}
FieldDescription
entryArray (Entry)

Entry

{
  "id": Integer,
  "userId": Integer,
  "title": String,
  "date": DateTime,
}
FieldDescription
idInteger
userIdInteger
titleString
MinLength
3
MaxLength
16
Pattern
[A-z]+
dateDateTime

EntryCreate

{
  "id": Integer,
  "userId": Integer,
  "title": String,
  "date": DateTime,
}
FieldDescription
idInteger
userIdInteger
titleString
MinLength
3
MaxLength
16
Pattern
[A-z]+
dateDateTime

EntryMessage

{
  "success": Boolean,
  "message": String,
}
FieldDescription
successBoolean
messageString

EntryUpdate

{
  "id": Integer,
  "userId": Integer,
  "title": String,
  "date": DateTime,
}
FieldDescription
idInteger
userIdInteger
titleString
MinLength
3
MaxLength
16
Pattern
[A-z]+
dateDateTime

EntryDelete

{
  "id": Integer,
  "userId": Integer,
  "title": String,
  "date": DateTime,
}
FieldDescription
idInteger
userIdInteger
titleString
MinLength
3
MaxLength
16
Pattern
[A-z]+
dateDateTime

EntryPatch

{
  "id": Integer,
  "userId": Integer,
  "title": String,
  "date": DateTime,
}
FieldDescription
idInteger
userIdInteger
titleString
MinLength
3
MaxLength
16
Pattern
[A-z]+
dateDateTime