Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

#

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Separate "define" and "publish" for contract APIs, and allow deleting unpublished APIs #1322

Merged
merged 3 commits into from
May 30, 2023
+3,038 −755
Merged

Separate "define" and "publish" for contract APIs, and allow deleting unpublished APIs #1322

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4c1f601
Separate "define" and "publish" for contract APIs
awrichar May 25, 2023
a15b9c3
Add route for deleting contract APIs
awrichar May 25, 2023
be23163
Verify that interface is published before publishing API
awrichar May 30, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions db/migrations/postgres/000113_add_contract_api_networkname.down.sql
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
BEGIN;
DROP INDEX contractapis_networkname;
ALTER TABLE contractapis DROP COLUMN published;
ALTER TABLE contractapis DROP COLUMN network_name;
COMMIT;
7 changes: 7 additions & 0 deletions db/migrations/postgres/000113_add_contract_api_networkname.up.sql
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
BEGIN;
ALTER TABLE contractapis ADD COLUMN published BOOLEAN DEFAULT false;
UPDATE contractapis SET published = true WHERE message_id IS NOT NULL;
ALTER TABLE contractapis ADD COLUMN network_name VARCHAR(64);
UPDATE contractapis SET network_name = name WHERE message_id IS NOT NULL;
CREATE UNIQUE INDEX contractapis_networkname ON contractapis(namespace,network_name);
COMMIT;
3 changes: 3 additions & 0 deletions db/migrations/sqlite/000113_add_contract_api_networkname.down.sql
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
DROP INDEX contractapis_networkname;
ALTER TABLE contractapis DROP COLUMN published;
ALTER TABLE contractapis DROP COLUMN network_name;
5 changes: 5 additions & 0 deletions db/migrations/sqlite/000113_add_contract_api_networkname.up.sql
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
ALTER TABLE contractapis ADD COLUMN published BOOLEAN DEFAULT false;
UPDATE contractapis SET published = true WHERE message_id IS NOT NULL;
ALTER TABLE contractapis ADD COLUMN network_name VARCHAR(64);
UPDATE contractapis SET network_name = name WHERE message_id IS NOT NULL;
CREATE UNIQUE INDEX contractapis_networkname ON contractapis(namespace,network_name);
5 changes: 4 additions & 1 deletion docs/reference/types/contractapi.md
View file
Original file line number Diff line number Diff line change
@@ -37,7 +37,8 @@ nav_order: 4
"urls": {
"openapi": "http://127.0.0.1:5000/api/v1/namespaces/default/apis/my_contract_api/api/swagger.json",
"ui": "http://127.0.0.1:5000/api/v1/namespaces/default/apis/my_contract_api/api"
}
},
"published": false
}
```

@@ -50,8 +51,10 @@ nav_order: 4
| `interface` | Reference to the FireFly Interface definition associated with the contract API | [`FFIReference`](#ffireference) |
| `location` | If this API is tied to an individual instance of a smart contract, this field can include a blockchain specific contract identifier. For example an Ethereum contract address, or a Fabric chaincode name and channel | [`JSONAny`](simpletypes#jsonany) |
| `name` | The name that is used in the URL to access the API | `string` |
| `networkName` | The published name of the API within the multiparty network | `string` |
| `message` | The UUID of the broadcast message that was used to publish this API to the network | [`UUID`](simpletypes#uuid) |
| `urls` | The URLs to use to access the API | [`ContractURLs`](#contracturls) |
| `published` | Indicates if the API is published to other members of the multiparty network | `bool` |

## FFIReference

Loading