|
494 | 494 | } |
495 | 495 | }, |
496 | 496 | "404": { |
497 | | - "description": "Application Not Found", |
| 497 | + "description": "Participation Key Not Found", |
498 | 498 | "schema": { |
499 | 499 | "$ref": "#/definitions/ErrorResponse" |
500 | 500 | } |
|
553 | 553 | "$ref": "#/definitions/ErrorResponse" |
554 | 554 | } |
555 | 555 | }, |
| 556 | + "404": { |
| 557 | + "description": "Participation Key Not Found", |
| 558 | + "schema": { |
| 559 | + "$ref": "#/definitions/ErrorResponse" |
| 560 | + } |
| 561 | + }, |
556 | 562 | "500": { |
557 | 563 | "description": "Internal Error", |
558 | 564 | "schema": { |
|
576 | 582 | "tags": [ |
577 | 583 | "private" |
578 | 584 | ], |
579 | | - "description": "Delete a given participation key by id", |
| 585 | + "description": "Delete a given participation key by ID", |
580 | 586 | "produces": [ |
581 | 587 | "application/json" |
582 | 588 | ], |
583 | 589 | "schemes": [ |
584 | 590 | "http" |
585 | 591 | ], |
586 | | - "summary": "Delete a given participation key by id", |
| 592 | + "summary": "Delete a given participation key by ID", |
587 | 593 | "operationId": "DeleteParticipationKeyByID", |
588 | 594 | "responses": { |
589 | 595 | "200": { |
|
601 | 607 | "$ref": "#/definitions/ErrorResponse" |
602 | 608 | } |
603 | 609 | }, |
| 610 | + "404": { |
| 611 | + "description": "Participation Key Not Found", |
| 612 | + "schema": { |
| 613 | + "$ref": "#/definitions/ErrorResponse" |
| 614 | + } |
| 615 | + }, |
604 | 616 | "500": { |
605 | 617 | "description": "Internal Error", |
606 | 618 | "schema": { |
|
616 | 628 | "tags": [ |
617 | 629 | "private" |
618 | 630 | ], |
619 | | - "description": "Given a participation id, return information about that participation key", |
| 631 | + "description": "Given a participation ID, return information about that participation key", |
620 | 632 | "produces": [ |
621 | 633 | "application/json" |
622 | 634 | ], |
623 | 635 | "schemes": [ |
624 | 636 | "http" |
625 | 637 | ], |
626 | | - "summary": "Get participation key info by id", |
| 638 | + "summary": "Get participation key info given a participation ID", |
627 | 639 | "operationId": "GetParticipationKeyByID", |
628 | 640 | "responses": { |
629 | 641 | "200": { |
|
643 | 655 | } |
644 | 656 | }, |
645 | 657 | "404": { |
646 | | - "description": "Application Not Found", |
| 658 | + "description": "Participation Key Not Found", |
| 659 | + "schema": { |
| 660 | + "$ref": "#/definitions/ErrorResponse" |
| 661 | + } |
| 662 | + }, |
| 663 | + "500": { |
| 664 | + "description": "Internal Error", |
| 665 | + "schema": { |
| 666 | + "$ref": "#/definitions/ErrorResponse" |
| 667 | + } |
| 668 | + }, |
| 669 | + "default": { |
| 670 | + "description": "Unknown Error" |
| 671 | + } |
| 672 | + } |
| 673 | + }, |
| 674 | + "post": { |
| 675 | + "tags": [ |
| 676 | + "private" |
| 677 | + ], |
| 678 | + "description": "Given a participation ID, append state proof keys to a particular set of participation keys", |
| 679 | + "consumes": [ |
| 680 | + "application/msgpack" |
| 681 | + ], |
| 682 | + "produces": [ |
| 683 | + "application/json" |
| 684 | + ], |
| 685 | + "parameters": [ |
| 686 | + { |
| 687 | + "description": "The state proof keys to add to an existing participation ID", |
| 688 | + "name": "keymap", |
| 689 | + "in": "body", |
| 690 | + "required": true, |
| 691 | + "schema": { |
| 692 | + "type": "string", |
| 693 | + "format": "binary" |
| 694 | + } |
| 695 | + } |
| 696 | + ], |
| 697 | + "schemes": [ |
| 698 | + "http" |
| 699 | + ], |
| 700 | + "summary": "Append state proof keys to a participation key", |
| 701 | + "operationId": "AppendKeys", |
| 702 | + "responses": { |
| 703 | + "200": { |
| 704 | + "description": "OK", |
| 705 | + "$ref": "#/responses/ParticipationKeyResponse" |
| 706 | + }, |
| 707 | + "400": { |
| 708 | + "description": "Bad Request", |
| 709 | + "schema": { |
| 710 | + "$ref": "#/definitions/ErrorResponse" |
| 711 | + } |
| 712 | + }, |
| 713 | + "401": { |
| 714 | + "description": "Invalid API Token", |
| 715 | + "schema": { |
| 716 | + "$ref": "#/definitions/ErrorResponse" |
| 717 | + } |
| 718 | + }, |
| 719 | + "404": { |
| 720 | + "description": "Participation Key Not Found", |
647 | 721 | "schema": { |
648 | 722 | "$ref": "#/definitions/ErrorResponse" |
649 | 723 | } |
|
934 | 1008 | }, |
935 | 1009 | "/v2/transactions/pending/{txid}": { |
936 | 1010 | "get": { |
937 | | - "description": "Given a transaction id of a recently submitted transaction, it returns information about it. There are several cases when this might succeed:\n- transaction committed (committed round \u003e 0)\n- transaction still in the pool (committed round = 0, pool error = \"\")\n- transaction removed from pool due to error (committed round = 0, pool error != \"\")\nOr the transaction may have happened sufficiently long ago that the node no longer remembers it, and this will return an error.\n", |
| 1011 | + "description": "Given a transaction ID of a recently submitted transaction, it returns information about it. There are several cases when this might succeed:\n- transaction committed (committed round \u003e 0)\n- transaction still in the pool (committed round = 0, pool error = \"\")\n- transaction removed from pool due to error (committed round = 0, pool error != \"\")\nOr the transaction may have happened sufficiently long ago that the node no longer remembers it, and this will return an error.\n", |
938 | 1012 | "produces": [ |
939 | 1013 | "application/json", |
940 | 1014 | "application/msgpack" |
|
948 | 1022 | { |
949 | 1023 | "pattern": "[A-Z0-9]+", |
950 | 1024 | "type": "string", |
951 | | - "description": "A transaction id", |
| 1025 | + "description": "A transaction ID", |
952 | 1026 | "name": "txid", |
953 | 1027 | "in": "path", |
954 | 1028 | "required": true |
|
959 | 1033 | ], |
960 | 1034 | "responses": { |
961 | 1035 | "200": { |
962 | | - "description": "Given a transaction id of a recently submitted transaction, it returns information about it. There are several cases when this might succeed:\n- transaction committed (committed round \u003e 0)\n- transaction still in the pool (committed round = 0, pool error = \"\")\n- transaction removed from pool due to error (committed round = 0, pool error != \"\")\n\nOr the transaction may have happened sufficiently long ago that the node no longer remembers it, and this will return an error.", |
| 1036 | + "description": "Given a transaction ID of a recently submitted transaction, it returns information about it. There are several cases when this might succeed:\n- transaction committed (committed round \u003e 0)\n- transaction still in the pool (committed round = 0, pool error = \"\")\n- transaction removed from pool due to error (committed round = 0, pool error != \"\")\n\nOr the transaction may have happened sufficiently long ago that the node no longer remembers it, and this will return an error.", |
963 | 1037 | "schema": { |
964 | 1038 | "$ref": "#/definitions/PendingTransactionResponse" |
965 | 1039 | } |
|
998 | 1072 | }, |
999 | 1073 | "/v2/applications/{application-id}": { |
1000 | 1074 | "get": { |
1001 | | - "description": "Given a application id, it returns application information including creator, approval and clear programs, global and local schemas, and global state.", |
| 1075 | + "description": "Given a application ID, it returns application information including creator, approval and clear programs, global and local schemas, and global state.", |
1002 | 1076 | "produces": [ |
1003 | 1077 | "application/json" |
1004 | 1078 | ], |
|
1061 | 1135 | }, |
1062 | 1136 | "/v2/assets/{asset-id}": { |
1063 | 1137 | "get": { |
1064 | | - "description": "Given a asset id, it returns asset information including creator, name, total supply and special addresses.", |
| 1138 | + "description": "Given a asset ID, it returns asset information including creator, name, total supply and special addresses.", |
1065 | 1139 | "produces": [ |
1066 | 1140 | "application/json" |
1067 | 1141 | ], |
|
2576 | 2650 | } |
2577 | 2651 | }, |
2578 | 2652 | "ParticipationKeyResponse": { |
2579 | | - "description": "A detailed description of a participation id", |
| 2653 | + "description": "A detailed description of a participation ID", |
2580 | 2654 | "schema": { |
2581 | 2655 | "$ref": "#/definitions/ParticipationKey" |
2582 | 2656 | } |
|
2593 | 2667 | ], |
2594 | 2668 | "properties": { |
2595 | 2669 | "partId": { |
2596 | | - "description": "encoding of the participation id.", |
| 2670 | + "description": "encoding of the participation ID.", |
2597 | 2671 | "type": "string" |
2598 | 2672 | } |
2599 | 2673 | } |
|
0 commit comments