github.com/thetreep/go-swagger@v0.0.0-20240223100711-35af64f14f01/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 "title": "is the response to an API call", 389 "properties": { 390 "code": { 391 "type": "integer", 392 "format": "int32" 393 }, 394 "message": { 395 "type": "string" 396 }, 397 "type": { 398 "type": "string" 399 } 400 } 401 }, 402 "Category": { 403 "type": "object", 404 "properties": { 405 "id": { 406 "type": "integer", 407 "format": "int64" 408 }, 409 "name": { 410 "type": "string" 411 } 412 } 413 }, 414 "Order": { 415 "type": "object", 416 "properties": { 417 "complete": { 418 "type": "boolean", 419 "default": false 420 }, 421 "id": { 422 "type": "integer", 423 "format": "int64" 424 }, 425 "petId": { 426 "type": "integer", 427 "format": "int64" 428 }, 429 "quantity": { 430 "type": "integer", 431 "format": "int32" 432 }, 433 "shipDate": { 434 "type": "string", 435 "format": "date-time" 436 }, 437 "status": { 438 "description": "Order Status", 439 "type": "string", 440 "enum": [ 441 "placed", 442 "approved", 443 "delivered" 444 ] 445 } 446 } 447 }, 448 "Pet": { 449 "type": "object", 450 "required": [ 451 "name", 452 "photoUrls" 453 ], 454 "properties": { 455 "category": { 456 "$ref": "#/definitions/Category" 457 }, 458 "id": { 459 "type": "integer", 460 "format": "int64", 461 "x-go-custom-tag": "gorm:\"primary_key\" query:\"filter,sort\"" 462 }, 463 "name": { 464 "type": "string", 465 "x-go-custom-tag": "query:\"filter,sort\"", 466 "example": "doggie" 467 }, 468 "photoUrls": { 469 "type": "array", 470 "items": { 471 "type": "string" 472 }, 473 "x-go-custom-tag": "gorm:\"-\"" 474 }, 475 "status": { 476 "description": "pet status in the store", 477 "type": "string", 478 "enum": [ 479 "available", 480 "pending", 481 "sold" 482 ], 483 "x-go-custom-tag": "query:\"filter,sort\"" 484 }, 485 "tags": { 486 "type": "array", 487 "items": { 488 "$ref": "#/definitions/Tag" 489 } 490 } 491 } 492 }, 493 "Tag": { 494 "type": "object", 495 "properties": { 496 "id": { 497 "type": "integer", 498 "format": "int64" 499 }, 500 "name": { 501 "type": "string" 502 } 503 } 504 } 505 }, 506 "securityDefinitions": { 507 "roles": { 508 "type": "apiKey", 509 "name": "X-Auth-Roles", 510 "in": "header" 511 } 512 }, 513 "security": [ 514 { 515 "roles": [ 516 "admin" 517 ] 518 } 519 ], 520 "tags": [ 521 { 522 "description": "Everything about your Pets", 523 "name": "pet", 524 "externalDocs": { 525 "description": "Find out more", 526 "url": "http://swagger.io" 527 } 528 }, 529 { 530 "description": "Access to Petstore orders", 531 "name": "store" 532 } 533 ], 534 "externalDocs": { 535 "description": "Find out more about Swagger", 536 "url": "http://swagger.io" 537 }, 538 "x-events": [ 539 { 540 "entity_name": "pet", 541 "message": "Pet ${pet_name} was created", 542 "name": "pet_created", 543 "properties": { 544 "pet_id": "int64", 545 "pet_name": "string" 546 }, 547 "severity": "info" 548 }, 549 { 550 "entity_name": "pet", 551 "message": "Pet ${pet_id} was deleted", 552 "name": "pet_deleted", 553 "properties": { 554 "pet_id": "integer" 555 }, 556 "severity": "critical" 557 } 558 ] 559 }`)) 560 FlatSwaggerJSON = json.RawMessage([]byte(`{ 561 "consumes": [ 562 "application/json" 563 ], 564 "produces": [ 565 "application/json" 566 ], 567 "schemes": [ 568 "http" 569 ], 570 "swagger": "2.0", 571 "info": { 572 "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.", 573 "title": "Petstore", 574 "version": "1.0.0" 575 }, 576 "host": "petstore.service.strato", 577 "basePath": "/api/v2", 578 "paths": { 579 "/pet": { 580 "get": { 581 "security": [ 582 { 583 "roles": [ 584 "admin", 585 "member" 586 ] 587 } 588 ], 589 "tags": [ 590 "pet" 591 ], 592 "summary": "List pets", 593 "operationId": "PetList", 594 "parameters": [ 595 { 596 "type": "array", 597 "items": { 598 "enum": [ 599 "available", 600 "pending", 601 "sold" 602 ], 603 "type": "string", 604 "default": "available" 605 }, 606 "collectionFormat": "multi", 607 "description": "Status values that need to be considered for filter", 608 "name": "status", 609 "in": "query", 610 "required": true 611 } 612 ], 613 "responses": { 614 "200": { 615 "description": "successful operation", 616 "schema": { 617 "type": "array", 618 "items": { 619 "$ref": "#/definitions/Pet" 620 } 621 } 622 }, 623 "400": { 624 "description": "Invalid status value" 625 } 626 } 627 }, 628 "put": { 629 "tags": [ 630 "pet" 631 ], 632 "summary": "Update an existing pet", 633 "operationId": "PetUpdate", 634 "parameters": [ 635 { 636 "description": "Pet object that needs to be added to the store", 637 "name": "body", 638 "in": "body", 639 "required": true, 640 "schema": { 641 "$ref": "#/definitions/Pet" 642 } 643 } 644 ], 645 "responses": { 646 "201": { 647 "description": "Updated successfully", 648 "schema": { 649 "$ref": "#/definitions/Pet" 650 } 651 }, 652 "400": { 653 "description": "Invalid ID supplied" 654 }, 655 "404": { 656 "description": "Pet not found" 657 }, 658 "405": { 659 "description": "Validation exception" 660 } 661 } 662 }, 663 "post": { 664 "tags": [ 665 "pet" 666 ], 667 "summary": "Add a new pet to the store", 668 "operationId": "PetCreate", 669 "parameters": [ 670 { 671 "description": "Pet object that needs to be added to the store", 672 "name": "body", 673 "in": "body", 674 "required": true, 675 "schema": { 676 "$ref": "#/definitions/Pet" 677 } 678 } 679 ], 680 "responses": { 681 "201": { 682 "description": "Created", 683 "schema": { 684 "$ref": "#/definitions/Pet" 685 } 686 }, 687 "405": { 688 "description": "Invalid input" 689 } 690 } 691 } 692 }, 693 "/pet/{petId}": { 694 "get": { 695 "security": [ 696 { 697 "roles": [ 698 "admin", 699 "member" 700 ] 701 } 702 ], 703 "tags": [ 704 "pet" 705 ], 706 "summary": "Get pet by it's ID", 707 "operationId": "PetGet", 708 "parameters": [ 709 { 710 "type": "integer", 711 "format": "int64", 712 "description": "ID of pet to return", 713 "name": "petId", 714 "in": "path", 715 "required": true 716 } 717 ], 718 "responses": { 719 "200": { 720 "description": "successful operation", 721 "schema": { 722 "$ref": "#/definitions/Pet" 723 } 724 }, 725 "400": { 726 "description": "Invalid ID supplied" 727 }, 728 "404": { 729 "description": "Pet not found" 730 } 731 } 732 }, 733 "delete": { 734 "tags": [ 735 "pet" 736 ], 737 "summary": "Deletes a pet", 738 "operationId": "PetDelete", 739 "parameters": [ 740 { 741 "type": "string", 742 "name": "api_key", 743 "in": "header" 744 }, 745 { 746 "type": "integer", 747 "format": "int64", 748 "description": "Pet id to delete", 749 "name": "petId", 750 "in": "path", 751 "required": true 752 } 753 ], 754 "responses": { 755 "204": { 756 "description": "Deleted successfully" 757 }, 758 "400": { 759 "description": "Invalid ID supplied" 760 }, 761 "404": { 762 "description": "Pet not found" 763 } 764 } 765 } 766 }, 767 "/pet/{petId}/image": { 768 "post": { 769 "tags": [ 770 "pet" 771 ], 772 "summary": "uploads an image", 773 "operationId": "PetUploadImage", 774 "parameters": [ 775 { 776 "type": "integer", 777 "format": "int64", 778 "description": "ID of pet to update", 779 "name": "petId", 780 "in": "path", 781 "required": true 782 }, 783 { 784 "type": "string", 785 "description": "Additional data to pass to server", 786 "name": "additionalMetadata", 787 "in": "formData" 788 }, 789 { 790 "type": "file", 791 "description": "file to upload", 792 "name": "file", 793 "in": "formData" 794 } 795 ], 796 "responses": { 797 "200": { 798 "description": "successful operation", 799 "schema": { 800 "$ref": "#/definitions/ApiResponse" 801 } 802 } 803 } 804 } 805 }, 806 "/store/inventory": { 807 "get": { 808 "tags": [ 809 "store" 810 ], 811 "summary": "Returns pet inventories by status", 812 "operationId": "InventoryGet", 813 "responses": { 814 "200": { 815 "description": "successful operation", 816 "schema": { 817 "type": "object", 818 "additionalProperties": { 819 "type": "integer", 820 "format": "int32" 821 } 822 } 823 } 824 } 825 } 826 }, 827 "/store/order": { 828 "post": { 829 "tags": [ 830 "store" 831 ], 832 "summary": "Place an order for a pet", 833 "operationId": "OrderCreate", 834 "parameters": [ 835 { 836 "description": "order placed for purchasing the pet", 837 "name": "body", 838 "in": "body", 839 "required": true, 840 "schema": { 841 "$ref": "#/definitions/Order" 842 } 843 } 844 ], 845 "responses": { 846 "200": { 847 "description": "successful operation", 848 "schema": { 849 "$ref": "#/definitions/Order" 850 } 851 }, 852 "400": { 853 "description": "Invalid Order" 854 } 855 } 856 } 857 }, 858 "/store/order/{orderId}": { 859 "get": { 860 "description": "For valid response try integer IDs with value \u003e= 1 and \u003c= 10. Other values will generated exceptions", 861 "tags": [ 862 "store" 863 ], 864 "summary": "Find purchase order by ID", 865 "operationId": "OrderGet", 866 "parameters": [ 867 { 868 "maximum": 10, 869 "minimum": 1, 870 "type": "integer", 871 "format": "int64", 872 "description": "ID of pet that needs to be fetched", 873 "name": "orderId", 874 "in": "path", 875 "required": true 876 } 877 ], 878 "responses": { 879 "200": { 880 "description": "successful operation", 881 "schema": { 882 "$ref": "#/definitions/Order" 883 } 884 }, 885 "400": { 886 "description": "Invalid ID supplied" 887 }, 888 "404": { 889 "description": "Order not found" 890 } 891 } 892 }, 893 "delete": { 894 "description": "For valid response try integer IDs with positive integer value. Negative or non-integer values will generate API errors", 895 "tags": [ 896 "store" 897 ], 898 "summary": "Delete purchase order by ID", 899 "operationId": "OrderDelete", 900 "parameters": [ 901 { 902 "minimum": 1, 903 "type": "integer", 904 "format": "int64", 905 "description": "ID of the order that needs to be deleted", 906 "name": "orderId", 907 "in": "path", 908 "required": true 909 } 910 ], 911 "responses": { 912 "204": { 913 "description": "Deleted successfully" 914 }, 915 "400": { 916 "description": "Invalid ID supplied" 917 }, 918 "404": { 919 "description": "Order not found" 920 } 921 } 922 } 923 } 924 }, 925 "definitions": { 926 "ApiResponse": { 927 "type": "object", 928 "title": "is the response to an API call", 929 "properties": { 930 "code": { 931 "type": "integer", 932 "format": "int32" 933 }, 934 "message": { 935 "type": "string" 936 }, 937 "type": { 938 "type": "string" 939 } 940 } 941 }, 942 "Category": { 943 "type": "object", 944 "properties": { 945 "id": { 946 "type": "integer", 947 "format": "int64" 948 }, 949 "name": { 950 "type": "string" 951 } 952 } 953 }, 954 "Order": { 955 "type": "object", 956 "properties": { 957 "complete": { 958 "type": "boolean", 959 "default": false 960 }, 961 "id": { 962 "type": "integer", 963 "format": "int64" 964 }, 965 "petId": { 966 "type": "integer", 967 "format": "int64" 968 }, 969 "quantity": { 970 "type": "integer", 971 "format": "int32" 972 }, 973 "shipDate": { 974 "type": "string", 975 "format": "date-time" 976 }, 977 "status": { 978 "description": "Order Status", 979 "type": "string", 980 "enum": [ 981 "placed", 982 "approved", 983 "delivered" 984 ] 985 } 986 } 987 }, 988 "Pet": { 989 "type": "object", 990 "required": [ 991 "name", 992 "photoUrls" 993 ], 994 "properties": { 995 "category": { 996 "$ref": "#/definitions/Category" 997 }, 998 "id": { 999 "type": "integer", 1000 "format": "int64", 1001 "x-go-custom-tag": "gorm:\"primary_key\" query:\"filter,sort\"" 1002 }, 1003 "name": { 1004 "type": "string", 1005 "x-go-custom-tag": "query:\"filter,sort\"", 1006 "example": "doggie" 1007 }, 1008 "photoUrls": { 1009 "type": "array", 1010 "items": { 1011 "type": "string" 1012 }, 1013 "x-go-custom-tag": "gorm:\"-\"" 1014 }, 1015 "status": { 1016 "description": "pet status in the store", 1017 "type": "string", 1018 "enum": [ 1019 "available", 1020 "pending", 1021 "sold" 1022 ], 1023 "x-go-custom-tag": "query:\"filter,sort\"" 1024 }, 1025 "tags": { 1026 "type": "array", 1027 "items": { 1028 "$ref": "#/definitions/Tag" 1029 } 1030 } 1031 } 1032 }, 1033 "Tag": { 1034 "type": "object", 1035 "properties": { 1036 "id": { 1037 "type": "integer", 1038 "format": "int64" 1039 }, 1040 "name": { 1041 "type": "string" 1042 } 1043 } 1044 } 1045 }, 1046 "securityDefinitions": { 1047 "roles": { 1048 "type": "apiKey", 1049 "name": "X-Auth-Roles", 1050 "in": "header" 1051 } 1052 }, 1053 "security": [ 1054 { 1055 "roles": [ 1056 "admin" 1057 ] 1058 } 1059 ], 1060 "tags": [ 1061 { 1062 "description": "Everything about your Pets", 1063 "name": "pet", 1064 "externalDocs": { 1065 "description": "Find out more", 1066 "url": "http://swagger.io" 1067 } 1068 }, 1069 { 1070 "description": "Access to Petstore orders", 1071 "name": "store" 1072 } 1073 ], 1074 "externalDocs": { 1075 "description": "Find out more about Swagger", 1076 "url": "http://swagger.io" 1077 }, 1078 "x-events": [ 1079 { 1080 "entity_name": "pet", 1081 "message": "Pet ${pet_name} was created", 1082 "name": "pet_created", 1083 "properties": { 1084 "pet_id": "int64", 1085 "pet_name": "string" 1086 }, 1087 "severity": "info" 1088 }, 1089 { 1090 "entity_name": "pet", 1091 "message": "Pet ${pet_id} was deleted", 1092 "name": "pet_deleted", 1093 "properties": { 1094 "pet_id": "integer" 1095 }, 1096 "severity": "critical" 1097 } 1098 ] 1099 }`)) 1100 }