github.com/hsdp/go-swagger@v0.19.0/examples/contributed-templates/stratoscale/restapi/embedded_spec.go (about) 1 // Code generated by go-swagger; DO NOT EDIT. 2 3 package restapi 4 5 // This file was generated by the swagger tool. 6 // Editing this file might prove futile when you re-run the swagger generate command 7 8 import ( 9 "encoding/json" 10 ) 11 12 var ( 13 // SwaggerJSON embedded version of the swagger document used at generation time 14 SwaggerJSON json.RawMessage 15 // FlatSwaggerJSON embedded flattened version of the swagger document used at generation time 16 FlatSwaggerJSON json.RawMessage 17 ) 18 19 func init() { 20 SwaggerJSON = json.RawMessage([]byte(`{ 21 "consumes": [ 22 "application/json" 23 ], 24 "produces": [ 25 "application/json" 26 ], 27 "schemes": [ 28 "http" 29 ], 30 "swagger": "2.0", 31 "info": { 32 "description": "This is a sample server Petstore server. You can find out more about Swagger at [http://swagger.io](http://swagger.io) or on [irc.freenode.net, #swagger](http://swagger.io/irc/). For this sample, you can use the api key ` + "`" + `special-key` + "`" + ` to test the authorization filters.", 33 "title": "Petstore", 34 "version": "1.0.0" 35 }, 36 "host": "petstore.service.strato", 37 "basePath": "/api/v2", 38 "paths": { 39 "/pet": { 40 "get": { 41 "security": [ 42 { 43 "roles": [ 44 "admin", 45 "member" 46 ] 47 } 48 ], 49 "tags": [ 50 "pet" 51 ], 52 "summary": "List pets", 53 "operationId": "PetList", 54 "parameters": [ 55 { 56 "type": "array", 57 "items": { 58 "enum": [ 59 "available", 60 "pending", 61 "sold" 62 ], 63 "type": "string", 64 "default": "available" 65 }, 66 "collectionFormat": "multi", 67 "description": "Status values that need to be considered for filter", 68 "name": "status", 69 "in": "query", 70 "required": true 71 } 72 ], 73 "responses": { 74 "200": { 75 "description": "successful operation", 76 "schema": { 77 "type": "array", 78 "items": { 79 "$ref": "#/definitions/Pet" 80 } 81 } 82 }, 83 "400": { 84 "description": "Invalid status value" 85 } 86 } 87 }, 88 "put": { 89 "tags": [ 90 "pet" 91 ], 92 "summary": "Update an existing pet", 93 "operationId": "PetUpdate", 94 "parameters": [ 95 { 96 "description": "Pet object that needs to be added to the store", 97 "name": "body", 98 "in": "body", 99 "required": true, 100 "schema": { 101 "$ref": "#/definitions/Pet" 102 } 103 } 104 ], 105 "responses": { 106 "201": { 107 "description": "Updated successfully", 108 "schema": { 109 "$ref": "#/definitions/Pet" 110 } 111 }, 112 "400": { 113 "description": "Invalid ID supplied" 114 }, 115 "404": { 116 "description": "Pet not found" 117 }, 118 "405": { 119 "description": "Validation exception" 120 } 121 } 122 }, 123 "post": { 124 "tags": [ 125 "pet" 126 ], 127 "summary": "Add a new pet to the store", 128 "operationId": "PetCreate", 129 "parameters": [ 130 { 131 "description": "Pet object that needs to be added to the store", 132 "name": "body", 133 "in": "body", 134 "required": true, 135 "schema": { 136 "$ref": "#/definitions/Pet" 137 } 138 } 139 ], 140 "responses": { 141 "201": { 142 "description": "Created", 143 "schema": { 144 "$ref": "#/definitions/Pet" 145 } 146 }, 147 "405": { 148 "description": "Invalid input" 149 } 150 } 151 } 152 }, 153 "/pet/{petId}": { 154 "get": { 155 "security": [ 156 { 157 "roles": [ 158 "admin", 159 "member" 160 ] 161 } 162 ], 163 "tags": [ 164 "pet" 165 ], 166 "summary": "Get pet by it's ID", 167 "operationId": "PetGet", 168 "parameters": [ 169 { 170 "type": "integer", 171 "format": "int64", 172 "description": "ID of pet to return", 173 "name": "petId", 174 "in": "path", 175 "required": true 176 } 177 ], 178 "responses": { 179 "200": { 180 "description": "successful operation", 181 "schema": { 182 "$ref": "#/definitions/Pet" 183 } 184 }, 185 "400": { 186 "description": "Invalid ID supplied" 187 }, 188 "404": { 189 "description": "Pet not found" 190 } 191 } 192 }, 193 "delete": { 194 "tags": [ 195 "pet" 196 ], 197 "summary": "Deletes a pet", 198 "operationId": "PetDelete", 199 "parameters": [ 200 { 201 "type": "string", 202 "name": "api_key", 203 "in": "header" 204 }, 205 { 206 "type": "integer", 207 "format": "int64", 208 "description": "Pet id to delete", 209 "name": "petId", 210 "in": "path", 211 "required": true 212 } 213 ], 214 "responses": { 215 "204": { 216 "description": "Deleted successfully" 217 }, 218 "400": { 219 "description": "Invalid ID supplied" 220 }, 221 "404": { 222 "description": "Pet not found" 223 } 224 } 225 } 226 }, 227 "/pet/{petId}/image": { 228 "post": { 229 "tags": [ 230 "pet" 231 ], 232 "summary": "uploads an image", 233 "operationId": "PetUploadImage", 234 "parameters": [ 235 { 236 "type": "integer", 237 "format": "int64", 238 "description": "ID of pet to update", 239 "name": "petId", 240 "in": "path", 241 "required": true 242 }, 243 { 244 "type": "string", 245 "description": "Additional data to pass to server", 246 "name": "additionalMetadata", 247 "in": "formData" 248 }, 249 { 250 "type": "file", 251 "description": "file to upload", 252 "name": "file", 253 "in": "formData" 254 } 255 ], 256 "responses": { 257 "200": { 258 "description": "successful operation", 259 "schema": { 260 "$ref": "#/definitions/ApiResponse" 261 } 262 } 263 } 264 } 265 }, 266 "/store/inventory": { 267 "get": { 268 "tags": [ 269 "store" 270 ], 271 "summary": "Returns pet inventories by status", 272 "operationId": "InventoryGet", 273 "responses": { 274 "200": { 275 "description": "successful operation", 276 "schema": { 277 "type": "object", 278 "additionalProperties": { 279 "type": "integer", 280 "format": "int32" 281 } 282 } 283 } 284 } 285 } 286 }, 287 "/store/order": { 288 "post": { 289 "tags": [ 290 "store" 291 ], 292 "summary": "Place an order for a pet", 293 "operationId": "OrderCreate", 294 "parameters": [ 295 { 296 "description": "order placed for purchasing the pet", 297 "name": "body", 298 "in": "body", 299 "required": true, 300 "schema": { 301 "$ref": "#/definitions/Order" 302 } 303 } 304 ], 305 "responses": { 306 "200": { 307 "description": "successful operation", 308 "schema": { 309 "$ref": "#/definitions/Order" 310 } 311 }, 312 "400": { 313 "description": "Invalid Order" 314 } 315 } 316 } 317 }, 318 "/store/order/{orderId}": { 319 "get": { 320 "description": "For valid response try integer IDs with value \u003e= 1 and \u003c= 10. Other values will generated exceptions", 321 "tags": [ 322 "store" 323 ], 324 "summary": "Find purchase order by ID", 325 "operationId": "OrderGet", 326 "parameters": [ 327 { 328 "maximum": 10, 329 "minimum": 1, 330 "type": "integer", 331 "format": "int64", 332 "description": "ID of pet that needs to be fetched", 333 "name": "orderId", 334 "in": "path", 335 "required": true 336 } 337 ], 338 "responses": { 339 "200": { 340 "description": "successful operation", 341 "schema": { 342 "$ref": "#/definitions/Order" 343 } 344 }, 345 "400": { 346 "description": "Invalid ID supplied" 347 }, 348 "404": { 349 "description": "Order not found" 350 } 351 } 352 }, 353 "delete": { 354 "description": "For valid response try integer IDs with positive integer value. Negative or non-integer values will generate API errors", 355 "tags": [ 356 "store" 357 ], 358 "summary": "Delete purchase order by ID", 359 "operationId": "OrderDelete", 360 "parameters": [ 361 { 362 "minimum": 1, 363 "type": "integer", 364 "format": "int64", 365 "description": "ID of the order that needs to be deleted", 366 "name": "orderId", 367 "in": "path", 368 "required": true 369 } 370 ], 371 "responses": { 372 "204": { 373 "description": "Deleted successfully" 374 }, 375 "400": { 376 "description": "Invalid ID supplied" 377 }, 378 "404": { 379 "description": "Order not found" 380 } 381 } 382 } 383 } 384 }, 385 "definitions": { 386 "ApiResponse": { 387 "type": "object", 388 "properties": { 389 "code": { 390 "type": "integer", 391 "format": "int32" 392 }, 393 "message": { 394 "type": "string" 395 }, 396 "type": { 397 "type": "string" 398 } 399 } 400 }, 401 "Category": { 402 "type": "object", 403 "properties": { 404 "id": { 405 "type": "integer", 406 "format": "int64" 407 }, 408 "name": { 409 "type": "string" 410 } 411 } 412 }, 413 "Order": { 414 "type": "object", 415 "properties": { 416 "complete": { 417 "type": "boolean", 418 "default": false 419 }, 420 "id": { 421 "type": "integer", 422 "format": "int64" 423 }, 424 "petId": { 425 "type": "integer", 426 "format": "int64" 427 }, 428 "quantity": { 429 "type": "integer", 430 "format": "int32" 431 }, 432 "shipDate": { 433 "type": "string", 434 "format": "date-time" 435 }, 436 "status": { 437 "description": "Order Status", 438 "type": "string", 439 "enum": [ 440 "placed", 441 "approved", 442 "delivered" 443 ] 444 } 445 } 446 }, 447 "Pet": { 448 "type": "object", 449 "required": [ 450 "name", 451 "photoUrls" 452 ], 453 "properties": { 454 "category": { 455 "$ref": "#/definitions/Category" 456 }, 457 "id": { 458 "type": "integer", 459 "format": "int64", 460 "x-go-custom-tag": "gorm:\"primary_key\" query:\"filter,sort\"" 461 }, 462 "name": { 463 "type": "string", 464 "x-go-custom-tag": "query:\"filter,sort\"", 465 "example": "doggie" 466 }, 467 "photoUrls": { 468 "type": "array", 469 "items": { 470 "type": "string" 471 }, 472 "x-go-custom-tag": "gorm:\"-\"" 473 }, 474 "status": { 475 "description": "pet status in the store", 476 "type": "string", 477 "enum": [ 478 "available", 479 "pending", 480 "sold" 481 ], 482 "x-go-custom-tag": "query:\"filter,sort\"" 483 }, 484 "tags": { 485 "type": "array", 486 "items": { 487 "$ref": "#/definitions/Tag" 488 } 489 } 490 } 491 }, 492 "Tag": { 493 "type": "object", 494 "properties": { 495 "id": { 496 "type": "integer", 497 "format": "int64" 498 }, 499 "name": { 500 "type": "string" 501 } 502 } 503 } 504 }, 505 "securityDefinitions": { 506 "roles": { 507 "type": "apiKey", 508 "name": "X-Auth-Roles", 509 "in": "header" 510 } 511 }, 512 "security": [ 513 { 514 "roles": [ 515 "admin" 516 ] 517 } 518 ], 519 "tags": [ 520 { 521 "description": "Everything about your Pets", 522 "name": "pet", 523 "externalDocs": { 524 "description": "Find out more", 525 "url": "http://swagger.io" 526 } 527 }, 528 { 529 "description": "Access to Petstore orders", 530 "name": "store" 531 } 532 ], 533 "externalDocs": { 534 "description": "Find out more about Swagger", 535 "url": "http://swagger.io" 536 }, 537 "x-events": [ 538 { 539 "entity_name": "pet", 540 "message": "Pet ${pet_name} was created", 541 "name": "pet_created", 542 "properties": { 543 "pet_id": "int64", 544 "pet_name": "string" 545 }, 546 "severity": "info" 547 }, 548 { 549 "entity_name": "pet", 550 "message": "Pet ${pet_id} was deleted", 551 "name": "pet_deleted", 552 "properties": { 553 "pet_id": "integer" 554 }, 555 "severity": "critical" 556 } 557 ] 558 }`)) 559 FlatSwaggerJSON = json.RawMessage([]byte(`{ 560 "consumes": [ 561 "application/json" 562 ], 563 "produces": [ 564 "application/json" 565 ], 566 "schemes": [ 567 "http" 568 ], 569 "swagger": "2.0", 570 "info": { 571 "description": "This is a sample server Petstore server. You can find out more about Swagger at [http://swagger.io](http://swagger.io) or on [irc.freenode.net, #swagger](http://swagger.io/irc/). For this sample, you can use the api key ` + "`" + `special-key` + "`" + ` to test the authorization filters.", 572 "title": "Petstore", 573 "version": "1.0.0" 574 }, 575 "host": "petstore.service.strato", 576 "basePath": "/api/v2", 577 "paths": { 578 "/pet": { 579 "get": { 580 "security": [ 581 { 582 "roles": [ 583 "admin", 584 "member" 585 ] 586 } 587 ], 588 "tags": [ 589 "pet" 590 ], 591 "summary": "List pets", 592 "operationId": "PetList", 593 "parameters": [ 594 { 595 "type": "array", 596 "items": { 597 "enum": [ 598 "available", 599 "pending", 600 "sold" 601 ], 602 "type": "string", 603 "default": "available" 604 }, 605 "collectionFormat": "multi", 606 "description": "Status values that need to be considered for filter", 607 "name": "status", 608 "in": "query", 609 "required": true 610 } 611 ], 612 "responses": { 613 "200": { 614 "description": "successful operation", 615 "schema": { 616 "type": "array", 617 "items": { 618 "$ref": "#/definitions/Pet" 619 } 620 } 621 }, 622 "400": { 623 "description": "Invalid status value" 624 } 625 } 626 }, 627 "put": { 628 "tags": [ 629 "pet" 630 ], 631 "summary": "Update an existing pet", 632 "operationId": "PetUpdate", 633 "parameters": [ 634 { 635 "description": "Pet object that needs to be added to the store", 636 "name": "body", 637 "in": "body", 638 "required": true, 639 "schema": { 640 "$ref": "#/definitions/Pet" 641 } 642 } 643 ], 644 "responses": { 645 "201": { 646 "description": "Updated successfully", 647 "schema": { 648 "$ref": "#/definitions/Pet" 649 } 650 }, 651 "400": { 652 "description": "Invalid ID supplied" 653 }, 654 "404": { 655 "description": "Pet not found" 656 }, 657 "405": { 658 "description": "Validation exception" 659 } 660 } 661 }, 662 "post": { 663 "tags": [ 664 "pet" 665 ], 666 "summary": "Add a new pet to the store", 667 "operationId": "PetCreate", 668 "parameters": [ 669 { 670 "description": "Pet object that needs to be added to the store", 671 "name": "body", 672 "in": "body", 673 "required": true, 674 "schema": { 675 "$ref": "#/definitions/Pet" 676 } 677 } 678 ], 679 "responses": { 680 "201": { 681 "description": "Created", 682 "schema": { 683 "$ref": "#/definitions/Pet" 684 } 685 }, 686 "405": { 687 "description": "Invalid input" 688 } 689 } 690 } 691 }, 692 "/pet/{petId}": { 693 "get": { 694 "security": [ 695 { 696 "roles": [ 697 "admin", 698 "member" 699 ] 700 } 701 ], 702 "tags": [ 703 "pet" 704 ], 705 "summary": "Get pet by it's ID", 706 "operationId": "PetGet", 707 "parameters": [ 708 { 709 "type": "integer", 710 "format": "int64", 711 "description": "ID of pet to return", 712 "name": "petId", 713 "in": "path", 714 "required": true 715 } 716 ], 717 "responses": { 718 "200": { 719 "description": "successful operation", 720 "schema": { 721 "$ref": "#/definitions/Pet" 722 } 723 }, 724 "400": { 725 "description": "Invalid ID supplied" 726 }, 727 "404": { 728 "description": "Pet not found" 729 } 730 } 731 }, 732 "delete": { 733 "tags": [ 734 "pet" 735 ], 736 "summary": "Deletes a pet", 737 "operationId": "PetDelete", 738 "parameters": [ 739 { 740 "type": "string", 741 "name": "api_key", 742 "in": "header" 743 }, 744 { 745 "type": "integer", 746 "format": "int64", 747 "description": "Pet id to delete", 748 "name": "petId", 749 "in": "path", 750 "required": true 751 } 752 ], 753 "responses": { 754 "204": { 755 "description": "Deleted successfully" 756 }, 757 "400": { 758 "description": "Invalid ID supplied" 759 }, 760 "404": { 761 "description": "Pet not found" 762 } 763 } 764 } 765 }, 766 "/pet/{petId}/image": { 767 "post": { 768 "tags": [ 769 "pet" 770 ], 771 "summary": "uploads an image", 772 "operationId": "PetUploadImage", 773 "parameters": [ 774 { 775 "type": "integer", 776 "format": "int64", 777 "description": "ID of pet to update", 778 "name": "petId", 779 "in": "path", 780 "required": true 781 }, 782 { 783 "type": "string", 784 "description": "Additional data to pass to server", 785 "name": "additionalMetadata", 786 "in": "formData" 787 }, 788 { 789 "type": "file", 790 "description": "file to upload", 791 "name": "file", 792 "in": "formData" 793 } 794 ], 795 "responses": { 796 "200": { 797 "description": "successful operation", 798 "schema": { 799 "$ref": "#/definitions/ApiResponse" 800 } 801 } 802 } 803 } 804 }, 805 "/store/inventory": { 806 "get": { 807 "tags": [ 808 "store" 809 ], 810 "summary": "Returns pet inventories by status", 811 "operationId": "InventoryGet", 812 "responses": { 813 "200": { 814 "description": "successful operation", 815 "schema": { 816 "type": "object", 817 "additionalProperties": { 818 "type": "integer", 819 "format": "int32" 820 } 821 } 822 } 823 } 824 } 825 }, 826 "/store/order": { 827 "post": { 828 "tags": [ 829 "store" 830 ], 831 "summary": "Place an order for a pet", 832 "operationId": "OrderCreate", 833 "parameters": [ 834 { 835 "description": "order placed for purchasing the pet", 836 "name": "body", 837 "in": "body", 838 "required": true, 839 "schema": { 840 "$ref": "#/definitions/Order" 841 } 842 } 843 ], 844 "responses": { 845 "200": { 846 "description": "successful operation", 847 "schema": { 848 "$ref": "#/definitions/Order" 849 } 850 }, 851 "400": { 852 "description": "Invalid Order" 853 } 854 } 855 } 856 }, 857 "/store/order/{orderId}": { 858 "get": { 859 "description": "For valid response try integer IDs with value \u003e= 1 and \u003c= 10. Other values will generated exceptions", 860 "tags": [ 861 "store" 862 ], 863 "summary": "Find purchase order by ID", 864 "operationId": "OrderGet", 865 "parameters": [ 866 { 867 "maximum": 10, 868 "minimum": 1, 869 "type": "integer", 870 "format": "int64", 871 "description": "ID of pet that needs to be fetched", 872 "name": "orderId", 873 "in": "path", 874 "required": true 875 } 876 ], 877 "responses": { 878 "200": { 879 "description": "successful operation", 880 "schema": { 881 "$ref": "#/definitions/Order" 882 } 883 }, 884 "400": { 885 "description": "Invalid ID supplied" 886 }, 887 "404": { 888 "description": "Order not found" 889 } 890 } 891 }, 892 "delete": { 893 "description": "For valid response try integer IDs with positive integer value. Negative or non-integer values will generate API errors", 894 "tags": [ 895 "store" 896 ], 897 "summary": "Delete purchase order by ID", 898 "operationId": "OrderDelete", 899 "parameters": [ 900 { 901 "minimum": 1, 902 "type": "integer", 903 "format": "int64", 904 "description": "ID of the order that needs to be deleted", 905 "name": "orderId", 906 "in": "path", 907 "required": true 908 } 909 ], 910 "responses": { 911 "204": { 912 "description": "Deleted successfully" 913 }, 914 "400": { 915 "description": "Invalid ID supplied" 916 }, 917 "404": { 918 "description": "Order not found" 919 } 920 } 921 } 922 } 923 }, 924 "definitions": { 925 "ApiResponse": { 926 "type": "object", 927 "properties": { 928 "code": { 929 "type": "integer", 930 "format": "int32" 931 }, 932 "message": { 933 "type": "string" 934 }, 935 "type": { 936 "type": "string" 937 } 938 } 939 }, 940 "Category": { 941 "type": "object", 942 "properties": { 943 "id": { 944 "type": "integer", 945 "format": "int64" 946 }, 947 "name": { 948 "type": "string" 949 } 950 } 951 }, 952 "Order": { 953 "type": "object", 954 "properties": { 955 "complete": { 956 "type": "boolean", 957 "default": false 958 }, 959 "id": { 960 "type": "integer", 961 "format": "int64" 962 }, 963 "petId": { 964 "type": "integer", 965 "format": "int64" 966 }, 967 "quantity": { 968 "type": "integer", 969 "format": "int32" 970 }, 971 "shipDate": { 972 "type": "string", 973 "format": "date-time" 974 }, 975 "status": { 976 "description": "Order Status", 977 "type": "string", 978 "enum": [ 979 "placed", 980 "approved", 981 "delivered" 982 ] 983 } 984 } 985 }, 986 "Pet": { 987 "type": "object", 988 "required": [ 989 "name", 990 "photoUrls" 991 ], 992 "properties": { 993 "category": { 994 "$ref": "#/definitions/Category" 995 }, 996 "id": { 997 "type": "integer", 998 "format": "int64", 999 "x-go-custom-tag": "gorm:\"primary_key\" query:\"filter,sort\"" 1000 }, 1001 "name": { 1002 "type": "string", 1003 "x-go-custom-tag": "query:\"filter,sort\"", 1004 "example": "doggie" 1005 }, 1006 "photoUrls": { 1007 "type": "array", 1008 "items": { 1009 "type": "string" 1010 }, 1011 "x-go-custom-tag": "gorm:\"-\"" 1012 }, 1013 "status": { 1014 "description": "pet status in the store", 1015 "type": "string", 1016 "enum": [ 1017 "available", 1018 "pending", 1019 "sold" 1020 ], 1021 "x-go-custom-tag": "query:\"filter,sort\"" 1022 }, 1023 "tags": { 1024 "type": "array", 1025 "items": { 1026 "$ref": "#/definitions/Tag" 1027 } 1028 } 1029 } 1030 }, 1031 "Tag": { 1032 "type": "object", 1033 "properties": { 1034 "id": { 1035 "type": "integer", 1036 "format": "int64" 1037 }, 1038 "name": { 1039 "type": "string" 1040 } 1041 } 1042 } 1043 }, 1044 "securityDefinitions": { 1045 "roles": { 1046 "type": "apiKey", 1047 "name": "X-Auth-Roles", 1048 "in": "header" 1049 } 1050 }, 1051 "security": [ 1052 { 1053 "roles": [ 1054 "admin" 1055 ] 1056 } 1057 ], 1058 "tags": [ 1059 { 1060 "description": "Everything about your Pets", 1061 "name": "pet", 1062 "externalDocs": { 1063 "description": "Find out more", 1064 "url": "http://swagger.io" 1065 } 1066 }, 1067 { 1068 "description": "Access to Petstore orders", 1069 "name": "store" 1070 } 1071 ], 1072 "externalDocs": { 1073 "description": "Find out more about Swagger", 1074 "url": "http://swagger.io" 1075 }, 1076 "x-events": [ 1077 { 1078 "entity_name": "pet", 1079 "message": "Pet ${pet_name} was created", 1080 "name": "pet_created", 1081 "properties": { 1082 "pet_id": "int64", 1083 "pet_name": "string" 1084 }, 1085 "severity": "info" 1086 }, 1087 { 1088 "entity_name": "pet", 1089 "message": "Pet ${pet_id} was deleted", 1090 "name": "pet_deleted", 1091 "properties": { 1092 "pet_id": "integer" 1093 }, 1094 "severity": "critical" 1095 } 1096 ] 1097 }`)) 1098 }