Steve-Dee-Designs
/
woocommerce
mirror of https://github.com/woocommerce/woocommerce.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

[REST API] Fixed product variation schema

This commit is contained in:
Claudio Sanches 2016-05-31 20:34:15 -03:00
parent e24e44ae09
commit 29645fa1d7
1 changed files with 29 additions and 45 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

74
includes/api/class-wc-rest-products-controller.php
View File

@ -1687,7 +1687,9 @@ class WC_REST_Products_Controller extends WC_REST_Posts_Controller {
* @return array * @return array
*/ */
public function get_item_schema() { public function get_item_schema() {
$schema = array( $weight_unit = get_option( 'woocommerce_weight_unit' );
$dimension_unit = get_option( 'woocommerce_dimension_unit' );
$schema = array(
'$schema' => 'http://json-schema.org/draft-04/schema#', '$schema' => 'http://json-schema.org/draft-04/schema#',
'title' => $this->post_type, 'title' => $this->post_type,
'type' => 'object', 'type' => 'object',
@ -1939,7 +1941,7 @@ class WC_REST_Products_Controller extends WC_REST_Posts_Controller {
'context' => array( 'view', 'edit' ), 'context' => array( 'view', 'edit' ),
), ),
'weight' => array( 'weight' => array(
'description' => sprintf( __( 'Product weight (%s).', 'woocommerce' ), get_option( 'woocommerce_weight_unit' ) ), 'description' => sprintf( __( 'Product weight (%s).', 'woocommerce' ), $weight_unit ),
'type' => 'string', 'type' => 'string',
'context' => array( 'view', 'edit' ), 'context' => array( 'view', 'edit' ),
), ),
@ -1949,17 +1951,17 @@ class WC_REST_Products_Controller extends WC_REST_Posts_Controller {
'context' => array( 'view', 'edit' ), 'context' => array( 'view', 'edit' ),
'properties' => array( 'properties' => array(
'length' => array( 'length' => array(
'description' => sprintf( __( 'Product length (%s).', 'woocommerce' ), get_option( 'woocommerce_dimension_unit' ) ), 'description' => sprintf( __( 'Product length (%s).', 'woocommerce' ), $dimension_unit ),
'type' => 'string', 'type' => 'string',
'context' => array( 'view', 'edit' ), 'context' => array( 'view', 'edit' ),
), ),
'width' => array( 'width' => array(
'description' => sprintf( __( 'Product width (%s).', 'woocommerce' ), get_option( 'woocommerce_dimension_unit' ) ), 'description' => sprintf( __( 'Product width (%s).', 'woocommerce' ), $dimension_unit ),
'type' => 'string', 'type' => 'string',
'context' => array( 'view', 'edit' ), 'context' => array( 'view', 'edit' ),
), ),
'height' => array( 'height' => array(
'description' => sprintf( __( 'Product height (%s).', 'woocommerce' ), get_option( 'woocommerce_dimension_unit' ) ), 'description' => sprintf( __( 'Product height (%s).', 'woocommerce' ), $dimension_unit ),
'type' => 'string', 'type' => 'string',
'context' => array( 'view', 'edit' ), 'context' => array( 'view', 'edit' ),
), ),
@ -2089,7 +2091,6 @@ class WC_REST_Products_Controller extends WC_REST_Posts_Controller {
'description' => __( 'Image ID.', 'woocommerce' ), 'description' => __( 'Image ID.', 'woocommerce' ),
'type' => 'integer', 'type' => 'integer',
'context' => array( 'view', 'edit' ), 'context' => array( 'view', 'edit' ),
'readonly' => true,
), ),
'date_created' => array( 'date_created' => array(
'description' => __( "The date the image was created, in the site's timezone.", 'woocommerce' ), 'description' => __( "The date the image was created, in the site's timezone.", 'woocommerce' ),
@ -2182,7 +2183,7 @@ class WC_REST_Products_Controller extends WC_REST_Posts_Controller {
'context' => array( 'view', 'edit' ), 'context' => array( 'view', 'edit' ),
), ),
'option' => array( 'option' => array(
'description' => __( 'Selected term name of the attribute.', 'woocommerce' ), 'description' => __( 'Selected attribute term name.', 'woocommerce' ),
'type' => 'string', 'type' => 'string',
'context' => array( 'view', 'edit' ), 'context' => array( 'view', 'edit' ),
), ),
@ -2212,7 +2213,7 @@ class WC_REST_Products_Controller extends WC_REST_Posts_Controller {
'readonly' => true, 'readonly' => true,
), ),
'permalink' => array( 'permalink' => array(
'description' => __( 'Product URL.', 'woocommerce' ), 'description' => __( 'Variation URL.', 'woocommerce' ),
'type' => 'string', 'type' => 'string',
'format' => 'uri', 'format' => 'uri',
'context' => array( 'view', 'edit' ), 'context' => array( 'view', 'edit' ),
@ -2224,18 +2225,18 @@ class WC_REST_Products_Controller extends WC_REST_Posts_Controller {
'context' => array( 'view', 'edit' ), 'context' => array( 'view', 'edit' ),
), ),
'price' => array( 'price' => array(
'description' => __( 'Current product price.', 'woocommerce' ), 'description' => __( 'Current variation price.', 'woocommerce' ),
'type' => 'string', 'type' => 'string',
'context' => array( 'view', 'edit' ), 'context' => array( 'view', 'edit' ),
'readonly' => true, 'readonly' => true,
), ),
'regular_price' => array( 'regular_price' => array(
'description' => __( 'Product regular price.', 'woocommerce' ), 'description' => __( 'Variation regular price.', 'woocommerce' ),
'type' => 'string', 'type' => 'string',
'context' => array( 'view', 'edit' ), 'context' => array( 'view', 'edit' ),
), ),
'sale_price' => array( 'sale_price' => array(
'description' => __( 'Product sale price.', 'woocommerce' ), 'description' => __( 'Variation sale price.', 'woocommerce' ),
'type' => 'string', 'type' => 'string',
'context' => array( 'view', 'edit' ), 'context' => array( 'view', 'edit' ),
), ),
@ -2250,25 +2251,25 @@ class WC_REST_Products_Controller extends WC_REST_Posts_Controller {
'context' => array( 'view', 'edit' ), 'context' => array( 'view', 'edit' ),
), ),
'on_sale' => array( 'on_sale' => array(
'description' => __( 'Shows if the product is on sale.', 'woocommerce' ), 'description' => __( 'Shows if the variation is on sale.', 'woocommerce' ),
'type' => 'boolean', 'type' => 'boolean',
'context' => array( 'view', 'edit' ), 'context' => array( 'view', 'edit' ),
'readonly' => true, 'readonly' => true,
), ),
'purchasable' => array( 'purchasable' => array(
'description' => __( 'Shows if the product can be bought.', 'woocommerce' ), 'description' => __( 'Shows if the variation can be bought.', 'woocommerce' ),
'type' => 'boolean', 'type' => 'boolean',
'context' => array( 'view', 'edit' ), 'context' => array( 'view', 'edit' ),
'readonly' => true, 'readonly' => true,
), ),
'virtual' => array( 'virtual' => array(
'description' => __( 'If the product is virtual.', 'woocommerce' ), 'description' => __( 'If the variation is virtual.', 'woocommerce' ),
'type' => 'boolean', 'type' => 'boolean',
'default' => false, 'default' => false,
'context' => array( 'view', 'edit' ), 'context' => array( 'view', 'edit' ),
), ),
'downloadable' => array( 'downloadable' => array(
'description' => __( 'If the product is downloadable.', 'woocommerce' ), 'description' => __( 'If the variation is downloadable.', 'woocommerce' ),
'type' => 'boolean', 'type' => 'boolean',
'default' => false, 'default' => false,
'context' => array( 'view', 'edit' ), 'context' => array( 'view', 'edit' ),
@ -2297,13 +2298,13 @@ class WC_REST_Products_Controller extends WC_REST_Posts_Controller {
), ),
), ),
'download_limit' => array( 'download_limit' => array(
'description' => __( 'Amount of times the product can be downloaded.', 'woocommerce' ), 'description' => __( 'Amount of times the variation can be downloaded.', 'woocommerce' ),
'type' => 'integer', 'type' => 'integer',
'default' => null, 'default' => null,
'context' => array( 'view', 'edit' ), 'context' => array( 'view', 'edit' ),
), ),
'download_expiry' => array( 'download_expiry' => array(
'description' => __( 'Number of days that the customer has up to be able to download the product.', 'woocommerce' ), 'description' => __( 'Number of days that the customer has up to be able to download the variation.', 'woocommerce' ),
'type' => 'integer', 'type' => 'integer',
'default' => null, 'default' => null,
'context' => array( 'view', 'edit' ), 'context' => array( 'view', 'edit' ),
@ -2321,7 +2322,7 @@ class WC_REST_Products_Controller extends WC_REST_Posts_Controller {
'context' => array( 'view', 'edit' ), 'context' => array( 'view', 'edit' ),
), ),
'manage_stock' => array( 'manage_stock' => array(
'description' => __( 'Stock management at product level.', 'woocommerce' ), 'description' => __( 'Stock management at variation level.', 'woocommerce' ),
'type' => 'boolean', 'type' => 'boolean',
'default' => false, 'default' => false,
'context' => array( 'view', 'edit' ), 'context' => array( 'view', 'edit' ),
@ -2332,7 +2333,7 @@ class WC_REST_Products_Controller extends WC_REST_Posts_Controller {
'context' => array( 'view', 'edit' ), 'context' => array( 'view', 'edit' ),
), ),
'in_stock' => array( 'in_stock' => array(
'description' => __( 'Controls whether or not the product is listed as "in stock" or "out of stock" on the frontend.', 'woocommerce' ), 'description' => __( 'Controls whether or not the variation is listed as "in stock" or "out of stock" on the frontend.', 'woocommerce' ),
'type' => 'boolean', 'type' => 'boolean',
'default' => true, 'default' => true,
'context' => array( 'view', 'edit' ), 'context' => array( 'view', 'edit' ),
@ -2351,33 +2352,33 @@ class WC_REST_Products_Controller extends WC_REST_Posts_Controller {
'readonly' => true, 'readonly' => true,
), ),
'backordered' => array( 'backordered' => array(
'description' => __( 'Shows if a product is on backorder.', 'woocommerce' ), 'description' => __( 'Shows if a variation is on backorder.', 'woocommerce' ),
'type' => 'boolean', 'type' => 'boolean',
'context' => array( 'view', 'edit' ), 'context' => array( 'view', 'edit' ),
'readonly' => true, 'readonly' => true,
), ),
'weight' => array( 'weight' => array(
'description' => sprintf( __( 'Product weight (%s).', 'woocommerce' ), get_option( 'woocommerce_weight_unit' ) ), 'description' => sprintf( __( 'Variation weight (%s).', 'woocommerce' ), $weight_unit ),
'type' => 'string', 'type' => 'string',
'context' => array( 'view', 'edit' ), 'context' => array( 'view', 'edit' ),
), ),
'dimensions' => array( 'dimensions' => array(
'description' => __( 'Product dimensions.', 'woocommerce' ), 'description' => __( 'Variation dimensions.', 'woocommerce' ),
'type' => 'array', 'type' => 'array',
'context' => array( 'view', 'edit' ), 'context' => array( 'view', 'edit' ),
'properties' => array( 'properties' => array(
'length' => array( 'length' => array(
'description' => sprintf( __( 'Product length (%s).', 'woocommerce' ), get_option( 'woocommerce_dimension_unit' ) ), 'description' => sprintf( __( 'Variation length (%s).', 'woocommerce' ), $dimension_unit ),
'type' => 'string', 'type' => 'string',
'context' => array( 'view', 'edit' ), 'context' => array( 'view', 'edit' ),
), ),
'width' => array( 'width' => array(
'description' => sprintf( __( 'Product width (%s).', 'woocommerce' ), get_option( 'woocommerce_dimension_unit' ) ), 'description' => sprintf( __( 'Variation width (%s).', 'woocommerce' ), $dimension_unit ),
'type' => 'string', 'type' => 'string',
'context' => array( 'view', 'edit' ), 'context' => array( 'view', 'edit' ),
), ),
'height' => array( 'height' => array(
'description' => sprintf( __( 'Product height (%s).', 'woocommerce' ), get_option( 'woocommerce_dimension_unit' ) ), 'description' => sprintf( __( 'Variation height (%s).', 'woocommerce' ), $dimension_unit ),
'type' => 'string', 'type' => 'string',
'context' => array( 'view', 'edit' ), 'context' => array( 'view', 'edit' ),
), ),
@ -2456,26 +2457,9 @@ class WC_REST_Products_Controller extends WC_REST_Posts_Controller {
'type' => 'string', 'type' => 'string',
'context' => array( 'view', 'edit' ), 'context' => array( 'view', 'edit' ),
), ),
'position' => array( 'option' => array(
'description' => __( 'Attribute position.', 'woocommerce' ), 'description' => __( 'Selected attribute term name.', 'woocommerce' ),
'type' => 'integer', 'type' => 'string',
'context' => array( 'view', 'edit' ),
),
'visible' => array(
'description' => __( "Define if the attribute is visible on the \"Additional Information\" tab in the product's page.", 'woocommerce' ),
'type' => 'boolean',
'default' => false,
'context' => array( 'view', 'edit' ),
),
'variation' => array(
'description' => __( 'Define if the attribute can be used as variation.', 'woocommerce' ),
'type' => 'boolean',
'default' => false,
'context' => array( 'view', 'edit' ),
),
'options' => array(
'description' => __( 'List of available term names of the attribute.', 'woocommerce' ),
'type' => 'array',
'context' => array( 'view', 'edit' ), 'context' => array( 'view', 'edit' ),
), ),
), ),