Skip to content

Commit

Permalink
Merge pull request #2200 from keboola/fix-apps-proxy-component-url
Browse files Browse the repository at this point in the history
fix: Change URL of apps proxy component url in swagger
  • Loading branch information
Matovidlo authored Jan 7, 2025
2 parents 12b279c + e737c53 commit d8dd223
Show file tree
Hide file tree
Showing 5 changed files with 5 additions and 5 deletions.
2 changes: 1 addition & 1 deletion api/appsproxy/design.go
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ var _ = API("appsproxy", func() {
})
Server("appsproxy", func() {
Host("production", func() {
URI("https://appsproxy.{stack}")
URI("https://hub.{stack}")
Variable("stack", String, "Base URL of the stack", func() {
Default("keboola.com")
Enum("keboola.com", "eu-central-1.keboola.com", "north-europe.azure.keboola.com", "eu-west-1.aws.keboola.dev", "east-us-2.azure.keboola-testing.com")
Expand Down
2 changes: 1 addition & 1 deletion internal/pkg/service/appsproxy/api/openapi/openapi.json
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"swagger":"2.0","info":{"title":"Data application proxy","description":"A service for proxing requests/authorization to data applications using Keboola components.","version":"1.0"},"host":"appsproxy.keboola.com","consumes":["application/json"],"produces":["application/json"],"paths":{"/_proxy/api/":{"get":{"tags":["appsproxy"],"summary":"Redirect to /_proxy","description":"Redirect to /_proxy.","operationId":"ApiRootIndex","responses":{"301":{"description":"Moved Permanently response."}},"schemes":["https"]}},"/_proxy/api/v1":{"get":{"tags":["documentation"],"summary":"List API name and link to documentation.","description":"List API name and link to documentation.","operationId":"ApiVersionIndex","responses":{"200":{"description":"OK response.","schema":{"$ref":"#/definitions/ServiceDetail","required":["api","documentation"]}}},"schemes":["https"]}},"/_proxy/api/v1/documentation/openapi.json":{"get":{"tags":["documentation"],"summary":"Swagger 2.0 JSON Specification","operationId":"OpenapiJson","responses":{"200":{"description":"File downloaded","schema":{"type":"file"}}},"schemes":["http","https"]}},"/_proxy/api/v1/documentation/openapi.yaml":{"get":{"tags":["documentation"],"summary":"Swagger 2.0 YAML Specification","operationId":"OpenapiYaml","responses":{"200":{"description":"File downloaded","schema":{"type":"file"}}},"schemes":["http","https"]}},"/_proxy/api/v1/documentation/openapi3.json":{"get":{"tags":["documentation"],"summary":"OpenAPI 3.0 JSON Specification","operationId":"Openapi3Json","responses":{"200":{"description":"File downloaded","schema":{"type":"file"}}},"schemes":["http","https"]}},"/_proxy/api/v1/documentation/openapi3.yaml":{"get":{"tags":["documentation"],"summary":"OpenAPI 3.0 YAML Specification","operationId":"Openapi3Yaml","responses":{"200":{"description":"File downloaded","schema":{"type":"file"}}},"schemes":["http","https"]}},"/_proxy/api/v1/validate":{"get":{"tags":["appsproxy"],"summary":"Validation of OIDC authorization provider configuration","description":"Validation endpoint of OIDC authorization provider configuration.","operationId":"Validate","responses":{"200":{"description":"OK response.","schema":{"$ref":"#/definitions/Validations"}}},"schemes":["https"],"security":[{"storage-api-token":[]}]}}},"definitions":{"Configuration":{"title":"Configuration","type":"object","properties":{"clientID":{"type":"string","description":"Client ID of provider.","example":"github.oidc"},"clientSecret":{"type":"string","description":"Client secret provided by OIDC provider.","example":"thisissupersecret"},"id":{"type":"string","description":"Unique ID of provider.","example":"oidc#1"}},"description":"The configuration that is part of the auth providers section.","example":{"clientID":"github.oidc","clientSecret":"thisissupersecret","id":"oidc#1"},"required":["id","clientID","clientSecret"]},"ServiceDetail":{"title":"ServiceDetail","type":"object","properties":{"api":{"type":"string","description":"Name of the API","example":"appsproxy"},"documentation":{"type":"string","description":"URL of the API documentation.","example":"https://appsproxy.keboola.com/v1/documentation"}},"example":{"api":"appsproxy","documentation":"https://appsproxy.keboola.com/v1/documentation"},"required":["api","documentation"]},"Validations":{"title":"Validations","type":"object","properties":{"configuration":{"type":"array","items":{"$ref":"#/definitions/Configuration"},"description":"All authorization providers.","example":[{"statusCode":404,"error":"validations incorrect","message":"unable to validate due to missing entry","id":"test","name":"My Template"}]}},"example":{"configuration":[{"statusCode":404,"error":"validations incorrect","message":"unable to validate due to missing entry","id":"test","name":"My Template"}]}}},"securityDefinitions":{"storage-api-token":{"type":"apiKey","description":"Storage Api Token Authentication.","name":"X-StorageApi-Token","in":"header"}}}
{"swagger":"2.0","info":{"title":"Data application proxy","description":"A service for proxing requests/authorization to data applications using Keboola components.","version":"1.0"},"host":"hub.keboola.com","consumes":["application/json"],"produces":["application/json"],"paths":{"/_proxy/api/":{"get":{"tags":["appsproxy"],"summary":"Redirect to /_proxy","description":"Redirect to /_proxy.","operationId":"ApiRootIndex","responses":{"301":{"description":"Moved Permanently response."}},"schemes":["https"]}},"/_proxy/api/v1":{"get":{"tags":["documentation"],"summary":"List API name and link to documentation.","description":"List API name and link to documentation.","operationId":"ApiVersionIndex","responses":{"200":{"description":"OK response.","schema":{"$ref":"#/definitions/ServiceDetail","required":["api","documentation"]}}},"schemes":["https"]}},"/_proxy/api/v1/documentation/openapi.json":{"get":{"tags":["documentation"],"summary":"Swagger 2.0 JSON Specification","operationId":"OpenapiJson","responses":{"200":{"description":"File downloaded","schema":{"type":"file"}}},"schemes":["http","https"]}},"/_proxy/api/v1/documentation/openapi.yaml":{"get":{"tags":["documentation"],"summary":"Swagger 2.0 YAML Specification","operationId":"OpenapiYaml","responses":{"200":{"description":"File downloaded","schema":{"type":"file"}}},"schemes":["http","https"]}},"/_proxy/api/v1/documentation/openapi3.json":{"get":{"tags":["documentation"],"summary":"OpenAPI 3.0 JSON Specification","operationId":"Openapi3Json","responses":{"200":{"description":"File downloaded","schema":{"type":"file"}}},"schemes":["http","https"]}},"/_proxy/api/v1/documentation/openapi3.yaml":{"get":{"tags":["documentation"],"summary":"OpenAPI 3.0 YAML Specification","operationId":"Openapi3Yaml","responses":{"200":{"description":"File downloaded","schema":{"type":"file"}}},"schemes":["http","https"]}},"/_proxy/api/v1/validate":{"get":{"tags":["appsproxy"],"summary":"Validation of OIDC authorization provider configuration","description":"Validation endpoint of OIDC authorization provider configuration.","operationId":"Validate","responses":{"200":{"description":"OK response.","schema":{"$ref":"#/definitions/Validations"}}},"schemes":["https"],"security":[{"storage-api-token":[]}]}}},"definitions":{"Configuration":{"title":"Configuration","type":"object","properties":{"clientID":{"type":"string","description":"Client ID of provider.","example":"github.oidc"},"clientSecret":{"type":"string","description":"Client secret provided by OIDC provider.","example":"thisissupersecret"},"id":{"type":"string","description":"Unique ID of provider.","example":"oidc#1"}},"description":"The configuration that is part of the auth providers section.","example":{"clientID":"github.oidc","clientSecret":"thisissupersecret","id":"oidc#1"},"required":["id","clientID","clientSecret"]},"ServiceDetail":{"title":"ServiceDetail","type":"object","properties":{"api":{"type":"string","description":"Name of the API","example":"appsproxy"},"documentation":{"type":"string","description":"URL of the API documentation.","example":"https://appsproxy.keboola.com/v1/documentation"}},"example":{"api":"appsproxy","documentation":"https://appsproxy.keboola.com/v1/documentation"},"required":["api","documentation"]},"Validations":{"title":"Validations","type":"object","properties":{"configuration":{"type":"array","items":{"$ref":"#/definitions/Configuration"},"description":"All authorization providers.","example":[{"statusCode":404,"error":"validations incorrect","message":"unable to validate due to missing entry","id":"test","name":"My Template"}]}},"example":{"configuration":[{"statusCode":404,"error":"validations incorrect","message":"unable to validate due to missing entry","id":"test","name":"My Template"}]}}},"securityDefinitions":{"storage-api-token":{"type":"apiKey","description":"Storage Api Token Authentication.","name":"X-StorageApi-Token","in":"header"}}}
2 changes: 1 addition & 1 deletion internal/pkg/service/appsproxy/api/openapi/openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ info:
title: Data application proxy
description: A service for proxing requests/authorization to data applications using Keboola components.
version: "1.0"
host: appsproxy.keboola.com
host: hub.keboola.com
consumes:
- application/json
produces:
Expand Down
2 changes: 1 addition & 1 deletion internal/pkg/service/appsproxy/api/openapi/openapi3.json
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"openapi":"3.0.3","info":{"title":"Data application proxy","description":"A service for proxing requests/authorization to data applications using Keboola components.","version":"1.0"},"servers":[{"url":"https://appsproxy.{stack}","variables":{"stack":{"enum":["keboola.com","eu-central-1.keboola.com","north-europe.azure.keboola.com","eu-west-1.aws.keboola.dev","east-us-2.azure.keboola-testing.com"],"default":"keboola.com"}}},{"url":"http://localhost:8000"}],"paths":{"/_proxy/api/":{"get":{"tags":["appsproxy"],"summary":"Redirect to /_proxy","description":"Redirect to /_proxy.","operationId":"ApiRootIndex","responses":{"301":{"description":"Moved Permanently response."}}}},"/_proxy/api/v1":{"get":{"tags":["documentation"],"summary":"List API name and link to documentation.","description":"List API name and link to documentation.","operationId":"ApiVersionIndex","responses":{"200":{"description":"OK response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceDetail"},"example":{"api":"appsproxy","documentation":"https://appsproxy.keboola.com/v1/documentation"}}}}}}},"/_proxy/api/v1/documentation/openapi.json":{"get":{"tags":["documentation"],"summary":"Swagger 2.0 JSON Specification","operationId":"OpenapiJson","responses":{"200":{"description":"File downloaded"}}}},"/_proxy/api/v1/documentation/openapi.yaml":{"get":{"tags":["documentation"],"summary":"Swagger 2.0 YAML Specification","operationId":"OpenapiYaml","responses":{"200":{"description":"File downloaded"}}}},"/_proxy/api/v1/documentation/openapi3.json":{"get":{"tags":["documentation"],"summary":"OpenAPI 3.0 JSON Specification","operationId":"Openapi3Json","responses":{"200":{"description":"File downloaded"}}}},"/_proxy/api/v1/documentation/openapi3.yaml":{"get":{"tags":["documentation"],"summary":"OpenAPI 3.0 YAML Specification","operationId":"Openapi3Yaml","responses":{"200":{"description":"File downloaded"}}}},"/_proxy/api/v1/validate":{"get":{"tags":["appsproxy"],"summary":"Validation of OIDC authorization provider configuration","description":"Validation endpoint of OIDC authorization provider configuration.","operationId":"Validate","responses":{"200":{"description":"OK response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Validations"},"example":{"configuration":[{"statusCode":404,"error":"validations incorrect","message":"unable to validate due to missing entry","id":"test","name":"My Template"}]}}}}},"security":[{"storage-api-token":[]}]}}},"components":{"schemas":{"Configuration":{"type":"object","properties":{"clientID":{"type":"string","description":"Client ID of provider.","example":"github.oidc"},"clientSecret":{"type":"string","description":"Client secret provided by OIDC provider.","example":"thisissupersecret"},"id":{"type":"string","description":"Unique ID of provider.","example":"oidc#1"}},"description":"The configuration that is part of the auth providers section.","example":{"clientID":"github.oidc","clientSecret":"thisissupersecret","id":"oidc#1"},"required":["id","clientID","clientSecret"]},"GenericError":{"type":"object","properties":{"error":{"type":"string","description":"Name of error.","example":"templates.internalError"},"message":{"type":"string","description":"Error message.","example":"Internal Error"},"statusCode":{"type":"integer","description":"HTTP status code.","example":500,"format":"int64"}},"description":"Generic error","example":{"error":"templates.internalError","message":"Internal Error","statusCode":500},"required":["statusCode","error","message"]},"ProxyRequest":{"type":"object","properties":{"path":{"type":"string","description":"\"Path that proxies to data application\".","example":""}},"example":{"path":""}},"ServiceDetail":{"type":"object","properties":{"api":{"type":"string","description":"Name of the API","example":"appsproxy"},"documentation":{"type":"string","description":"URL of the API documentation.","example":"https://appsproxy.keboola.com/v1/documentation"}},"description":"Information about the service","example":{"api":"appsproxy","documentation":"https://appsproxy.keboola.com/v1/documentation"},"required":["api","documentation"]},"Validations":{"type":"object","properties":{"configuration":{"type":"array","items":{"$ref":"#/components/schemas/Configuration"},"description":"All authorization providers.","example":[{"statusCode":404,"error":"validations incorrect","message":"unable to validate due to missing entry","id":"test","name":"My Template"}]}},"description":"List of configurations of OIDC providers.","example":{"configuration":[{"statusCode":404,"error":"validations incorrect","message":"unable to validate due to missing entry","id":"test","name":"My Template"}]}}},"securitySchemes":{"storage-api-token":{"type":"apiKey","description":"Storage Api Token Authentication.","name":"X-StorageApi-Token","in":"header"}}},"tags":[{"name":"apps-proxy","description":"Service for proxing requests/authorization to data applications using Keboola data app component."}]}
{"openapi":"3.0.3","info":{"title":"Data application proxy","description":"A service for proxing requests/authorization to data applications using Keboola components.","version":"1.0"},"servers":[{"url":"https://hub.{stack}","variables":{"stack":{"enum":["keboola.com","eu-central-1.keboola.com","north-europe.azure.keboola.com","eu-west-1.aws.keboola.dev","east-us-2.azure.keboola-testing.com"],"default":"keboola.com"}}},{"url":"http://localhost:8000"}],"paths":{"/_proxy/api/":{"get":{"tags":["appsproxy"],"summary":"Redirect to /_proxy","description":"Redirect to /_proxy.","operationId":"ApiRootIndex","responses":{"301":{"description":"Moved Permanently response."}}}},"/_proxy/api/v1":{"get":{"tags":["documentation"],"summary":"List API name and link to documentation.","description":"List API name and link to documentation.","operationId":"ApiVersionIndex","responses":{"200":{"description":"OK response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceDetail"},"example":{"api":"appsproxy","documentation":"https://appsproxy.keboola.com/v1/documentation"}}}}}}},"/_proxy/api/v1/documentation/openapi.json":{"get":{"tags":["documentation"],"summary":"Swagger 2.0 JSON Specification","operationId":"OpenapiJson","responses":{"200":{"description":"File downloaded"}}}},"/_proxy/api/v1/documentation/openapi.yaml":{"get":{"tags":["documentation"],"summary":"Swagger 2.0 YAML Specification","operationId":"OpenapiYaml","responses":{"200":{"description":"File downloaded"}}}},"/_proxy/api/v1/documentation/openapi3.json":{"get":{"tags":["documentation"],"summary":"OpenAPI 3.0 JSON Specification","operationId":"Openapi3Json","responses":{"200":{"description":"File downloaded"}}}},"/_proxy/api/v1/documentation/openapi3.yaml":{"get":{"tags":["documentation"],"summary":"OpenAPI 3.0 YAML Specification","operationId":"Openapi3Yaml","responses":{"200":{"description":"File downloaded"}}}},"/_proxy/api/v1/validate":{"get":{"tags":["appsproxy"],"summary":"Validation of OIDC authorization provider configuration","description":"Validation endpoint of OIDC authorization provider configuration.","operationId":"Validate","responses":{"200":{"description":"OK response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Validations"},"example":{"configuration":[{"statusCode":404,"error":"validations incorrect","message":"unable to validate due to missing entry","id":"test","name":"My Template"}]}}}}},"security":[{"storage-api-token":[]}]}}},"components":{"schemas":{"Configuration":{"type":"object","properties":{"clientID":{"type":"string","description":"Client ID of provider.","example":"github.oidc"},"clientSecret":{"type":"string","description":"Client secret provided by OIDC provider.","example":"thisissupersecret"},"id":{"type":"string","description":"Unique ID of provider.","example":"oidc#1"}},"description":"The configuration that is part of the auth providers section.","example":{"clientID":"github.oidc","clientSecret":"thisissupersecret","id":"oidc#1"},"required":["id","clientID","clientSecret"]},"GenericError":{"type":"object","properties":{"error":{"type":"string","description":"Name of error.","example":"templates.internalError"},"message":{"type":"string","description":"Error message.","example":"Internal Error"},"statusCode":{"type":"integer","description":"HTTP status code.","example":500,"format":"int64"}},"description":"Generic error","example":{"error":"templates.internalError","message":"Internal Error","statusCode":500},"required":["statusCode","error","message"]},"ProxyRequest":{"type":"object","properties":{"path":{"type":"string","description":"\"Path that proxies to data application\".","example":""}},"example":{"path":""}},"ServiceDetail":{"type":"object","properties":{"api":{"type":"string","description":"Name of the API","example":"appsproxy"},"documentation":{"type":"string","description":"URL of the API documentation.","example":"https://appsproxy.keboola.com/v1/documentation"}},"description":"Information about the service","example":{"api":"appsproxy","documentation":"https://appsproxy.keboola.com/v1/documentation"},"required":["api","documentation"]},"Validations":{"type":"object","properties":{"configuration":{"type":"array","items":{"$ref":"#/components/schemas/Configuration"},"description":"All authorization providers.","example":[{"statusCode":404,"error":"validations incorrect","message":"unable to validate due to missing entry","id":"test","name":"My Template"}]}},"description":"List of configurations of OIDC providers.","example":{"configuration":[{"statusCode":404,"error":"validations incorrect","message":"unable to validate due to missing entry","id":"test","name":"My Template"}]}}},"securitySchemes":{"storage-api-token":{"type":"apiKey","description":"Storage Api Token Authentication.","name":"X-StorageApi-Token","in":"header"}}},"tags":[{"name":"apps-proxy","description":"Service for proxing requests/authorization to data applications using Keboola data app component."}]}
2 changes: 1 addition & 1 deletion internal/pkg/service/appsproxy/api/openapi/openapi3.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ info:
description: A service for proxing requests/authorization to data applications using Keboola components.
version: "1.0"
servers:
- url: https://appsproxy.{stack}
- url: https://hub.{stack}
variables:
stack:
enum:
Expand Down

0 comments on commit d8dd223

Please sign in to comment.