github.com/thetreep/go-swagger@v0.0.0-20240223100711-35af64f14f01/fixtures/bugs/2919/edge-api/shared/specs.yml (about) 1 --- 2 3 paths: 4 specs: 5 get: 6 summary: Returns a list of API specs 7 description: Returns a list of spec files embedded within the controller for consumption/documentation/code geneartion 8 security: [ ] 9 tags: 10 - Informational 11 operationId: listSpecs 12 responses: 13 '200': 14 $ref: '#/responses/listSpecs' 15 specs-id: 16 parameters: 17 - $ref: 'parameters.yml#/id' 18 get: 19 summary: Return a single spec resource 20 description: Returns single spec resource embedded within the controller for consumption/documentation/code geneartion 21 security: [ ] 22 tags: 23 - Informational 24 operationId: detailSpec 25 responses: 26 '200': 27 $ref: '#/responses/detailSpec' 28 specs-id-spec: 29 parameters: 30 - $ref: 'parameters.yml#/id' 31 get: 32 summary: Returns the spec's file 33 description: Return the body of the specification (i.e. Swagger, OpenAPI 2.0, 3.0, etc). 34 security: [ ] 35 tags: 36 - Informational 37 operationId: detailSpecBody 38 produces: 39 - text/yaml 40 - application/json 41 responses: 42 '200': 43 $ref: '#/responses/detailSpecBody' 44 45 responses: 46 listSpecs: 47 description: A list of specifications 48 schema: 49 $ref: '#/definitions/listSpecsEnvelope' 50 detailSpec: 51 description: A single specification 52 schema: 53 $ref: '#/definitions/detailSpecEnvelope' 54 detailSpecBody: 55 description: Returns the document that represents the specification 56 schema: 57 $ref: '#/definitions/detailSpecBodyEnvelope' 58 59 definitions: 60 listSpecsEnvelope: 61 type: object 62 required: 63 - meta 64 - data 65 properties: 66 meta: 67 $ref: 'standard-responses.yml#/definitions/meta' 68 data: 69 $ref: '#/definitions/specList' 70 detailSpecEnvelope: 71 type: object 72 required: 73 - meta 74 - data 75 properties: 76 meta: 77 $ref: 'standard-responses.yml#/definitions/meta' 78 data: 79 $ref: '#/definitions/specDetail' 80 detailSpecBodyEnvelope: 81 type: object 82 required: 83 - meta 84 - data 85 properties: 86 meta: 87 $ref: 'standard-responses.yml#/definitions/meta' 88 data: 89 $ref: '#/definitions/specBodyDetail' 90 specList: 91 type: array 92 items: 93 $ref: '#/definitions/specDetail' 94 specDetail: 95 type: object 96 allOf: 97 - $ref: 'base-entity.yml#/definitions/baseEntity' 98 - type: object 99 required: 100 - name 101 properties: 102 name: 103 type: string 104 specBodyDetail: 105 type: string