openapi: 3.1.0 info: title: Fast ACCOUNT_COSTS NOTEBOOK API version: 0.1.0 tags: - name: NOTEBOOK paths: /notebook/list: get: tags: - NOTEBOOK summary: Get Notebook List operationId: get_notebook_list_notebook_list_get security: - HTTPBearer: [] - HTTPBearer: [] parameters: - name: tags_ids in: query required: false schema: anyOf: - type: array items: type: integer - type: 'null' title: Tags Ids - name: tags_list in: query required: false schema: anyOf: - type: array items: type: string - type: 'null' title: Tags List - name: privacy in: query required: false schema: anyOf: - $ref: '#/components/schemas/PrivacySetting' - type: 'null' default: private title: Privacy - name: name in: query required: false schema: anyOf: - type: string - type: 'null' title: Name - name: altimate_notebook_id in: query required: false schema: anyOf: - type: integer - type: 'null' title: Altimate Notebook Id - name: x-tenant in: header required: true schema: type: string title: X-Tenant responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/AllNotebookResponse' title: Response Get Notebook List Notebook List Get '400': description: Not supported for public user content: application/json: schema: type: object additionalProperties: true title: Response 400 Get Notebook List Notebook List Get '403': description: Not supported for public user content: application/json: schema: type: object additionalProperties: true title: Response 403 Get Notebook List Notebook List Get '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /notebook/: get: tags: - NOTEBOOK summary: Get Notebook Pages operationId: get_notebook_pages_notebook__get security: - HTTPBearer: [] - HTTPBearer: [] parameters: - name: tags_ids in: query required: false schema: anyOf: - type: array items: type: integer - type: 'null' title: Tags Ids - name: tags_list in: query required: false schema: anyOf: - type: array items: type: string - type: 'null' title: Tags List - name: privacy in: query required: false schema: anyOf: - $ref: '#/components/schemas/PrivacySetting' - type: 'null' default: private title: Privacy - name: search_query in: query required: false schema: anyOf: - type: string - type: 'null' title: Search Query - name: altimate_notebook_id in: query required: false schema: anyOf: - type: integer - type: 'null' title: Altimate Notebook Id - name: page in: query required: false schema: type: integer minimum: 1 description: Page number default: 1 title: Page description: Page number - name: size in: query required: false schema: type: integer maximum: 100 minimum: 1 description: Page size default: 50 title: Size description: Page size - name: x-tenant in: header required: true schema: type: string title: X-Tenant responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/Page_AllNotebookResponse_' '400': description: Not supported for public user content: application/json: schema: type: object additionalProperties: true title: Response 400 Get Notebook Pages Notebook Get '403': description: Not supported for public user content: application/json: schema: type: object additionalProperties: true title: Response 403 Get Notebook Pages Notebook Get '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' post: tags: - NOTEBOOK summary: Add Notebook operationId: add_notebook_notebook__post security: - HTTPBearer: [] - HTTPBearer: [] parameters: - name: x-tenant in: header required: true schema: type: string title: X-Tenant requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AddUpdateNotebookRequest' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/StandardResponse' '400': description: Not supported for public user content: application/json: schema: type: object additionalProperties: true title: Response 400 Add Notebook Notebook Post '403': description: Not supported for public user content: application/json: schema: type: object additionalProperties: true title: Response 403 Add Notebook Notebook Post '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /notebook/{notebook_id}: put: tags: - NOTEBOOK summary: Update Notebook operationId: update_notebook_notebook__notebook_id__put security: - HTTPBearer: [] - HTTPBearer: [] parameters: - name: notebook_id in: path required: true schema: type: integer title: Notebook Id - name: x-tenant in: header required: true schema: type: string title: X-Tenant requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AddUpdateNotebookRequest' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/StandardResponse' '400': description: Not supported for public user content: application/json: schema: type: object additionalProperties: true title: Response 400 Update Notebook Notebook Notebook Id Put '403': description: Not supported for public user content: application/json: schema: type: object additionalProperties: true title: Response 403 Update Notebook Notebook Notebook Id Put '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' delete: tags: - NOTEBOOK summary: Remove Notebook operationId: remove_notebook_notebook__notebook_id__delete security: - HTTPBearer: [] - HTTPBearer: [] parameters: - name: notebook_id in: path required: true schema: type: integer title: Notebook Id - name: x-tenant in: header required: true schema: type: string title: X-Tenant responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/StandardResponse' '400': description: Not supported for public user content: application/json: schema: type: object additionalProperties: true title: Response 400 Remove Notebook Notebook Notebook Id Delete '403': description: Not supported for public user content: application/json: schema: type: object additionalProperties: true title: Response 403 Remove Notebook Notebook Notebook Id Delete '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /notebook/privacy/{altimate_notebook_id}: put: tags: - NOTEBOOK summary: Update Privacy Notebook operationId: update_privacy_notebook_notebook_privacy__altimate_notebook_id__put security: - HTTPBearer: [] - HTTPBearer: [] parameters: - name: altimate_notebook_id in: path required: true schema: type: integer title: Altimate Notebook Id - name: privacy in: query required: true schema: $ref: '#/components/schemas/PrivacySetting' - name: x-tenant in: header required: true schema: type: string title: X-Tenant responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/StandardResponse' '400': description: Not supported for public user content: application/json: schema: type: object additionalProperties: true title: Response 400 Update Privacy Notebook Notebook Privacy Altimate Notebook Id Put '403': description: Not supported for public user content: application/json: schema: type: object additionalProperties: true title: Response 403 Update Privacy Notebook Notebook Privacy Altimate Notebook Id Put '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /notebook/tags: get: tags: - NOTEBOOK summary: Get Notebook Tags operationId: get_notebook_tags_notebook_tags_get deprecated: true security: - HTTPBearer: [] - HTTPBearer: [] parameters: - name: x-tenant in: header required: true schema: type: string title: X-Tenant responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/NotebookTagResponse' title: Response Get Notebook Tags Notebook Tags Get '400': description: Not supported for public user content: application/json: schema: type: object additionalProperties: true title: Response 400 Get Notebook Tags Notebook Tags Get '403': description: Not supported for public user content: application/json: schema: type: object additionalProperties: true title: Response 403 Get Notebook Tags Notebook Tags Get '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /notebook/preconfigured/list: get: tags: - NOTEBOOK summary: Get Pre Configured Notebook List operationId: get_pre_configured_notebook_list_notebook_preconfigured_list_get security: - HTTPBearer: [] - HTTPBearer: [] parameters: - name: tags_list in: query required: false schema: anyOf: - type: array items: type: string - type: 'null' title: Tags List - name: x-tenant in: header required: true schema: type: string title: X-Tenant responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/AllPreconfiguredNotebookResponse' title: Response Get Pre Configured Notebook List Notebook Preconfigured List Get '400': description: Not supported for public user content: application/json: schema: type: object additionalProperties: true title: Response 400 Get Pre Configured Notebook List Notebook Preconfigured List Get '403': description: Not supported for public user content: application/json: schema: type: object additionalProperties: true title: Response 403 Get Pre Configured Notebook List Notebook Preconfigured List Get '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /notebook/preconfigured/add: post: tags: - NOTEBOOK summary: Add Pre Configured Notebook operationId: add_pre_configured_notebook_notebook_preconfigured_add_post deprecated: true security: - HTTPBearer: [] - HTTPBearer: [] parameters: - name: x-tenant in: header required: true schema: type: string title: X-Tenant requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AddPreconfiguredNotebookRequest' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/StandardResponse' '400': description: Not supported for public user content: application/json: schema: type: object additionalProperties: true title: Response 400 Add Pre Configured Notebook Notebook Preconfigured Add Post '403': description: Not supported for public user content: application/json: schema: type: object additionalProperties: true title: Response 403 Add Pre Configured Notebook Notebook Preconfigured Add Post '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' components: schemas: AllNotebookResponse: properties: id: type: integer title: Id name: type: string title: Name data: additionalProperties: true type: object title: Data description: type: string title: Description created_on: type: string format: date-time title: Created On updated_on: type: string format: date-time title: Updated On tags: items: $ref: '#/components/schemas/NotebookTagResponse' type: array title: Tags privacy: $ref: '#/components/schemas/PrivacySetting' created_by_user: $ref: '#/components/schemas/UserIndexResponse' type: object required: - id - name - data - description - created_on - updated_on - tags - privacy - created_by_user title: AllNotebookResponse PrivacySetting: type: string enum: - public - private title: PrivacySetting AddPreconfiguredNotebookRequest: properties: name: type: string title: Name data: additionalProperties: true type: object title: Data description: anyOf: - type: string - type: 'null' title: Description default: '' tags_list: items: type: string type: array title: Tags List default: [] type: object required: - name - data title: AddPreconfiguredNotebookRequest NotebookTagResponse: properties: id: type: integer title: Id tag: type: string title: Tag type: object required: - id - tag title: NotebookTagResponse ValidationError: properties: loc: items: anyOf: - type: string - type: integer type: array title: Location msg: type: string title: Message type: type: string title: Error Type type: object required: - loc - msg - type title: ValidationError HTTPValidationError: properties: detail: items: $ref: '#/components/schemas/ValidationError' type: array title: Detail type: object title: HTTPValidationError AddUpdateNotebookRequest: properties: name: anyOf: - type: string - type: 'null' title: Name data: anyOf: - additionalProperties: true type: object - type: 'null' title: Data description: anyOf: - type: string - type: 'null' title: Description default: '' tags_list: anyOf: - items: type: string type: array - type: 'null' title: Tags List default: [] privacy: anyOf: - $ref: '#/components/schemas/PrivacySetting' - type: 'null' type: object title: AddUpdateNotebookRequest StandardResponse: properties: ok: type: boolean title: Ok type: object required: - ok title: StandardResponse Page_AllNotebookResponse_: properties: items: items: $ref: '#/components/schemas/AllNotebookResponse' type: array title: Items total: anyOf: - type: integer minimum: 0.0 - type: 'null' title: Total page: anyOf: - type: integer minimum: 1.0 - type: 'null' title: Page size: anyOf: - type: integer minimum: 1.0 - type: 'null' title: Size pages: anyOf: - type: integer minimum: 0.0 - type: 'null' title: Pages type: object required: - items - total - page - size title: Page[AllNotebookResponse] AllPreconfiguredNotebookResponse: properties: id: type: integer title: Id name: type: string title: Name data: additionalProperties: true type: object title: Data description: type: string title: Description created_on: type: string format: date-time title: Created On updated_on: type: string format: date-time title: Updated On tags: items: type: string type: array title: Tags type: object required: - id - name - data - description - created_on - updated_on - tags title: AllPreconfiguredNotebookResponse UserIndexResponse: properties: id: type: integer title: Id uuid: type: string format: uuid title: Uuid first_name: anyOf: - type: string - type: 'null' title: First Name last_name: anyOf: - type: string - type: 'null' title: Last Name email: type: string title: Email phone: anyOf: - type: string - type: 'null' title: Phone is_active: type: boolean title: Is Active is_verified: type: boolean title: Is Verified is_invited: type: boolean title: Is Invited is_onboarded: type: boolean title: Is Onboarded created_at: anyOf: - type: string - type: 'null' title: Created At role_title: anyOf: - type: string - type: 'null' title: Role Title display_name: anyOf: - type: string - type: 'null' title: Display Name attributes: anyOf: - additionalProperties: true type: object - type: 'null' title: Attributes deleted_at: anyOf: - type: string format: date-time - type: 'null' title: Deleted At last_login_at: anyOf: - type: string - type: 'null' title: Last Login At role_source: anyOf: - type: string - type: 'null' title: Role Source has_role_conflict: type: boolean title: Has Role Conflict default: false sso_resolved_role_id: anyOf: - type: integer - type: 'null' title: Sso Resolved Role Id sso_resolved_role_title: anyOf: - type: string - type: 'null' title: Sso Resolved Role Title type: object required: - id - uuid - email - is_active - is_verified - is_invited - is_onboarded - created_at title: UserIndexResponse securitySchemes: HTTPBearer: type: http scheme: bearer