Images

openapi: 3.0.0 info: version: "0.0" title: Institution Images servers: - url: 'https://{API_ENVIRONMENT}/a/consumer/api/v0' variables: API_ENVIRONMENT: default: digital.garden-fi.com description: FI specific hostname tags: - name: Retrieve institution image - name: Retrieve portrait background - name: Retrieve landscape background paths: "/institutions/{institutionId}/themes/{themeName}/{mode}/{type}": get: tags: - Retrieve institution image description: Provides institution image by type for given theme and mode parameters: - in: path name: institutionId description: ID of the desired institution required: true schema: type: string - in: path name: themeName description: The theme name for the background that is desired required: true schema: type: string - in: path name: mode description: The mode (light or dark) for the background that is desired required: true schema: type: string enum: - light - dark - in: path name: type description: Type of the desired image. If background is requested, it will default to portrait required: true schema: type: string enum: - icon - logo - menu - nav - background responses: "200": description: Institution image "404": description: Image not found on path "/institutions/{institutionId}/themes/{themeName}/{mode}/background/portrait": get: tags: - Retrieve portrait background description: Provides landscape background for given theme and mode parameters: - in: path name: institutionId description: ID of the desired institution required: true schema: type: string - in: path name: themeName description: The theme name for the background that is desired required: true schema: type: string - in: path name: mode description: The mode (light or dark) for the background that is desired required: true schema: type: string enum: - light - dark responses: "200": description: Institution background image in portrait "404": description: Image not found on path "/institutions/{institutionId}/themes/{themeName}/{mode}/background/landscape": get: tags: - Retrieve landscape background description: Provides landscape background for given theme and mode parameters: - in: path name: institutionId description: ID of the desired institution required: true schema: type: string - in: path name: themeName description: The theme name for the background that is desired required: true schema: type: string - in: path name: mode description: The mode (light or dark) for the background that is desired required: true schema: type: string responses: "200": description: Institution background image in landscape "404": description: Image not found on path components: securitySchemes: OpenID_Connect: type: openIdConnect description: OpenID Connect - Discovery endpoint will be institution specific openIdConnectUrl: >- https://digital.garden-fi.com/a/consumer/api/v0/oidc/.well-known/openid-configuration