Add schemas

Author: ryelle

includes/api/class-wc-rest-data-controller.php

@@ -123,4 +123,36 @@ public function prepare_item_for_response( $resource, $request ) {
 
 		return $response;
 	}
+
+	/**
+	 * Get the data index schema, conforming to JSON Schema.
+	 *
+	 * @return array
+	 */
+	public function get_item_schema() {
+		$schema = array(
+			'$schema' => 'http://json-schema.org/draft-04/schema#',
+			'title'   => 'data_index',
+			'type'    => 'array',
+			'items'   => array(
+				'type' => 'object',
+				'properties' => array(
+					'slug' => array(
+						'description' => __( 'Data resource ID.', 'woocommerce' ),
+						'type'        => 'string',
+						'context'     => array( 'view' ),
+						'readonly'    => true,
+					),
+					'description' => array(
+						'description' => __( 'Data resource description.', 'woocommerce' ),
+						'type'        => 'string',
+						'context'     => array( 'view' ),
+						'readonly'    => true,
+					),
+				),
+			),
+		);
+
+		return $this->add_additional_fields_schema( $schema );
+	}
 }

includes/api/class-wc-rest-data-locations-controller.php

@@ -143,4 +143,71 @@ public function prepare_item_for_response( $item, $request ) {
 		$response = rest_ensure_response( $item );
 		return $response;
 	}
+
+
+	/**
+	 * Get the location schema, conforming to JSON Schema.
+	 *
+	 * @since  3.1.0
+	 * @return array
+	 */
+	public function get_item_schema() {
+		$schema = array(
+			'$schema' => 'http://json-schema.org/draft-04/schema#',
+			'title'   => 'data_locations',
+			'type'    => 'array',
+			'items'   => array(
+				'type'       => 'object',
+				'properties' => array(
+					'code' => array(
+						'type'        => 'string',
+						'description' => __( '2-character continent code', 'woocommerce' ),
+						'context'     => array( 'view' ),
+						'readonly'    => true,
+					),
+					'name' => array(
+						'type'        => 'string',
+						'description' => __( 'Full name of continent', 'woocommerce' ),
+						'context'     => array( 'view' ),
+						'readonly'    => true,
+					),
+					'countries' => array(
+						'type'     => 'array',
+						'context'  => array( 'view' ),
+						'readonly' => true,
+						'items'    => array(
+							'type'       => 'object',
+							'context'    => array( 'view' ),
+							'readonly'   => true,
+							'properties' => array(
+								'code' => array(
+									'type'        => 'string',
+									'description' => __( 'ISO3166 alpha-2 country code', 'woocommerce' ),
+									'context'     => array( 'view' ),
+									'readonly'    => true,
+								),
+								'name' => array(
+									'type'        => 'string',
+									'description' => __( 'Full name of country', 'woocommerce' ),
+									'context'     => array( 'view' ),
+									'readonly'    => true,
+								),
+								'states' => array(
+									'type'                 => 'object',
+									'description'          => __( 'List of states in (code, name) pairs', 'woocommerce' ),
+									'context'              => array( 'view' ),
+									'readonly'             => true,
+									'additionalProperties' => array(
+										'type' => 'string',
+									),
+								),
+							),
+						),
+					),
+				),
+			),
+		);
+
+		return $this->add_additional_fields_schema( $schema );
+	}
 }