get: operationId: GetNotes summary: List Notes x-authenticated: true description: Retrieves a list of notes parameters: - in: query name: limit description: The number of notes to get schema: type: number default: '50' - in: query name: offset description: The offset at which to get notes schema: type: number default: '0' - in: query name: resource_id description: The ID which the notes belongs to schema: type: string x-codegen: method: list queryParams: AdminGetNotesParams x-codeSamples: - lang: JavaScript label: JS Client source: $ref: ../code_samples/JavaScript/admin_notes/get.js - lang: Shell label: cURL source: $ref: ../code_samples/Shell/admin_notes/get.sh security: - api_token: [] - cookie_auth: [] tags: - Notes responses: '200': description: OK content: application/json: schema: $ref: ../components/schemas/AdminNotesListRes.yaml '400': $ref: ../components/responses/400_error.yaml '401': $ref: ../components/responses/unauthorized.yaml '404': $ref: ../components/responses/not_found_error.yaml '409': $ref: ../components/responses/invalid_state_error.yaml '422': $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml post: operationId: PostNotes summary: Creates a Note description: Creates a Note which can be associated with any resource as required. x-authenticated: true requestBody: content: application/json: schema: $ref: ../components/schemas/AdminPostNotesReq.yaml x-codegen: method: create x-codeSamples: - lang: JavaScript label: JS Client source: $ref: ../code_samples/JavaScript/admin_notes/post.js - lang: Shell label: cURL source: $ref: ../code_samples/Shell/admin_notes/post.sh security: - api_token: [] - cookie_auth: [] tags: - Notes responses: '200': description: OK content: application/json: schema: $ref: ../components/schemas/AdminNotesRes.yaml '400': $ref: ../components/responses/400_error.yaml '401': $ref: ../components/responses/unauthorized.yaml '404': $ref: ../components/responses/not_found_error.yaml '409': $ref: ../components/responses/invalid_state_error.yaml '422': $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml