tmdinosaurcenter
/
tainacan
mirror of https://github.com/tainacan/tainacan
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Adds descriptions and updates logs schema.

This commit is contained in:
mateuswetah 2023-07-06 09:01:33 -03:00
parent fa7bdecebd
commit 3eaa52d491
3 changed files with 82 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/openapi.json
View File

File diff suppressed because one or more lines are too long

96
src/classes/api/endpoints/class-tainacan-rest-logs-controller.php
View File

@ -28,7 +28,7 @@ class REST_Logs_Controller extends REST_Controller {
'permission_callback' => array($this, 'get_items_permissions_check'), 'permission_callback' => array($this, 'get_items_permissions_check'),
'args' => $this->get_endpoint_args_for_item_schema(\WP_REST_Server::READABLE) 'args' => $this->get_endpoint_args_for_item_schema(\WP_REST_Server::READABLE)
), ),
'schema' => [$this, 'get_schema'] 'schema' => [$this, 'get_list_schema']
) )
); );
register_rest_route($this->namespace, '/' . $this->rest_base . '/(?P<log_id>[\d]+)', register_rest_route($this->namespace, '/' . $this->rest_base . '/(?P<log_id>[\d]+)',
@ -37,6 +37,12 @@ class REST_Logs_Controller extends REST_Controller {
'methods' => \WP_REST_Server::READABLE, 'methods' => \WP_REST_Server::READABLE,
'callback' => array($this, 'get_item'), 'callback' => array($this, 'get_item'),
'permission_callback' => array($this, 'get_item_permissions_check'), 'permission_callback' => array($this, 'get_item_permissions_check'),
'args' => array(
'log_id' => array(
'description' => __( 'Log ID', 'tainacan' ),
'required' => true,
),
)
), ),
'schema' => [$this, 'get_schema'] 'schema' => [$this, 'get_schema']
) )
@ -47,9 +53,17 @@ class REST_Logs_Controller extends REST_Controller {
'methods' => \WP_REST_Server::READABLE, 'methods' => \WP_REST_Server::READABLE,
'callback' => array($this, 'get_items'), 'callback' => array($this, 'get_items'),
'permission_callback' => array($this, 'get_items_permissions_check'), 'permission_callback' => array($this, 'get_items_permissions_check'),
'args' => $this->get_endpoint_args_for_item_schema( \WP_REST_Server::READABLE) 'args' => array_merge(
array(
'collection_id' => array(
'description' => __( 'Collection ID', 'tainacan' ),
'required' => true,
),
),
$this->get_endpoint_args_for_item_schema( \WP_REST_Server::READABLE)
)
), ),
'schema' => [$this, 'get_schema'] 'schema' => [$this, 'get_list_schema']
) )
); );
register_rest_route($this->namespace, '/item/(?P<item_id>[\d]+)/' . $this->rest_base, register_rest_route($this->namespace, '/item/(?P<item_id>[\d]+)/' . $this->rest_base,
@ -58,9 +72,17 @@ class REST_Logs_Controller extends REST_Controller {
'methods' => \WP_REST_Server::READABLE, 'methods' => \WP_REST_Server::READABLE,
'callback' => array($this, 'get_items'), 'callback' => array($this, 'get_items'),
'permission_callback' => array($this, 'get_items_permissions_check'), 'permission_callback' => array($this, 'get_items_permissions_check'),
'args' => $this->get_endpoint_args_for_item_schema( \WP_REST_Server::READABLE) 'args' => array_merge(
array(
'item_id' => array(
'description' => __( 'Item ID', 'tainacan' ),
'required' => true,
),
),
$this->get_endpoint_args_for_item_schema( \WP_REST_Server::READABLE)
)
), ),
'schema' => [$this, 'get_schema'] 'schema' => [$this, 'get_list_schema']
) )
); );
register_rest_route($this->namespace, '/filter/(?P<filter_id>[\d]+)/' . $this->rest_base, register_rest_route($this->namespace, '/filter/(?P<filter_id>[\d]+)/' . $this->rest_base,
@ -69,9 +91,17 @@ class REST_Logs_Controller extends REST_Controller {
'methods' => \WP_REST_Server::READABLE, 'methods' => \WP_REST_Server::READABLE,
'callback' => array($this, 'get_items'), 'callback' => array($this, 'get_items'),
'permission_callback' => array($this, 'get_items_permissions_check'), 'permission_callback' => array($this, 'get_items_permissions_check'),
'args' => $this->get_endpoint_args_for_item_schema( \WP_REST_Server::READABLE) 'args' => array_merge(
array(
'filter_id' => array(
'description' => __( 'Filter ID', 'tainacan' ),
'required' => true,
),
),
$this->get_endpoint_args_for_item_schema( \WP_REST_Server::READABLE)
)
), ),
'schema' => [$this, 'get_schema'] 'schema' => [$this, 'get_list_schema']
) )
); );
register_rest_route($this->namespace, '/metadatum/(?P<metadatum_id>[\d]+)/' . $this->rest_base, register_rest_route($this->namespace, '/metadatum/(?P<metadatum_id>[\d]+)/' . $this->rest_base,
@ -80,9 +110,17 @@ class REST_Logs_Controller extends REST_Controller {
'methods' => \WP_REST_Server::READABLE, 'methods' => \WP_REST_Server::READABLE,
'callback' => array($this, 'get_items'), 'callback' => array($this, 'get_items'),
'permission_callback' => array($this, 'get_items_permissions_check'), 'permission_callback' => array($this, 'get_items_permissions_check'),
'args' => $this->get_endpoint_args_for_item_schema( \WP_REST_Server::READABLE) 'args' => array_merge(
array(
'metadatum_id' => array(
'description' => __( 'Metadatum ID', 'tainacan' ),
'required' => true,
),
),
$this->get_endpoint_args_for_item_schema( \WP_REST_Server::READABLE)
)
), ),
'schema' => [$this, 'get_schema'] 'schema' => [$this, 'get_list_schema']
) )
); );
register_rest_route($this->namespace, '/taxonomy/(?P<taxonomy_id>[\d]+)/' . $this->rest_base, register_rest_route($this->namespace, '/taxonomy/(?P<taxonomy_id>[\d]+)/' . $this->rest_base,
@ -91,9 +129,17 @@ class REST_Logs_Controller extends REST_Controller {
'methods' => \WP_REST_Server::READABLE, 'methods' => \WP_REST_Server::READABLE,
'callback' => array($this, 'get_items'), 'callback' => array($this, 'get_items'),
'permission_callback' => array($this, 'get_items_permissions_check'), 'permission_callback' => array($this, 'get_items_permissions_check'),
'args' => $this->get_endpoint_args_for_item_schema( \WP_REST_Server::READABLE) 'args' => array_merge(
array(
'taxonomy_id' => array(
'description' => __( 'Taxonomy ID', 'tainacan' ),
'required' => true,
),
),
$this->get_endpoint_args_for_item_schema( \WP_REST_Server::READABLE)
)
), ),
'schema' => [$this, 'get_schema'] 'schema' => [$this, 'get_list_schema']
) )
); );
register_rest_route($this->namespace, '/term/(?P<term_id>[\d]+)/' . $this->rest_base, register_rest_route($this->namespace, '/term/(?P<term_id>[\d]+)/' . $this->rest_base,
@ -102,9 +148,17 @@ class REST_Logs_Controller extends REST_Controller {
'methods' => \WP_REST_Server::READABLE, 'methods' => \WP_REST_Server::READABLE,
'callback' => array($this, 'get_items'), 'callback' => array($this, 'get_items'),
'permission_callback' => array($this, 'get_items_permissions_check'), 'permission_callback' => array($this, 'get_items_permissions_check'),
'args' => $this->get_endpoint_args_for_item_schema( \WP_REST_Server::READABLE) 'args' => array_merge(
array(
'term_id' => array(
'description' => __( 'Term ID', 'tainacan' ),
'required' => true,
),
),
$this->get_endpoint_args_for_item_schema( \WP_REST_Server::READABLE)
)
), ),
'schema' => [$this, 'get_schema'] 'schema' => [$this, 'get_list_schema']
) )
); );
} }
@ -334,11 +388,14 @@ class REST_Logs_Controller extends REST_Controller {
*/ */
public function get_endpoint_args_for_item_schema( $method = null ) { public function get_endpoint_args_for_item_schema( $method = null ) {
$endpoint_args = []; $endpoint_args = [];
if($method === \WP_REST_Server::READABLE) {
$endpoint_args = array_merge( switch ( $method ) {
$endpoint_args, case \WP_REST_Server::READABLE:
parent::get_wp_query_params() $endpoint_args = array_merge(
); $endpoint_args,
parent::get_wp_query_params()
);
break;
} }
return $endpoint_args; return $endpoint_args;
@ -348,7 +405,8 @@ class REST_Logs_Controller extends REST_Controller {
$schema = [ $schema = [
'$schema' => 'http://json-schema.org/draft-04/schema#', '$schema' => 'http://json-schema.org/draft-04/schema#',
'title' => 'log', 'title' => 'log',
'type' => 'object' 'type' => 'object',
'tags' => [ $this->rest_base ]
]; ];
$main_schema = parent::get_repository_schema( $this->logs_repository ); $main_schema = parent::get_repository_schema( $this->logs_repository );

8
src/classes/repositories/class-tainacan-logs.php
View File

@ -59,7 +59,7 @@ class Logs extends Repository {
'map' => 'post_date', 'map' => 'post_date',
'title' => __( 'Log date', 'tainacan' ), 'title' => __( 'Log date', 'tainacan' ),
'type' => 'string', 'type' => 'string',
'description' => __( 'The log date', 'tainacan' ), 'description' => __( 'The moment when the log was registered', 'tainacan' ),
], ],
'description' => [ 'description' => [
'map' => 'post_content', 'map' => 'post_content',
@ -123,19 +123,19 @@ class Logs extends Repository {
'old_value' => [ 'old_value' => [
'map' => 'meta', 'map' => 'meta',
'title' => __( 'Old value', 'tainacan' ), 'title' => __( 'Old value', 'tainacan' ),
'description' => __( 'Old value', 'tainacan' ), 'description' => __( 'Value of the field previous to the edition registered by the log.', 'tainacan' ),
'type' => 'string', 'type' => 'string',
], ],
'new_value' => [ 'new_value' => [
'map' => 'meta', 'map' => 'meta',
'title' => __( 'New value', 'tainacan' ), 'title' => __( 'New value', 'tainacan' ),
'description' => __( 'New value', 'tainacan' ), 'description' => __( 'Value of the field after the edition registered by the log.', 'tainacan' ),
'type' => 'string', 'type' => 'string',
], ],
'action' => [ 'action' => [
'map' => 'meta', 'map' => 'meta',
'title' => __( 'Action', 'tainacan' ), 'title' => __( 'Action', 'tainacan' ),
'description' => __( 'Action', 'tainacan' ), 'description' => __( 'Type of action registered by the log.', 'tainacan' ),
'type' => 'string', 'type' => 'string',
] ]
] ); ] );