openapi: 3.1.1 info: title: Intershop Sparque Center - Redirect Aggregates REST API description: | The _Intershop Sparque Center - Redirect Aggregates REST API_ contains resources for retrieving all redirects within a specified workspace. **Note**: These resources support only UTF-8/16/32-encoded requests as specified in [RFC 4627](https://www.ietf.org/rfc/rfc4627.txt). ## Changelog ### Version 1.1.0 * Added authentication via HTTP header `x-api-key` * Added new property `channelId` * Property `channel` has been deprecated: Use `channelId` instead * Updated title, descriptions and tags ### Version 1.0.1 * Updated OpenAPI specification version to 3.1.1 * `operationId` got renamed to `getWorkspaceRedirectsV1` version: "1.1.0" servers: - url: "{protocol}://{domain}:{port}/isc/rest" variables: protocol: default: http enum: - http - https domain: default: localhost port: default: "8080" security: - ApiKeyAuthQuery: [] - ApiKeyAuthHeader: [] tags: - name: Redirect Aggregates description: This section covers operations for retrieving redirect aggregates for SPARQUE. paths: /workspaces/{workspaceName}/redirects: get: tags: - Redirect Aggregates operationId: getWorkspaceRedirectsV1 summary: Returns redirect aggregates for a workspace description: This operation returns a list of redirects for a specific workspace. parameters: - name: workspaceName description: The name of the workspace for which redirects should be retrieved in: path required: true schema: type: string - name: key description: | The API key provided as query parameter. Not recommended, as the secret could be stored in web server, proxy or load balancer logs. Either this parameter or the preferred alternative HTTP header parameter `x-api-key` is required. in: query required: false schema: type: string - name: x-api-key in: header required: false description: | The API key provided as header (has higher precedence than the query parameter). Either this parameter or its alternative query parameter `key` is required. schema: type: string responses: "200": description: Ok - Redirect aggregates for the given workspace were successfully retrieved. content: application/json: schema: type: array items: $ref: "#/components/schemas/redirect" "401": description: Unauthorized - Authentication information is missing or invalid. "404": description: Not found - The requested workspace was not found. "500": description: Server Error - An unexpected error occurred. components: schemas: redirect: type: object properties: word: type: string description: A search word that should trigger a redirect url: type: string description: The URL to which the redirect points channel: type: string deprecated: true description: Deprecated. Use `channelId` instead. channelId: type: string description: The ID of the channel associated with the redirect securitySchemes: ApiKeyAuthQuery: type: apiKey in: query name: key description: | The API key provided as query parameter (unsecure, not recommended). Either this parameter or its alternative header parameter `x-api-key` is required. ApiKeyAuthHeader: type: apiKey in: header name: x-api-key description: | The API key provided as header (has higher precedence than the query parameter). Either this parameter or its alternative query parameter `key` is required.