get: operationId: GetNotesNote summary: Get a Note description: Retrieve a note's details. x-authenticated: true parameters: - in: path name: id required: true description: The ID of the note. schema: type: string x-codegen: method: retrieve x-codeSamples: - lang: JavaScript label: JS Client source: $ref: ../code_samples/JavaScript/admin_notes_{id}/get.js - lang: Shell label: cURL source: $ref: ../code_samples/Shell/admin_notes_{id}/get.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 post: operationId: PostNotesNote summary: Update a Note x-authenticated: true description: Update a Note's details.' parameters: - in: path name: id required: true description: The ID of the Note schema: type: string requestBody: content: application/json: schema: $ref: ../components/schemas/AdminPostNotesNoteReq.yaml x-codegen: method: update x-codeSamples: - lang: JavaScript label: JS Client source: $ref: ../code_samples/JavaScript/admin_notes_{id}/post.js - lang: Shell label: cURL source: $ref: ../code_samples/Shell/admin_notes_{id}/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 delete: operationId: DeleteNotesNote summary: Delete a Note description: Delete a Note. x-authenticated: true parameters: - in: path name: id required: true description: The ID of the Note to delete. schema: type: string x-codegen: method: delete x-codeSamples: - lang: JavaScript label: JS Client source: $ref: ../code_samples/JavaScript/admin_notes_{id}/delete.js - lang: Shell label: cURL source: $ref: ../code_samples/Shell/admin_notes_{id}/delete.sh security: - api_token: [] - cookie_auth: [] tags: - Notes responses: '200': description: OK content: application/json: schema: $ref: ../components/schemas/AdminNotesDeleteRes.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