Guideline Notes Endpoints¶

Guideline Notes API endpoints.

Overview¶

Method	Endpoint	Description
GET	`/api/v1/shootings/{shooting_id}/guideline-notes`	List Guideline Notes
POST	`/api/v1/shootings/{shooting_id}/guideline-notes`	Create Guideline Note
GET	`/api/v1/shootings/{shooting_id}/guideline-notes/shot-types`	List Guideline Note Shot Types
PATCH	`/api/v1/shootings/{shooting_id}/guideline-notes/{note_id}`	Update Guideline Note
DELETE	`/api/v1/shootings/{shooting_id}/guideline-notes/{note_id}`	Delete Guideline Note

API Reference¶

Sartiq Backend Server - Guideline Notes 0.1.0¶

guideline-notes¶

GET /api/v1/shootings/{shooting_id}/guideline-notes¶

List Guideline Notes

Description

List this shooting's notes (flat; the frontend groups by scope/category).

Input parameters

Parameter	In	Type	Default	Nullable	Description
`OAuth2PasswordBearer`	header	string	N/A	No
`shooting_id`	path	string		No

Responses

200 OK422 Unprocessable Entity

application/json

⚠️ This example has been generated automatically href="#__codelineno-0-1">[ { "id": "4e7fae3a-e4e6-48a9-abd4-6d26cd0d4928", "shooting_id": "05ef6b7f-83a3-491e-9df6-561873622741", "scope_type": "shooting", "category": null, "shot_type_id": null, "polarity": "do", "direction": null, "text": "string", "author_id": "54b16516-90f6-44dc-872b-bbe36dce90c2", "last_editor_id": "ddbce99a-7a2c-4624-b4da-609ee2231ef2", "author_name": null, "last_editor_name": null, "shot_type_name": null, "images": null, "created_at": "2022-04-13T15:42:05.901Z", "updated_at": "2022-04-13T15:42:05.901Z" } ] from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "type": "array",
    "items": {
        "$ref": "#/components/schemas/GuidelineNotePublic"
    },
    "title": "Response List Guideline Notes"
}

application/json

{
    "detail": [
        {
            "loc": [
                null
            ],
            "msg": "string",
            "type": "string",
            "input": null,
            "ctx": {}
        }
    ]
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "properties": {
        "detail": {
            "items": {
                "$ref": "#/components/schemas/ValidationError"
            },
            "type": "array",
            "title": "Detail"
        }
    },
    "type": "object",
    "title": "HTTPValidationError"
}

POST /api/v1/shootings/{shooting_id}/guideline-notes¶

Create Guideline Note

Description

Author a note at the given scope (201).

Input parameters

Parameter	In	Type	Default	Nullable	Description
`OAuth2PasswordBearer`	header	string	N/A	No
`shooting_id`	path	string		No

Request body

application/json

