openapi: 3.1.0 info: title: DTZ RSS2Email Api version: 2.0.2 description: a generated client for the DTZ RSS2Email API license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html contact: name: Jens Walter email: jens@apimeister.com servers: - url: https://rss2email.dtz.rocks/api/2021-02-01 paths: /enable: post: summary: enable the service operationId: enableService responses: "200": description: success "401": description: unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorMessage' "500": description: internal error content: application/json: schema: $ref: '#/components/schemas/ErrorMessage' /disable: post: summary: disable the service operationId: disableService responses: "200": description: success "401": description: unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorMessage' /rss2email/discover: post: summary: discover feed on homepage operationId: discoverFeed requestBody: description: discover request content: application/json: schema: type: object properties: url: type: string required: - url responses: "200": description: discover response content: application/json: schema: type: object properties: feedUrl: type: string feedType: type: string /rss2email/feed: get: summary: list all feeds operationId: listFeed responses: "200": description: feed data content: application/json: schema: $ref: '#/components/schemas/FeedList' "401": description: unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorMessage' "500": description: database error content: application/json: schema: $ref: '#/components/schemas/ErrorMessage' post: summary: create feed subscription operationId: createFeed requestBody: description: create feed request content: application/json: schema: $ref: '#/components/schemas/FeedRequest' responses: "200": description: success content: application/json: schema: $ref: '#/components/schemas/Feed' "401": description: unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorMessage' "500": description: database error content: application/json: schema: $ref: '#/components/schemas/ErrorMessage' /rss2email/feed/{feed_id}: get: summary: get feed operationId: getFeed parameters: - in: path name: feed_id schema: type: string format: FeedId required: true description: feed id responses: "200": description: success content: application/json: schema: $ref: '#/components/schemas/Feed' application/hcl: schema: type: string "401": description: unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorMessage' "404": description: feed not found content: application/json: schema: $ref: '#/components/schemas/ErrorMessage' "500": description: database error content: application/json: schema: $ref: '#/components/schemas/ErrorMessage' post: summary: update feed operationId: updateFeed parameters: - in: path name: feed_id schema: type: string format: FeedId required: true description: feed id requestBody: description: update feed request content: application/json: schema: $ref: '#/components/schemas/FeedRequest' responses: "200": description: feed update successful content: application/json: schema: $ref: '#/components/schemas/FeedResponse' "401": description: unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorMessage' "500": description: database error content: application/json: schema: $ref: '#/components/schemas/ErrorMessage' delete: summary: delete feed operationId: deleteFeed x-openai-isConsequential: true parameters: - in: path name: feed_id schema: type: string format: FeedId required: true description: feed id responses: "200": description: feed deletion successful content: application/json: schema: $ref: '#/components/schemas/FeedResponse' "401": description: unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorMessage' "500": description: database error content: application/json: schema: $ref: '#/components/schemas/ErrorMessage' /rss2email/feed/{feed_id}/disable: post: summary: disable feed operationId: disableFeed parameters: - in: path name: feed_id schema: type: string format: FeedId required: true description: feed id responses: "200": description: feed update successful "401": description: unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorMessage' "500": description: database error content: application/json: schema: $ref: '#/components/schemas/ErrorMessage' /rss2email/feed/{feed_id}/enable: post: summary: enable feed operationId: enableFeed parameters: - in: path name: feed_id schema: type: string format: FeedId required: true description: feed id responses: "200": description: feed update successful "401": description: unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorMessage' "500": description: database error content: application/json: schema: $ref: '#/components/schemas/ErrorMessage' /rss2email/profile: get: summary: get profile operationId: getProfile responses: "200": description: profile response content: application/json: schema: $ref: '#/components/schemas/ProfileResponse' application/hcl: schema: type: string "401": description: unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorMessage' "404": description: profile not found content: application/json: schema: $ref: '#/components/schemas/ErrorMessage' "500": description: database error content: application/json: schema: $ref: '#/components/schemas/ErrorMessage' post: summary: post a profile operationId: postProfile requestBody: description: update profile request content: application/json: schema: $ref: '#/components/schemas/Profile' responses: "200": description: success "401": description: unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorMessage' "500": description: database error content: application/json: schema: $ref: '#/components/schemas/ErrorMessage' /stats: get: summary: get service statistics operationId: getStats responses: "200": description: service statistics content: application/json: schema: $ref: '#/components/schemas/FeedStatistics' "401": description: unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorMessage' "500": description: database error content: application/json: schema: $ref: '#/components/schemas/ErrorMessage' components: schemas: Profile: type: object properties: email: type: string subject: type: string body: type: string required: - email FeedList: type: array items: $ref: '#/components/schemas/Feed' Feed: type: object properties: id: type: string format: FeedId url: type: string lastCheck: type: string format: date-time lastDataFound: type: string format: date-time enabled: type: boolean name: type: string required: - id - url - lastCheck - lastDataFound - enabled - name FeedRequest: type: object properties: url: type: string enabled: type: boolean required: - url FeedStatistics: type: object properties: amountOfFeeds: type: integer format: int64 amountOfNotificationDay: type: integer format: int64 amountOfNotificationWeek: type: integer format: int64 amountOfNotificationMonth: type: integer format: int64 required: - amountOfFeeds - amountOfNotificationDay - amountOfNotificationWeek - amountOfNotificationMonth FeedResponse: type: object properties: email: type: string feeds: $ref: '#/components/schemas/FeedList' required: - email - feeds ProfileResponse: type: object properties: email: type: string subject: type: string body: type: string contextId: type: string identityId: type: string required: - email - subject - body - contextId - identityId ErrorMessage: type: object properties: msg: type: string required: - msg securitySchemes: dtz_oauth: type: oauth2 flows: authorizationCode: authorizationUrl: https://identity.dtz.rocks/api/2021-02-21/oauth/authorize tokenUrl: https://identity.dtz.rocks/api/2021-02-21/oauth/token scopes: openid: general scope dtz_apikey: type: apiKey in: header name: X-API-KEY dtz-cookie: type: apiKey in: cookie name: dtz_auth security: - dtz_oauth: [] - dtz_apikey: [] - dtz-cookie: []
Core Services
Container Registry
Containers
Identity
Objectstore
Observability
Logs
Sources
RSS to Email
Terraform
Data Sources
Resources