openapi: 3.0.3 info: title: 'Platform API Docs - Autum' description: 'API documentation of Autum Platform.' version: 1.0.0 servers: - url: 'https://autum.com.br/api' paths: /api/account/email: post: summary: 'Get User profile' operationId: getUserProfile description: 'Show user public profile by email address.' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_API_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - Account requestBody: required: true content: application/json: schema: type: object properties: email: type: string description: 'O campo value deve ser um endereço de e-mail válido.' example: william.kohler@example.org required: - email /api/account: post: summary: 'Create new User' operationId: createNewUser description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_API_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - Account requestBody: required: true content: application/json: schema: type: object properties: email: type: string description: 'O campo value deve ser um endereço de e-mail válido. O campo value não pode ser superior a 255 caracteres.' example: fatima.zemlak@example.com name: type: string description: 'O campo value não pode ser superior a 255 caracteres.' example: jmz lastname: type: string description: 'O campo value não pode ser superior a 255 caracteres.' example: cbamvjrvmutoeskdrsvwmv required: - email - name get: summary: 'Get authenticated User' operationId: getAuthenticatedUser description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_API_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - Account put: summary: 'Update User' operationId: updateUser description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_API_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - Account /api/account/check-pin: post: summary: 'Check PIN code' operationId: checkPINCode description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_API_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - Account parameters: - in: path name: pin description: 'Check six-digits pin code.' example: vero required: true schema: type: string /api/account/check-password: post: summary: 'Check Password' operationId: checkPassword description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_API_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - Account requestBody: required: true content: application/json: schema: type: object properties: password: type: string description: '' example: possimus required: - password parameters: - in: path name: password description: 'Check user password.' example: "yrg?`V/8eLned0S'!1]" required: true schema: type: string /api/products: get: summary: 'List Apps' operationId: listApps description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_API_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - Apps /api/blog: get: summary: 'Search posts' operationId: searchPosts description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_API_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 200: description: '' content: application/json: schema: type: object example: data: [] links: first: 'https://autum.com.br/api/blog?page=1' last: 'https://autum.com.br/api/blog?page=1' prev: null next: null meta: current_page: 1 from: null last_page: 1 links: - url: null label: '« Anterior' active: false - url: 'https://autum.com.br/api/blog?page=1' label: '1' active: true - url: null label: 'Próximo »' active: false path: 'https://autum.com.br/api/blog' per_page: 16 to: null total: 0 properties: data: type: array example: [] links: type: object properties: first: type: string example: 'https://autum.com.br/api/blog?page=1' last: type: string example: 'https://autum.com.br/api/blog?page=1' prev: type: string example: null next: type: string example: null meta: type: object properties: current_page: type: integer example: 1 from: type: string example: null last_page: type: integer example: 1 links: type: array example: - url: null label: '« Anterior' active: false - url: 'https://autum.com.br/api/blog?page=1' label: '1' active: true - url: null label: 'Próximo »' active: false items: type: object properties: url: type: string example: null label: type: string example: '« Anterior' active: type: boolean example: false path: type: string example: 'https://autum.com.br/api/blog' per_page: type: integer example: 16 to: type: string example: null total: type: integer example: 0 tags: - Blog requestBody: required: false content: application/json: schema: type: object properties: q: type: string description: '' example: quod perPage: type: integer description: '' example: 16 limit: type: integer description: '' example: 12 '/api/blog/{slug}': get: summary: 'Show blog post' operationId: showBlogPost description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_API_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 404: description: '' content: application/json: schema: type: object example: status: not_found message: 'Contact not found' properties: status: type: string example: not_found message: type: string example: 'Contact not found' tags: - Blog parameters: - in: path name: slug description: 'The slug of the blog.' example: voluptatem required: true schema: type: string /api/invitations: get: summary: 'List invitations' operationId: listInvitations description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_API_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - Invitations post: summary: 'Send invitation' operationId: sendInvitation description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_API_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - Invitations requestBody: required: true content: application/json: schema: type: object properties: name: type: string description: '' example: id phone: type: string description: '' example: tenetur email: type: string description: 'O campo value deve ser um endereço de e-mail válido.' example: davis.kallie@example.com required: - email /api/notifications: get: summary: 'List notifications' operationId: listNotifications description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_API_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - Notifications delete: summary: 'Clear notifications' operationId: clearNotifications description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_API_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - Notifications /api/notifications/mark-as-read: put: summary: 'Read all notifications' operationId: readAllNotifications description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_API_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - Notifications '/api/notifications/{id}': get: summary: 'Read notification' operationId: readNotification description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_API_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - Notifications parameters: - in: path name: id description: 'The ID of the notification.' example: repellat required: true schema: type: string tags: - name: Account description: "\nEndpoints for account management." - name: Apps description: "\nEndpoints for platform apps." - name: Blog description: "\nEndpoints for blog posts." - name: Invitations description: "\nEndpoints for friend invitations request." - name: Notifications description: "\nEndpoints for account notifications." components: securitySchemes: default: type: http scheme: bearer description: '' security: - default: []