{
    "scope_type": "shooting",
    "category": null,
    "shot_type_id": null,
    "polarity": "do",
    "direction": null,
    "text": "string",
    "images": null
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "properties": {
        "scope_type": {
            "$ref": "#/components/schemas/GuidelineNoteScopeType"
        },
        "category": {
            "anyOf": [
                {
                    "type": "string"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Category"
        },
        "shot_type_id": {
            "anyOf": [
                {
                    "type": "string",
                    "format": "uuid"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Shot Type Id"
        },
        "polarity": {
            "$ref": "#/components/schemas/GuidelineNotePolarity",
            "default": "neutral"
        },
        "direction": {
            "anyOf": [
                {
                    "type": "string"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Direction"
        },
        "text": {
            "type": "string",
            "title": "Text"
        },
        "images": {
            "anyOf": [
                {
                    "items": {
                        "$ref": "#/components/schemas/MediaInput"
                    },
                    "type": "array"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Images"
        }
    },
    "type": "object",
    "required": [
        "scope_type",
        "text"
    ],
    "title": "GuidelineNoteCreate",
    "description": "POST body — author a note at a scope."
}

Responses

201 Created422 Unprocessable Entity

application/json

{
    "id": "04d78503-1431-412d-938f-a424cc69c265",
    "shooting_id": "23952e6a-af5c-4291-989b-822b1e0c4126",
    "scope_type": "shooting",
    "category": null,
    "shot_type_id": null,
    "polarity": "do",
    "direction": null,
    "text": "string",
    "author_id": "e93d076d-7851-42fc-8d6e-0e37e04b3e6c",
    "last_editor_id": "bf425425-39bc-47e8-a8fc-4758bd9cce99",
    "author_name": null,
    "last_editor_name": null,
    "shot_type_name": null,
    "images": null,
    "created_at": "2022-04-13T15:42:05.901Z",
    "updated_at": "2022-04-13T15:42:05.901Z"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "properties": {
        "id": {
            "type": "string",
            "format": "uuid",
            "title": "Id"
        },
        "shooting_id": {
            "type": "string",
            "format": "uuid",
            "title": "Shooting Id"
        },
        "scope_type": {
            "$ref": "#/components/schemas/GuidelineNoteScopeType"
        },
        "category": {
            "anyOf": [
                {
                    "type": "string"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Category"
        },
        "shot_type_id": {
            "anyOf": [
                {
                    "type": "string",
                    "format": "uuid"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Shot Type Id"
        },
        "polarity": {
            "$ref": "#/components/schemas/GuidelineNotePolarity"
        },
        "direction": {
            "anyOf": [
                {
                    "type": "string"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Direction"
        },
        "text": {
            "type": "string",
            "title": "Text"
        },
        "author_id": {
            "type": "string",
            "format": "uuid",
            "title": "Author Id"
        },
        "last_editor_id": {
            "type": "string",
            "format": "uuid",
            "title": "Last Editor Id"
        },
        "author_name": {
            "anyOf": [
                {
                    "type": "string"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Author Name"
        },
        "last_editor_name": {
            "anyOf": [
                {
                    "type": "string"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Last Editor Name"
        },
        "shot_type_name": {
            "anyOf": [
                {
                    "type": "string"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Shot Type Name"
        },
        "images": {
            "anyOf": [
                {
                    "items": {
                        "$ref": "#/components/schemas/MediaResourcePublic"
                    },
                    "type": "array"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Images"
        },
        "created_at": {
            "type": "string",
            "format": "date-time",
            "title": "Created At"
        },
        "updated_at": {
            "type": "string",
            "format": "date-time",
            "title": "Updated At"
        }
    },
    "type": "object",
    "required": [
        "id",
        "shooting_id",
        "scope_type",
        "category",
        "shot_type_id",
        "polarity",
        "direction",
        "text",
        "author_id",
        "last_editor_id",
        "created_at",
        "updated_at"
    ],
    "title": "GuidelineNotePublic",
    "description": "Mutation result (POST 201 / PATCH 200) and list-item shape."
}

application/json

{
    "detail": [
        {
            "loc": [
                null
            ],
            "msg": "string",
            "type": "string",
            "input": null,
            "ctx": {}
        }
    ]
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "properties": {
        "detail": {
            "items": {
                "$ref": "#/components/schemas/ValidationError"
            },
            "type": "array",
            "title": "Detail"
        }
    },
    "type": "object",
    "title": "HTTPValidationError"
}

GET /api/v1/shootings/{shooting_id}/guideline-notes/shot-types¶

List Guideline Note Shot Types

Description

Distinct shot types present in this shooting (the category-note picker source).

Input parameters

Parameter	In	Type	Default	Nullable	Description
`OAuth2PasswordBearer`	header	string	N/A	No
`shooting_id`	path	string		No

Responses

200 OK422 Unprocessable Entity

application/json

[
    {
        "name": "string",
        "view_angle": "front",
        "framing": null,
        "shot_type_ref_image_url": null,
        "shot_type_prompt_instruction": null,
        "file_naming_convention": null,
        "reference_image_url": null,
        "prompt": null,
        "prompt_builder_section": null,
        "core_focus": true,
        "default_shot_type": null,
        "margins": null,
        "margins_key": null,
        "owner_id": null,
        "public": true,
        "organization_id": null,
        "requires_subject": true,
        "id": "6da5baa0-2ae0-4fc5-af79-3162f3d972ae",
        "created_at": "2022-04-13T15:42:05.901Z",
        "updated_at": "2022-04-13T15:42:05.901Z",
        "deleted_at": null,
        "reference_image": null
    }
]

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "type": "array",
    "items": {
        "$ref": "#/components/schemas/ShotTypePublic"
    },
    "title": "Response List Guideline Note Shot Types"
}

application/json

{
    "detail": [
        {
            "loc": [
                null
            ],
            "msg": "string",
            "type": "string",
            "input": null,
            "ctx": {}
        }
    ]
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "properties": {
        "detail": {
            "items": {
                "$ref": "#/components/schemas/ValidationError"
            },
            "type": "array",
            "title": "Detail"
        }
    },
    "type": "object",
    "title": "HTTPValidationError"
}

PATCH /api/v1/shootings/{shooting_id}/guideline-notes/{note_id}¶

Update Guideline Note

Description

Edit a note (200; last-writer-wins, bumps the last editor).

Input parameters

Parameter	In	Type	Default	Nullable
`OAuth2PasswordBearer`	header	string	N/A	No
`note_id`	path	string		No
`shooting_id`	path	string		No

Request body

application/json

{
    "category": null,
    "shot_type_id": null,
    "polarity": null,
    "direction": null,
    "text": null,
    "images": null
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "properties": {
        "category": {
            "anyOf": [
                {
                    "type": "string"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Category"
        },
        "shot_type_id": {
            "anyOf": [
                {
                    "type": "string",
                    "format": "uuid"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Shot Type Id"
        },
        "polarity": {
            "anyOf": [
                {
                    "$ref": "#/components/schemas/GuidelineNotePolarity"
                },
                {
                    "type": "null"
                }
            ]
        },
        "direction": {
            "anyOf": [
                {
                    "type": "string"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Direction"
        },
        "text": {
            "anyOf": [
                {
                    "type": "string"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Text"
        },
        "images": {
            "anyOf": [
                {
                    "items": {
                        "$ref": "#/components/schemas/MediaInput"
                    },
                    "type": "array"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Images"
        }
    },
    "type": "object",
    "title": "GuidelineNoteUpdate",
    "description": "PATCH body — all fields optional (last-writer-wins)."
}

Responses

200 OK422 Unprocessable Entity

application/json

{
    "id": "00930a67-e3f2-4923-87c8-2614e42a5b33",
    "shooting_id": "bbbb9fc0-21df-4483-8126-edd1dd9edec9",
    "scope_type": "shooting",
    "category": null,
    "shot_type_id": null,
    "polarity": "do",
    "direction": null,
    "text": "string",
    "author_id": "52841a6d-25a9-4698-9b36-2784f5a534b8",
    "last_editor_id": "971f0070-ee95-4177-b016-108c359917f1",
    "author_name": null,
    "last_editor_name": null,
    "shot_type_name": null,
    "images": null,
    "created_at": "2022-04-13T15:42:05.901Z",
    "updated_at": "2022-04-13T15:42:05.901Z"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "properties": {
        "id": {
            "type": "string",
            "format": "uuid",
            "title": "Id"
        },
        "shooting_id": {
            "type": "string",
            "format": "uuid",
            "title": "Shooting Id"
        },
        "scope_type": {
            "$ref": "#/components/schemas/GuidelineNoteScopeType"
        },
        "category": {
            "anyOf": [
                {
                    "type": "string"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Category"
        },
        "shot_type_id": {
            "anyOf": [
                {
                    "type": "string",
                    "format": "uuid"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Shot Type Id"
        },
        "polarity": {
            "$ref": "#/components/schemas/GuidelineNotePolarity"
        },
        "direction": {
            "anyOf": [
                {
                    "type": "string"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Direction"
        },
        "text": {
            "type": "string",
            "title": "Text"
        },
        "author_id": {
            "type": "string",
            "format": "uuid",
            "title": "Author Id"
        },
        "last_editor_id": {
            "type": "string",
            "format": "uuid",
            "title": "Last Editor Id"
        },
        "author_name": {
            "anyOf": [
                {
                    "type": "string"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Author Name"
        },
        "last_editor_name": {
            "anyOf": [
                {
                    "type": "string"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Last Editor Name"
        },
        "shot_type_name": {
            "anyOf": [
                {
                    "type": "string"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Shot Type Name"
        },
        "images": {
            "anyOf": [
                {
                    "items": {
                        "$ref": "#/components/schemas/MediaResourcePublic"
                    },
                    "type": "array"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Images"
        },
        "created_at": {
            "type": "string",
            "format": "date-time",
            "title": "Created At"
        },
        "updated_at": {
            "type": "string",
            "format": "date-time",
            "title": "Updated At"
        }
    },
    "type": "object",
    "required": [
        "id",
        "shooting_id",
        "scope_type",
        "category",
        "shot_type_id",
        "polarity",
        "direction",
        "text",
        "author_id",
        "last_editor_id",
        "created_at",
        "updated_at"
    ],
    "title": "GuidelineNotePublic",
    "description": "Mutation result (POST 201 / PATCH 200) and list-item shape."
}

application/json

{
    "detail": [
        {
            "loc": [
                null
            ],
            "msg": "string",
            "type": "string",
            "input": null,
            "ctx": {}
        }
    ]
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "properties": {
        "detail": {
            "items": {
                "$ref": "#/components/schemas/ValidationError"
            },
            "type": "array",
            "title": "Detail"
        }
    },
    "type": "object",
    "title": "HTTPValidationError"
}

DELETE /api/v1/shootings/{shooting_id}/guideline-notes/{note_id}¶

Delete Guideline Note

Description

Delete a note from this shooting (404 if it is not in this shooting).

Input parameters

Parameter	In	Type	Default	Nullable
`OAuth2PasswordBearer`	header	string	N/A	No
`note_id`	path	string		No
`shooting_id`	path	string		No

Responses

204 No Content422 Unprocessable Entity

application/json

{
    "detail": [
        {
            "loc": [
                null
            ],
            "msg": "string",
            "type": "string",
            "input": null,
            "ctx": {}
        }
    ]
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "properties": {
        "detail": {
            "items": {
                "$ref": "#/components/schemas/ValidationError"
            },
            "type": "array",
            "title": "Detail"
        }
    },
    "type": "object",
    "title": "HTTPValidationError"
}

Schemas¶

DefaultShotTypes¶

Type: string

GuidelineNoteCreate¶

Name	Type	Description
`category`
`direction`
`images`
`polarity`	GuidelineNotePolarity
`scope_type`	GuidelineNoteScopeType
`shot_type_id`
`text`	string

GuidelineNotePolarity¶

Type: string

GuidelineNotePublic¶

Name	Type	Description
`author_id`	string(uuid)
`author_name`
`category`
`created_at`	string(date-time)
`direction`
`id`	string(uuid)
`images`
`last_editor_id`	string(uuid)
`last_editor_name`
`polarity`	GuidelineNotePolarity
`scope_type`	GuidelineNoteScopeType
`shooting_id`	string(uuid)
`shot_type_id`
`shot_type_name`
`text`	string
`updated_at`	string(date-time)

GuidelineNoteScopeType¶

Type: string

GuidelineNoteUpdate¶

Name	Type	Description
`category`
`direction`
`images`
`polarity`
`shot_type_id`
`text`

HTTPValidationError¶

Name	Type	Description
`detail`	Array<ValidationError>

MediaInput¶

Name	Type	Description
`alt_text`
`caption`
`color_profile`
`dominant_color`
`duration`
`height`
`media_resource_id`
`protected`	boolean
`url`
`width`

MediaResourcePublic¶

Name	Type	Description
`alt_text`
`aspect_ratio`
`caption`
`color_profile`
`content_hash`	string
`created_at`	string(date-time)
`dominant_color`
`duration`
`extension`	string
`file_size`	integer
`height`
`id`	string(uuid)
`orientation`
`protected`	boolean
`resource_type`	MediaResourceType
`url`	string
`width`

MediaResourceType¶

Type: string

ShotTypeFraming¶

Type: string

ShotTypePublic¶

Name	Type	Description
`core_focus`	boolean
`created_at`	string(date-time)
`default_shot_type`
`deleted_at`
`file_naming_convention`
`framing`
`id`	string(uuid)
`margins`
`margins_key`
`name`	string
`organization_id`
`owner_id`
`prompt`
`prompt_builder_section`
`public`	boolean
`reference_image`
`reference_image_url`
`requires_subject`	boolean
`shot_type_prompt_instruction`
`shot_type_ref_image_url`
`updated_at`	string(date-time)
`view_angle`	ViewAngle

ValidationError¶

Name	Type	Description
`ctx`
`input`
`loc`	Array<>
`msg`	string
`type`	string

ViewAngle¶

Type: string

Security schemes¶

Name	Type	Scheme	Description
OAuth2PasswordBearer	oauth2