github.com/optim-corp/cios-golang-sdk@v0.5.1/openapi/openapis/contract.openapi.yml (about) 1 openapi: "3.0.3" 2 info: 3 version: 0.0.1 4 title: Cios Contract Openapi 5 6 paths: 7 /v2/contracts: 8 get: 9 tags: 10 - contract 11 summary: 契約一覧情報を取得する 12 description: |- 13 SUPPORTED APPLICATION TYPE: クライアント 14 REQUIRED SCOPES: contract.read 15 operationId: getContracts 16 parameters: 17 - $ref: '../components/parameters.yml#/components/parameters/page' 18 - $ref: '../components/parameters.yml#/components/parameters/limit' 19 - $ref: '../components/parameters.yml#/components/parameters/offset' 20 responses: 21 200: 22 description: OK 23 content: 24 application/json: 25 schema: 26 $ref: '../components/contract-component.openapi.yml#/components/schemas/MultipleContract' 27 400: 28 $ref: "../components/responses.yml#/components/responses/invalid_request" 29 401: 30 $ref: "../components/responses.yml#/components/responses/invalid_token" 31 403: 32 $ref: "../components/responses.yml#/components/responses/insufficient_scopes" 33 500: 34 $ref: "../components/responses.yml#/components/responses/internal_server_error" 35 503: 36 $ref: "../components/responses.yml#/components/responses/server_temporarily_unavailable" 37 /v2/contracts/{contract_id}: 38 get: 39 tags: 40 - contract 41 summary: 契約IDの契約情報を取得する 42 description: contract.read 43 operationId: getContract 44 parameters: 45 - $ref: '../components/parameters.yml#/components/parameters/page' 46 - $ref: '../components/parameters.yml#/components/parameters/limit' 47 - $ref: '../components/parameters.yml#/components/parameters/offset' 48 responses: 49 200: 50 description: OK 51 content: 52 application/json: 53 schema: 54 $ref: '../components/contract-component.openapi.yml#/components/schemas/Contract' 55 400: 56 $ref: "../components/responses.yml#/components/responses/invalid_request" 57 401: 58 $ref: "../components/responses.yml#/components/responses/invalid_token" 59 403: 60 $ref: "../components/responses.yml#/components/responses/insufficient_scopes" 61 500: 62 $ref: "../components/responses.yml#/components/responses/internal_server_error" 63 503: 64 $ref: "../components/responses.yml#/components/responses/server_temporarily_unavailable" 65 /v2/contracts/{contract_id}/users: 66 get: 67 tags: 68 - contract 69 summary: 契約IDの契約情報を取得する 70 description: contract.read 71 operationId: getContractUsers 72 parameters: 73 - $ref: '../components/parameters.yml#/components/parameters/contract_id' 74 responses: 75 200: 76 description: OK 77 content: 78 application/json: 79 schema: 80 $ref: '../components/contract-component.openapi.yml#/components/schemas/MultipleContractUser' 81 400: 82 $ref: "../components/responses.yml#/components/responses/invalid_request" 83 401: 84 $ref: "../components/responses.yml#/components/responses/invalid_token" 85 403: 86 $ref: "../components/responses.yml#/components/responses/insufficient_scopes" 87 500: 88 $ref: "../components/responses.yml#/components/responses/internal_server_error" 89 503: 90 $ref: "../components/responses.yml#/components/responses/server_temporarily_unavailable" 91 /v2/contracts/{contract_id}/users/{user_id}: 92 get: 93 tags: 94 - contract 95 summary: 契約IDの契約情報を取得する 96 description: contract.read 97 operationId: getContractUser 98 parameters: 99 - $ref: '../components/parameters.yml#/components/parameters/contract_id' 100 - $ref: '../components/parameters.yml#/components/parameters/user_id_path' 101 responses: 102 200: 103 description: OK 104 content: 105 application/json: 106 schema: 107 $ref: '../components/contract-component.openapi.yml#/components/schemas/ContractUser' 108 400: 109 $ref: "../components/responses.yml#/components/responses/invalid_request" 110 401: 111 $ref: "../components/responses.yml#/components/responses/invalid_token" 112 403: 113 $ref: "../components/responses.yml#/components/responses/insufficient_scopes" 114 500: 115 $ref: "../components/responses.yml#/components/responses/internal_server_error" 116 503: 117 $ref: "../components/responses.yml#/components/responses/server_temporarily_unavailable" 118 119 120 components: 121 securitySchemes: 122 bearerAuth: 123 type: http 124 scheme: bearer 125 bearerFormat: JWT