github.com/antihax/goesi@v0.0.0-20240126031043-6c54d0cb7f95/meta/api_meta.go (about) 1 /* 2 * ESI Meta Spec 3 * 4 * ESI specs and miscellaneous routes 5 * 6 * OpenAPI spec version: 0.1 7 * 8 * Generated by: https://github.com/swagger-api/swagger-codegen.git 9 * 10 * Licensed under the Apache License, Version 2.0 (the "License"); 11 * you may not use this file except in compliance with the License. 12 * You may obtain a copy of the License at 13 * 14 * http://www.apache.org/licenses/LICENSE-2.0 15 * 16 * Unless required by applicable law or agreed to in writing, software 17 * distributed under the License is distributed on an "AS IS" BASIS, 18 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 19 * See the License for the specific language governing permissions and 20 * limitations under the License. 21 */ 22 23 package meta 24 25 import ( 26 "context" 27 "io/ioutil" 28 "net/http" 29 "net/url" 30 "strings" 31 32 "github.com/antihax/goesi/optional" 33 ) 34 35 // Linger please 36 var ( 37 _ context.Context 38 ) 39 40 type MetaApiService service 41 42 /* 43 MetaApiService Debug request headers 44 Echo the request headers for debugging purposes. Note that the 'Connection' header and any 'X-' headers are not included 45 - @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). 46 47 @return map[string]string 48 */ 49 func (a *MetaApiService) GetHeaders(ctx context.Context) (map[string]string, *http.Response, error) { 50 var ( 51 localVarHttpMethod = strings.ToUpper("Get") 52 localVarPostBody interface{} 53 localVarFileName string 54 localVarFileBytes []byte 55 localVarReturnValue map[string]string 56 ) 57 58 // create path and map variables 59 localVarPath := a.client.basePath + "/headers/" 60 61 localVarHeaderParams := make(map[string]string) 62 localVarQueryParams := url.Values{} 63 localVarFormParams := url.Values{} 64 65 // to determine the Content-Type header 66 localVarHttpContentTypes := []string{} 67 68 // set Content-Type header 69 localVarHttpContentType := selectHeaderContentType(localVarHttpContentTypes) 70 if localVarHttpContentType != "" { 71 localVarHeaderParams["Content-Type"] = localVarHttpContentType 72 } 73 74 // to determine the Accept header 75 localVarHttpHeaderAccepts := []string{"application/json"} 76 77 // set Accept header 78 localVarHttpHeaderAccept := selectHeaderAccept(localVarHttpHeaderAccepts) 79 if localVarHttpHeaderAccept != "" { 80 localVarHeaderParams["Accept"] = localVarHttpHeaderAccept 81 } 82 r, err := a.client.prepareRequest(ctx, localVarPath, localVarHttpMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, localVarFileName, localVarFileBytes) 83 if err != nil { 84 return localVarReturnValue, nil, err 85 } 86 87 localVarHttpResponse, err := a.client.callAPI(r) 88 if err != nil || localVarHttpResponse == nil { 89 return localVarReturnValue, localVarHttpResponse, err 90 } 91 92 localVarBody, err := ioutil.ReadAll(localVarHttpResponse.Body) 93 localVarHttpResponse.Body.Close() 94 if err != nil { 95 return localVarReturnValue, localVarHttpResponse, err 96 } 97 98 if localVarHttpResponse.StatusCode < 400 { 99 // If we succeed, return the data, otherwise pass on to decode error. 100 err = a.client.decode(&localVarReturnValue, localVarBody, localVarHttpResponse.Header.Get("content-type")) 101 if err == nil { 102 return localVarReturnValue, localVarHttpResponse, err 103 } 104 } 105 106 if localVarHttpResponse.StatusCode >= 400 { 107 newErr := GenericSwaggerError{ 108 body: localVarBody, 109 error: localVarHttpResponse.Status, 110 } 111 112 if localVarHttpResponse.StatusCode == 200 { 113 var v map[string]string 114 err = a.client.decode(&v, localVarBody, localVarHttpResponse.Header.Get("content-type")) 115 if err != nil { 116 newErr.error = err.Error() 117 return localVarReturnValue, localVarHttpResponse, newErr 118 } 119 newErr.model = v 120 return localVarReturnValue, localVarHttpResponse, newErr 121 } 122 123 return localVarReturnValue, localVarHttpResponse, newErr 124 } 125 126 return localVarReturnValue, localVarHttpResponse, nil 127 } 128 129 /* 130 MetaApiService Ping route 131 Ping the ESI routers 132 - @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). 133 134 @return string 135 */ 136 func (a *MetaApiService) GetPing(ctx context.Context) (string, *http.Response, error) { 137 var ( 138 localVarHttpMethod = strings.ToUpper("Get") 139 localVarPostBody interface{} 140 localVarFileName string 141 localVarFileBytes []byte 142 localVarReturnValue string 143 ) 144 145 // create path and map variables 146 localVarPath := a.client.basePath + "/ping" 147 148 localVarHeaderParams := make(map[string]string) 149 localVarQueryParams := url.Values{} 150 localVarFormParams := url.Values{} 151 152 // to determine the Content-Type header 153 localVarHttpContentTypes := []string{} 154 155 // set Content-Type header 156 localVarHttpContentType := selectHeaderContentType(localVarHttpContentTypes) 157 if localVarHttpContentType != "" { 158 localVarHeaderParams["Content-Type"] = localVarHttpContentType 159 } 160 161 // to determine the Accept header 162 localVarHttpHeaderAccepts := []string{"text/plain; charset=utf-8"} 163 164 // set Accept header 165 localVarHttpHeaderAccept := selectHeaderAccept(localVarHttpHeaderAccepts) 166 if localVarHttpHeaderAccept != "" { 167 localVarHeaderParams["Accept"] = localVarHttpHeaderAccept 168 } 169 r, err := a.client.prepareRequest(ctx, localVarPath, localVarHttpMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, localVarFileName, localVarFileBytes) 170 if err != nil { 171 return localVarReturnValue, nil, err 172 } 173 174 localVarHttpResponse, err := a.client.callAPI(r) 175 if err != nil || localVarHttpResponse == nil { 176 return localVarReturnValue, localVarHttpResponse, err 177 } 178 179 localVarBody, err := ioutil.ReadAll(localVarHttpResponse.Body) 180 localVarHttpResponse.Body.Close() 181 if err != nil { 182 return localVarReturnValue, localVarHttpResponse, err 183 } 184 185 if localVarHttpResponse.StatusCode < 400 { 186 // If we succeed, return the data, otherwise pass on to decode error. 187 err = a.client.decode(&localVarReturnValue, localVarBody, localVarHttpResponse.Header.Get("content-type")) 188 if err == nil { 189 return localVarReturnValue, localVarHttpResponse, err 190 } 191 } 192 193 if localVarHttpResponse.StatusCode >= 400 { 194 newErr := GenericSwaggerError{ 195 body: localVarBody, 196 error: localVarHttpResponse.Status, 197 } 198 199 if localVarHttpResponse.StatusCode == 200 { 200 var v string 201 err = a.client.decode(&v, localVarBody, localVarHttpResponse.Header.Get("content-type")) 202 if err != nil { 203 newErr.error = err.Error() 204 return localVarReturnValue, localVarHttpResponse, newErr 205 } 206 newErr.model = v 207 return localVarReturnValue, localVarHttpResponse, newErr 208 } 209 210 return localVarReturnValue, localVarHttpResponse, newErr 211 } 212 213 return localVarReturnValue, localVarHttpResponse, nil 214 } 215 216 /* 217 MetaApiService ESI health status 218 Provides a general health indicator per route and method 219 * @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). 220 * @param optional nil or *GetStatusOpts - Optional Parameters: 221 * @param "Version" (optional.String) - The version of metrics to request. Note that alternate versions are grouped together 222 223 @return []GetStatusItem 224 */ 225 226 type GetStatusOpts struct { 227 Version optional.String 228 } 229 230 func (a *MetaApiService) GetStatus(ctx context.Context, localVarOptionals *GetStatusOpts) ([]GetStatusItem, *http.Response, error) { 231 var ( 232 localVarHttpMethod = strings.ToUpper("Get") 233 localVarPostBody interface{} 234 localVarFileName string 235 localVarFileBytes []byte 236 localVarReturnValue GetStatusItemList 237 ) 238 239 // create path and map variables 240 localVarPath := a.client.basePath + "/status.json" 241 242 localVarHeaderParams := make(map[string]string) 243 localVarQueryParams := url.Values{} 244 localVarFormParams := url.Values{} 245 246 if localVarOptionals != nil && localVarOptionals.Version.IsSet() { 247 localVarQueryParams.Add("version", parameterToString(localVarOptionals.Version.Value(), "")) 248 } 249 // to determine the Content-Type header 250 localVarHttpContentTypes := []string{} 251 252 // set Content-Type header 253 localVarHttpContentType := selectHeaderContentType(localVarHttpContentTypes) 254 if localVarHttpContentType != "" { 255 localVarHeaderParams["Content-Type"] = localVarHttpContentType 256 } 257 258 // to determine the Accept header 259 localVarHttpHeaderAccepts := []string{"application/json"} 260 261 // set Accept header 262 localVarHttpHeaderAccept := selectHeaderAccept(localVarHttpHeaderAccepts) 263 if localVarHttpHeaderAccept != "" { 264 localVarHeaderParams["Accept"] = localVarHttpHeaderAccept 265 } 266 r, err := a.client.prepareRequest(ctx, localVarPath, localVarHttpMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, localVarFileName, localVarFileBytes) 267 if err != nil { 268 return localVarReturnValue, nil, err 269 } 270 271 localVarHttpResponse, err := a.client.callAPI(r) 272 if err != nil || localVarHttpResponse == nil { 273 return localVarReturnValue, localVarHttpResponse, err 274 } 275 276 localVarBody, err := ioutil.ReadAll(localVarHttpResponse.Body) 277 localVarHttpResponse.Body.Close() 278 if err != nil { 279 return localVarReturnValue, localVarHttpResponse, err 280 } 281 282 if localVarHttpResponse.StatusCode < 400 { 283 // If we succeed, return the data, otherwise pass on to decode error. 284 err = a.client.decode(&localVarReturnValue, localVarBody, localVarHttpResponse.Header.Get("content-type")) 285 if err == nil { 286 return localVarReturnValue, localVarHttpResponse, err 287 } 288 } 289 290 if localVarHttpResponse.StatusCode >= 400 { 291 newErr := GenericSwaggerError{ 292 body: localVarBody, 293 error: localVarHttpResponse.Status, 294 } 295 296 if localVarHttpResponse.StatusCode == 200 { 297 var v []GetStatusItem 298 err = a.client.decode(&v, localVarBody, localVarHttpResponse.Header.Get("content-type")) 299 if err != nil { 300 newErr.error = err.Error() 301 return localVarReturnValue, localVarHttpResponse, newErr 302 } 303 newErr.model = v 304 return localVarReturnValue, localVarHttpResponse, newErr 305 } 306 307 if localVarHttpResponse.StatusCode == 404 { 308 var v GetStatusNotFound 309 err = a.client.decode(&v, localVarBody, localVarHttpResponse.Header.Get("content-type")) 310 if err != nil { 311 newErr.error = err.Error() 312 return localVarReturnValue, localVarHttpResponse, newErr 313 } 314 newErr.model = v 315 return localVarReturnValue, localVarHttpResponse, newErr 316 } 317 318 return localVarReturnValue, localVarHttpResponse, newErr 319 } 320 321 return localVarReturnValue, localVarHttpResponse, nil 322 } 323 324 /* 325 MetaApiService Verify access token 326 Verify authorization tokens in ESI's auth cache 327 * @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). 328 * @param optional nil or *GetVerifyOpts - Optional Parameters: 329 * @param "UserAgent" (optional.String) - Client identifier, takes precedence over headers 330 * @param "XUserAgent" (optional.String) - Client identifier, takes precedence over User-Agent 331 * @param "Datasource" (optional.String) - The server name you would like data from 332 * @param "Token" (optional.String) - Access token to use if unable to set a header 333 * @param "Authorization" (optional.String) - Access token, in the format of \"Bearer <access token>\" 334 335 @return GetVerifyOk 336 */ 337 338 type GetVerifyOpts struct { 339 UserAgent optional.String 340 XUserAgent optional.String 341 Datasource optional.String 342 Token optional.String 343 Authorization optional.String 344 } 345 346 func (a *MetaApiService) GetVerify(ctx context.Context, localVarOptionals *GetVerifyOpts) (GetVerifyOk, *http.Response, error) { 347 var ( 348 localVarHttpMethod = strings.ToUpper("Get") 349 localVarPostBody interface{} 350 localVarFileName string 351 localVarFileBytes []byte 352 localVarReturnValue GetVerifyOk 353 ) 354 355 // create path and map variables 356 localVarPath := a.client.basePath + "/verify/" 357 358 localVarHeaderParams := make(map[string]string) 359 localVarQueryParams := url.Values{} 360 localVarFormParams := url.Values{} 361 362 if localVarOptionals != nil && localVarOptionals.UserAgent.IsSet() { 363 localVarQueryParams.Add("user_agent", parameterToString(localVarOptionals.UserAgent.Value(), "")) 364 } 365 if localVarOptionals != nil && localVarOptionals.Datasource.IsSet() { 366 localVarQueryParams.Add("datasource", parameterToString(localVarOptionals.Datasource.Value(), "")) 367 } 368 if localVarOptionals != nil && localVarOptionals.Token.IsSet() { 369 localVarQueryParams.Add("token", parameterToString(localVarOptionals.Token.Value(), "")) 370 } 371 // to determine the Content-Type header 372 localVarHttpContentTypes := []string{} 373 374 // set Content-Type header 375 localVarHttpContentType := selectHeaderContentType(localVarHttpContentTypes) 376 if localVarHttpContentType != "" { 377 localVarHeaderParams["Content-Type"] = localVarHttpContentType 378 } 379 380 // to determine the Accept header 381 localVarHttpHeaderAccepts := []string{"application/json"} 382 383 // set Accept header 384 localVarHttpHeaderAccept := selectHeaderAccept(localVarHttpHeaderAccepts) 385 if localVarHttpHeaderAccept != "" { 386 localVarHeaderParams["Accept"] = localVarHttpHeaderAccept 387 } 388 if localVarOptionals != nil && localVarOptionals.XUserAgent.IsSet() { 389 localVarHeaderParams["X-User-Agent"] = parameterToString(localVarOptionals.XUserAgent.Value(), "") 390 } 391 if localVarOptionals != nil && localVarOptionals.Authorization.IsSet() { 392 localVarHeaderParams["Authorization"] = parameterToString(localVarOptionals.Authorization.Value(), "") 393 } 394 r, err := a.client.prepareRequest(ctx, localVarPath, localVarHttpMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, localVarFileName, localVarFileBytes) 395 if err != nil { 396 return localVarReturnValue, nil, err 397 } 398 399 localVarHttpResponse, err := a.client.callAPI(r) 400 if err != nil || localVarHttpResponse == nil { 401 return localVarReturnValue, localVarHttpResponse, err 402 } 403 404 localVarBody, err := ioutil.ReadAll(localVarHttpResponse.Body) 405 localVarHttpResponse.Body.Close() 406 if err != nil { 407 return localVarReturnValue, localVarHttpResponse, err 408 } 409 410 if localVarHttpResponse.StatusCode < 400 { 411 // If we succeed, return the data, otherwise pass on to decode error. 412 err = a.client.decode(&localVarReturnValue, localVarBody, localVarHttpResponse.Header.Get("content-type")) 413 if err == nil { 414 return localVarReturnValue, localVarHttpResponse, err 415 } 416 } 417 418 if localVarHttpResponse.StatusCode >= 400 { 419 newErr := GenericSwaggerError{ 420 body: localVarBody, 421 error: localVarHttpResponse.Status, 422 } 423 424 if localVarHttpResponse.StatusCode == 200 { 425 var v GetVerifyOk 426 err = a.client.decode(&v, localVarBody, localVarHttpResponse.Header.Get("content-type")) 427 if err != nil { 428 newErr.error = err.Error() 429 return localVarReturnValue, localVarHttpResponse, newErr 430 } 431 newErr.model = v 432 return localVarReturnValue, localVarHttpResponse, newErr 433 } 434 435 if localVarHttpResponse.StatusCode == 400 { 436 var v GetVerifyError 437 err = a.client.decode(&v, localVarBody, localVarHttpResponse.Header.Get("content-type")) 438 if err != nil { 439 newErr.error = err.Error() 440 return localVarReturnValue, localVarHttpResponse, newErr 441 } 442 newErr.model = v 443 return localVarReturnValue, localVarHttpResponse, newErr 444 } 445 446 if localVarHttpResponse.StatusCode == 401 { 447 var v GetVerifyUnauthorized 448 err = a.client.decode(&v, localVarBody, localVarHttpResponse.Header.Get("content-type")) 449 if err != nil { 450 newErr.error = err.Error() 451 return localVarReturnValue, localVarHttpResponse, newErr 452 } 453 newErr.model = v 454 return localVarReturnValue, localVarHttpResponse, newErr 455 } 456 457 if localVarHttpResponse.StatusCode == 404 { 458 var v GetVerifyNotFound 459 err = a.client.decode(&v, localVarBody, localVarHttpResponse.Header.Get("content-type")) 460 if err != nil { 461 newErr.error = err.Error() 462 return localVarReturnValue, localVarHttpResponse, newErr 463 } 464 newErr.model = v 465 return localVarReturnValue, localVarHttpResponse, newErr 466 } 467 468 return localVarReturnValue, localVarHttpResponse, newErr 469 } 470 471 return localVarReturnValue, localVarHttpResponse, nil 472 } 473 474 /* 475 MetaApiService List versions 476 List all endpoint versions 477 * @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). 478 * @param optional nil or *GetVersionsOpts - Optional Parameters: 479 * @param "UserAgent" (optional.String) - Client identifier, takes precedence over headers 480 * @param "XUserAgent" (optional.String) - Client identifier, takes precedence over User-Agent 481 482 @return []string 483 */ 484 485 type GetVersionsOpts struct { 486 UserAgent optional.String 487 XUserAgent optional.String 488 } 489 490 func (a *MetaApiService) GetVersions(ctx context.Context, localVarOptionals *GetVersionsOpts) ([]string, *http.Response, error) { 491 var ( 492 localVarHttpMethod = strings.ToUpper("Get") 493 localVarPostBody interface{} 494 localVarFileName string 495 localVarFileBytes []byte 496 localVarReturnValue []string 497 ) 498 499 // create path and map variables 500 localVarPath := a.client.basePath + "/versions/" 501 502 localVarHeaderParams := make(map[string]string) 503 localVarQueryParams := url.Values{} 504 localVarFormParams := url.Values{} 505 506 if localVarOptionals != nil && localVarOptionals.UserAgent.IsSet() { 507 localVarQueryParams.Add("user_agent", parameterToString(localVarOptionals.UserAgent.Value(), "")) 508 } 509 // to determine the Content-Type header 510 localVarHttpContentTypes := []string{} 511 512 // set Content-Type header 513 localVarHttpContentType := selectHeaderContentType(localVarHttpContentTypes) 514 if localVarHttpContentType != "" { 515 localVarHeaderParams["Content-Type"] = localVarHttpContentType 516 } 517 518 // to determine the Accept header 519 localVarHttpHeaderAccepts := []string{"application/json"} 520 521 // set Accept header 522 localVarHttpHeaderAccept := selectHeaderAccept(localVarHttpHeaderAccepts) 523 if localVarHttpHeaderAccept != "" { 524 localVarHeaderParams["Accept"] = localVarHttpHeaderAccept 525 } 526 if localVarOptionals != nil && localVarOptionals.XUserAgent.IsSet() { 527 localVarHeaderParams["X-User-Agent"] = parameterToString(localVarOptionals.XUserAgent.Value(), "") 528 } 529 r, err := a.client.prepareRequest(ctx, localVarPath, localVarHttpMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, localVarFileName, localVarFileBytes) 530 if err != nil { 531 return localVarReturnValue, nil, err 532 } 533 534 localVarHttpResponse, err := a.client.callAPI(r) 535 if err != nil || localVarHttpResponse == nil { 536 return localVarReturnValue, localVarHttpResponse, err 537 } 538 539 localVarBody, err := ioutil.ReadAll(localVarHttpResponse.Body) 540 localVarHttpResponse.Body.Close() 541 if err != nil { 542 return localVarReturnValue, localVarHttpResponse, err 543 } 544 545 if localVarHttpResponse.StatusCode < 400 { 546 // If we succeed, return the data, otherwise pass on to decode error. 547 err = a.client.decode(&localVarReturnValue, localVarBody, localVarHttpResponse.Header.Get("content-type")) 548 if err == nil { 549 return localVarReturnValue, localVarHttpResponse, err 550 } 551 } 552 553 if localVarHttpResponse.StatusCode >= 400 { 554 newErr := GenericSwaggerError{ 555 body: localVarBody, 556 error: localVarHttpResponse.Status, 557 } 558 559 if localVarHttpResponse.StatusCode == 200 { 560 var v []string 561 err = a.client.decode(&v, localVarBody, localVarHttpResponse.Header.Get("content-type")) 562 if err != nil { 563 newErr.error = err.Error() 564 return localVarReturnValue, localVarHttpResponse, newErr 565 } 566 newErr.model = v 567 return localVarReturnValue, localVarHttpResponse, newErr 568 } 569 570 return localVarReturnValue, localVarHttpResponse, newErr 571 } 572 573 return localVarReturnValue, localVarHttpResponse, nil 574 }