Skip to content

Commit

Permalink
update documentation and vocabulary SQL files
Browse files Browse the repository at this point in the history
  • Loading branch information
ralconada-gmv committed May 14, 2024
1 parent 28b16a2 commit c4450cc
Show file tree
Hide file tree
Showing 4 changed files with 24 additions and 5 deletions.
19 changes: 19 additions & 0 deletions extensions/vocabulary-api/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# Vocabulary API

Provides a management API for work with vocabularies. This API expands the functionality of the control-plane management API to be able to handle Vocabulary entities.


## Vocabulary entity

An example of a Vocabulary entity is shown below.

```
{
"@context": {
"@vocab": "https://w3id.org/edc/v0.0.1/ns/"
},
"@id": "vocabularyId",
"name": "Vocabulary name",
"jsonSchema": "{ \"title\": \"vocabulary\", \"type\": \"object\", \"properties\": { \"name\": { \"type\": \"string\", \"title\": \"Name\" }, \"keyword\": { \"type\": \"array\", \"title\": \"Keywords\", \"items\": { \"type\": \"string\" } } }, \"required\": [ \"name\" ] }"
}
```
4 changes: 2 additions & 2 deletions extensions/vocabulary-index-sql/docs/schema.sql
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
-- table: edc_vocabulary
CREATE TABLE IF NOT EXISTS edc_vocabulary
(
id VARCHAR NOT NULL,
id VARCHAR NOT NULL,
created_at BIGINT NOT NULL,
json_schema JSON DEFAULT '{}',
vocabulary_name VARCHAR NOT NULL,
name VARCHAR NOT NULL,
PRIMARY KEY (id)
);

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ default String getCreatedAtColumn() {
/**
* Generates a SQL query using sub-select statements out of the query spec.
*
* @param query query to be executed
* @param query querySpec to be executed
* @return A {@link SqlQueryStatement} that contains the SQL and statement parameters
*/
SqlQueryStatement createQuery(QuerySpec query);
Expand Down
4 changes: 2 additions & 2 deletions resources/sql/vocabulary-schema.sql
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
-- table: edc_vocabulary
CREATE TABLE IF NOT EXISTS edc_vocabulary
(
id VARCHAR NOT NULL,
id VARCHAR NOT NULL,
created_at BIGINT NOT NULL,
json_schema JSON DEFAULT '{}',
vocabulary_name VARCHAR NOT NULL,
name VARCHAR NOT NULL,
PRIMARY KEY (id)
);

Expand Down

0 comments on commit c4450cc

Please sign in to comment.