jeyroik/extas-operations-jsonrpc-index

There is no license information available for the latest version (0.2.1) of this package.

Index operation for JSON RPC

0.2.1 2020-12-01 09:07 UTC

Requires

• jeyroik/extas-api-jsonrpc: 0.*
• jeyroik/extas-conditions: 1.*
• jeyroik/extas-operations-jsonrpc: 1.*
• jeyroik/extas-protocols-jsonrpc-expand: 0.*
• jeyroik/extas-repositories: 0.*

Requires (Dev)

• jeyroik/extas-repositories-mongo: 1.*
• jeyroik/extas-snuffbox: 0.*
• jeyroik/extas-snuffbox-conditions: 0.*
• jeyroik/extas-snuffbox-repositories: 0.*
• phpstan/phpstan: 0.*
• phpunit/phpunit: ^9
• vlucas/phpdotenv: ^3.4

Unknown License

README

extas-operations-jsonrpc-index

Index operation for JSON RPC.

Спецификация

{
  "request": {
    "type": "object",
    "properties": {
      "select": {
      		"type": "array",
      		"items": {"type": "string"}
      	},
      	"filter": {
      		"type": "object",
      		"properties": {}
      	},
      	"sort": {
      		"type": "object",
      		"properties": {}
      	},
      	"limit": {
      		"type": "number"
      	},
      	"offset": {
      		"type": "number"
      	}
    }
  }
}

Пример запроса

{
  "id": "2f5d0719-5b82-4280-9b3b-10f23aff226b",
  "method": "snuff.index",
  "params": {
    "limit": 1,
    "offset": 0,
    "sort": {"name": -1},
    "select": ["name", "value"],
    "expand": ["snuff.item.description"],
    "filter": {
      "name": {
        "~": "test"
      }
    }
  }
}

Примечание возможности expand можно изучить в документации пакета extas-expands.