2017 © Pedro Peláez
 

library vk-api-schema

VK API JSON Schema

image

vkcom/vk-api-schema

VK API JSON Schema

  • Monday, July 2, 2018
  • by tsivarev
  • Repository
  • 26 Watchers
  • 94 Stars
  • 74 Installations
  • 2 Dependents
  • 0 Suggesters
  • 36 Forks
  • 4 Open issues
  • 26 Versions
  • 28 % Grown

The README.md

VK API JSON Schema

This repository contains JSON Schema documents explaining all the VK.COM API objects and methods mentioned here., (*1)

JSON Schema standard specifications and the most common usage scenarios could be found here: http://json-schema.org/, (*2)

These schemes are compatible with JSON Schema version draft-07 and VK API version 5.124., (*3)

Packagist, (*4)

Structure

Repository contains several .json files. * "methods.json" describes all of VK API methods (could be found at this page). * "objects.json" describes objects which are used in methods responses. * "responses.json" describes methods responses structure. * "errors.json" describes possible method errors. * "schema.json" describes additional keywords used in our implementation, such as "method", "error", "parameter" and others so to extend the canonical specification for our needs., (*5)

Samples

users.get method description:

{
      "name": "users.get",
      "description": "Returns detailed information on users.",
      "open": true,
      "parameters": [
        {
          "name": "user_ids",
          "description": "User IDs or screen names ('screen_name'). By default, current user ID.",
          "type": "array",
          "items": {
            "type": "string"
          },
          "maxItems": 1000
        },
        {
          "name": "domains",
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        {
          "name": "fields",
          "description": "Profile fields to return. Sample values: 'nickname', 'screen_name', 'sex', 'bdate' (birthdate), 'city', 'country', 'timezone', 'photo', 'photo_medium', 'photo_big', 'has_mobile', 'contacts', 'education', 'online', 'counters', 'relation', 'last_seen', 'activity', 'can_write_private_message', 'can_see_all_posts', 'can_post', 'universities';",
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        {
          "name": "name_case",
          "description": "Case for declension of user name and surname:; 'nom' — nominative (default); 'gen' — genitive ; 'dat' — dative; 'acc' — accusative ; 'ins' — instrumental ; 'abl' — prepositional",
          "type": "string"
        }
      ],
      "responses": {
        "response": {
          "$ref": "responses.json#/definitions/users_get_response"
        }
      }
    }

market_market_album object description:

"market_market_album": {
      "type": "object",
      "properties": {
        "id": {
          "type": "integer",
          "description": "Market album ID",
          "minimum": 1
        },
        "owner_id": {
          "type": "integer",
          "description": "Market album owner's ID"
        },
        "title": {
          "type": "string",
          "description": "Market album title"
        },
        "count": {
          "type": "integer",
          "description": "Items number",
          "minimum": 0
        },
        "updated_time": {
          "type": "integer",
          "description": "Date when album has been updated last time in Unixtime",
          "minimum": 0
        },
        "photo": {
          "$ref": "#/definitions/photos_photo"
        }
      },
      "required": [
        "id",
        "owner_id",
        "title",
        "count",
        "updated_time"
      ],
      "additionalProperties": false
    }

The Versions

02/07 2018

dev-master

9999999-dev https://vk.com/dev

VK API JSON Schema

  Sources   Download

MIT

02/07 2018

5.80.1

5.80.1.0 https://vk.com/dev

VK API JSON Schema

  Sources   Download

MIT

02/07 2018

dev-develop

dev-develop https://vk.com/dev

VK API JSON Schema

  Sources   Download

MIT

02/07 2018

5.80.0

5.80.0.0 https://vk.com/dev

VK API JSON Schema

  Sources   Download

MIT

09/04 2018

1.8.0

1.8.0.0 https://vk.com/dev

VK API JSON Schema

  Sources   Download

MIT

05/03 2018

1.7.3

1.7.3.0 https://vk.com/dev

VK API JSON Schema

  Sources   Download

MIT

28/02 2018

1.7.2

1.7.2.0 https://vk.com/dev

VK API JSON Schema

  Sources   Download

MIT

28/02 2018

1.7.1

1.7.1.0 https://vk.com/dev

VK API JSON Schema

  Sources   Download

MIT

28/02 2018

1.7.0

1.7.0.0 https://vk.com/dev

VK API JSON Schema

  Sources   Download

MIT

15/02 2018

1.6.0

1.6.0.0 https://vk.com/dev

VK API JSON Schema

  Sources   Download

MIT

09/01 2018

1.5.1

1.5.1.0 https://vk.com/dev

VK API JSON Schema

  Sources   Download

MIT

27/12 2017

1.5.0

1.5.0.0 https://vk.com/dev

VK API JSON Schema

  Sources   Download

MIT

22/12 2017

1.4.1

1.4.1.0 https://vk.com/dev

VK API JSON Schema

  Sources   Download

MIT

22/12 2017

1.4.0

1.4.0.0 https://vk.com/dev

VK API JSON Schema

  Sources   Download

MIT

01/02 2017

1.3.3

1.3.3.0 https://vk.com/dev

VK API JSON Schema

  Sources   Download

MIT

11/01 2017

1.3.2

1.3.2.0 https://vk.com/dev

VK API JSON Schema

  Sources   Download

MIT

10/01 2017

1.3.1

1.3.1.0 https://vk.com/dev

VK API JSON Schema

  Sources   Download

MIT

10/01 2017

1.3.0

1.3.0.0 https://vk.com/dev

VK API JSON Schema

  Sources   Download

MIT

09/01 2017

1.2.5

1.2.5.0 https://vk.com/dev

VK API JSON Schema

  Sources   Download

MIT

09/01 2017

1.2.4

1.2.4.0 https://vk.com/dev

VK API JSON Schema

  Sources   Download

MIT

23/12 2016

1.2.3

1.2.3.0 https://vk.com/dev

VK API JSON Schema

  Sources   Download

MIT

23/12 2016

1.2.2

1.2.2.0 https://vk.com/dev

VK API JSON Schema

  Sources   Download

MIT

20/12 2016

1.2.0

1.2.0.0 https://vk.com/dev

VK API JSON Schema

  Sources   Download

MIT

20/12 2016

1.2.1

1.2.1.0 https://vk.com/dev

VK API JSON Schema

  Sources   Download

MIT

12/12 2016

1.1.0

1.1.0.0 https://vk.com/dev

VK API JSON Schema

  Sources   Download

MIT

07/12 2016

1.0.0

1.0.0.0 https://vk.com/dev

VK API JSON Schema

  Sources   Download

MIT