Module api.schema

schema api calls

Functions

blockexchange.api.create_schema (token, create_schema) creates a new schema
blockexchange.api.update_schema_stats (token, schema_id) updates the stats of an existing schema
blockexchange.api.update_screenshot (token, schema_id) updates the screenshot of a schema
blockexchange.api.update_schema (token, schema) updates an existing schema
blockexchange.api.get_schema_by_id (schema_id) search for a schema by id
blockexchange.api.get_schema_by_name (username, schemaname, download) search for a schema by username and schemaname


Functions

blockexchange.api.create_schema (token, create_schema)
creates a new schema

Parameters:

  • token the token in string format
  • create_schema the new schema as table

Returns:

    a promise with the result
blockexchange.api.update_schema_stats (token, schema_id)
updates the stats of an existing schema

Parameters:

  • token the token in string format
  • schema_id the schema_id to update

Returns:

    a promise with the result
blockexchange.api.update_screenshot (token, schema_id)
updates the screenshot of a schema

Parameters:

  • token the token in string format
  • schema_id the schema_id to update

Returns:

    a promise with the result
blockexchange.api.update_schema (token, schema)
updates an existing schema

Parameters:

  • token the token in string format
  • schema the updated schema

Returns:

    a promise with the result
blockexchange.api.get_schema_by_id (schema_id)
search for a schema by id

Parameters:

  • schema_id the schema_id

Returns:

    a promise with the result
blockexchange.api.get_schema_by_name (username, schemaname, download)
search for a schema by username and schemaname

Parameters:

  • username the username
  • schemaname the name of the schema
  • download true/false to count as additional download in the stats

Returns:

    a promise with the result
generated by LDoc 1.5.0 Last updated 2023-10-20 06:49:11