514686d9d5
* Basic setup for drf-spectacular * Updated to only handle /api/v1 endpoints * feat: add asset and user endpoints with URL routing - Introduced new asset-related endpoints for user assets and server assets, allowing for asset uploads and management. - Added user endpoint to retrieve current user information. - Updated URL routing to include new asset and user patterns. - Enhanced issue handling with a new search endpoint for issues across multiple fields. - Expanded member management with a new endpoint for workspace members. * Group endpoints by tags * Detailed schema definitions and examples for asset endpoints * Removed unnecessary extension * Specify avatar_url field separately * chore: add project docs * chore: correct all errors * chore: added open spec in work items * feat: enhance cycle API endpoints with detailed OpenAPI specifications - Updated CycleAPIEndpoint and CycleIssueAPIEndpoint to include detailed OpenAPI schema definitions for GET, POST, PATCH, and DELETE operations. - Specified allowed HTTP methods for each endpoint in the URL routing. - Improved documentation for cycle creation, updating, and deletion, including request and response examples. * chore: added open spec in labels * chore: work item properties * feat: enhance API endpoints with OpenAPI specifications and HTTP method definitions - Added detailed OpenAPI schema definitions for various API endpoints including Intake, Module, and State. - Specified allowed HTTP methods for each endpoint in the URL routing for better clarity and documentation. - Improved request and response examples for better understanding of API usage. - Introduced unarchive functionality for cycles and modules with appropriate endpoint definitions. * chore: run formatter * Removed unnecessary settings for authentication * Refactors OpenAPI documentation structure Improves the organization and maintainability of the OpenAPI documentation by modularizing the `openapi_spec_helpers.py` file. The changes include: - Migrates common parameters, responses, examples, and authentication extensions to separate modules. - Introduces helper decorators for different endpoint types. - Updates view imports to use the new module paths. - Removes the legacy `openapi_spec_helpers.py` file. This refactoring results in a more structured and easier-to-maintain OpenAPI documentation setup. * Refactor OpenAPI endpoint specifications - Removed unnecessary parameters from the OpenAPI documentation for various endpoints in the asset, cycle, and project views. - Updated request structures to improve clarity and consistency across the API documentation. - Enhanced response formatting for better readability and maintainability. * Enhance API documentation with detailed endpoint descriptions Updated various API endpoints across the application to include comprehensive docstrings that clarify their functionality. Each endpoint now features a summary and detailed description, improving the overall understanding of their purpose and usage. This change enhances the OpenAPI specifications for better developer experience and documentation clarity. * Enhance API serializers and views with new request structures - Added new serializers for handling cycle and module issue requests, including `CycleIssueRequestSerializer`, `TransferCycleIssueRequestSerializer`, `ModuleIssueRequestSerializer`, and intake issue creation/updating serializers. - Updated existing serializers to improve clarity and maintainability, including the `UserAssetUploadSerializer` and `IssueAttachmentUploadSerializer`. - Refactored API views to utilize the new serializers, enhancing the request handling for cycle and intake issue endpoints. - Improved OpenAPI documentation by replacing inline request definitions with serializer references for better consistency and readability. * Refactor OpenAPI documentation and endpoint specifications - Replaced inline schema definitions with dedicated decorators for various endpoint types, enhancing clarity and maintainability. - Updated API views to utilize new decorators for user, cycle, intake, module, and project endpoints, improving consistency in OpenAPI documentation. - Removed unnecessary parameters and responses from endpoint specifications, streamlining the documentation for better readability. - Enhanced the organization of OpenAPI documentation by modularizing endpoint-specific decorators and parameters. * chore: correct formatting * chore: correct formatting for all api folder files * refactor: clean up serializer imports and test setup - Removed unused `StateLiteSerializer` import from the serializer module. - Updated test setup to include a noqa comment for the `django_db_setup` fixture, ensuring clarity in the code. - Added missing commas in user data dictionary for consistency. * feat: add project creation and update serializers with validation - Introduced `ProjectCreateSerializer` and `ProjectUpdateSerializer` to handle project creation and updates, respectively. - Implemented validation to ensure project leads and default assignees are members of the workspace. - Updated API views to utilize the new serializers for creating and updating projects, enhancing request handling. - Added OpenAPI documentation references for the new serializers in the project API endpoints. * feat: update serializers to include additional read-only fields * refactor: rename intake issue serializers and enhance structure - Renamed `CreateIntakeIssueRequestSerializer` to `IntakeIssueCreateSerializer` and `UpdateIntakeIssueRequestSerializer` to `IntakeIssueUpdateSerializer` for clarity. - Introduced `IssueSerializer` for nested issue data in intake requests, improving the organization of serializer logic. - Updated API views to utilize the new serializer names, ensuring consistency across the codebase. * refactor: rename issue serializer for intake and enhance API documentation - Renamed `IssueSerializer` to `IssueForIntakeSerializer` for better clarity in the context of intake issues. - Updated references in `IntakeIssueCreateSerializer` and `IntakeIssueUpdateSerializer` to use the new `IssueForIntakeSerializer`. - Added OpenAPI documentation for the `get_workspace_work_item` endpoint, detailing parameters and responses for improved clarity. * chore: modules and cycles serializers * feat: add new serializers for label and issue link management - Introduced `LabelCreateUpdateSerializer`, `IssueLinkCreateSerializer`, `IssueLinkUpdateSerializer`, and `IssueCommentCreateSerializer` to enhance the handling of label and issue link data. - Updated existing API views to utilize the new serializers for creating and updating labels, issue links, and comments, improving request handling and validation. - Added `IssueSearchSerializer` for searching issues, streamlining the search functionality in the API. * Don't consider read only fields as required * Add setting to separate request and response definitions * Fixed avatar_url warning on openapi spec generation * Made spectacular disabled by default * Moved spectacular settings into separate file and added detailed descriptions to tags * Specify methods for asset urls * Better server names * Enhance API documentation with summaries for various endpoints - Added summary descriptions for user asset, cycle, intake, issue, member, module, project, state, and user API endpoints to improve clarity and usability of the API documentation. - Updated the OpenAPI specifications to reflect these changes, ensuring better understanding for developers interacting with the API. * Add contact information to OpenAPI settings - Included contact details for Plane in the OpenAPI settings to enhance API documentation and provide developers with a direct point of contact for support. - This addition aims to improve the overall usability and accessibility of the API documentation. * Reordered tags and improved description relavancy * Enhance OpenAPI documentation for cycle and issue endpoints - Added response definitions for the `get_cycle_issues` and `delete_cycle_issue` methods in the CycleIssueAPIEndpoint to clarify expected outcomes. - Included additional response codes for the IssueSearchEndpoint to handle various error scenarios, improving the overall API documentation and usability. * Enhance serializer documentation across multiple files - Updated docstrings for various serializers including UserAssetUploadSerializer, AssetUpdateSerializer, and others to provide clearer descriptions of their functionality and usage. - Improved consistency in formatting and language across serializer classes to enhance readability and maintainability. - Added detailed explanations for new serializers related to project, module, and cycle management, ensuring comprehensive documentation for developers. * Refactor API endpoints for cycles, intake, modules, projects, and states - Replaced existing API endpoint classes with more descriptive names such as CycleListCreateAPIEndpoint, CycleDetailAPIEndpoint, IntakeIssueListCreateAPIEndpoint, and others to enhance clarity. - Updated URL patterns to reflect the new endpoint names, ensuring consistency across the API. - Improved documentation and method summaries for better understanding of endpoint functionalities. - Enhanced query handling in the new endpoint classes to streamline data retrieval and improve performance. * Refactor issue and label API endpoints for clarity and functionality - Renamed existing API endpoint classes to more descriptive names such as IssueListCreateAPIEndpoint, IssueDetailAPIEndpoint, LabelListCreateAPIEndpoint, and LabelDetailAPIEndpoint to enhance clarity. - Updated URL patterns to reflect the new endpoint names, ensuring consistency across the API. - Improved method summaries and documentation for better understanding of endpoint functionalities. - Streamlined query handling in the new endpoint classes to enhance data retrieval and performance. * Refactor asset API endpoint methods and introduce new status enums - Updated the GenericAssetEndpoint to only allow POST requests for asset creation, removing the GET method. - Modified the get method to require asset_id, ensuring that asset retrieval is always tied to a specific asset. - Added new IntakeIssueStatus and ModuleStatus enums to improve clarity and management of asset and module states. - Enhanced OpenAPI settings to include these new enums for better documentation and usability. * enforce naming convention * Added LICENSE to openapi spec * Enhance OpenAPI documentation for various API endpoints - Updated API endpoints in asset, cycle, intake, issue, module, project, and state views to include OpenApiRequest and OpenApiExample for better request documentation. - Added example requests for creating and updating resources, improving clarity for API consumers. - Ensured consistent use of OpenApi utilities across all relevant endpoints to enhance overall API documentation quality. * Enhance OpenAPI documentation for various API endpoints - Added detailed descriptions to multiple API endpoints across asset, cycle, intake, issue, module, project, state, and user views to improve clarity for API consumers. - Ensured consistent documentation practices by including descriptions that outline the purpose and functionality of each endpoint. - This update aims to enhance the overall usability and understanding of the API documentation. * Update OpenAPI examples and enhance project queryset logic - Changed example fields in OpenAPI documentation for issue comments from "content" to "comment_html" to reflect the correct structure. - Introduced a new `get_queryset` method in the ProjectDetailAPIEndpoint to filter projects based on user membership and workspace, while also annotating additional project-related data such as total members, cycles, and modules. - Updated permission checks to use the correct attribute name for project identifiers, ensuring accurate permission handling. * Enhance OpenAPI documentation and add response examples - Updated multiple API endpoints across asset, cycle, intake, issue, module, project, state, and user views to include new OpenApiResponse examples for better clarity on expected outcomes. - Introduced new parameters for project and issue identifiers to improve request handling and documentation consistency. - Enhanced existing responses with detailed examples to aid API consumers in understanding the expected data structure and error handling. - This update aims to improve the overall usability and clarity of the API documentation. * refactor: update terminology from 'issues' to 'work items' across multiple API endpoints for consistency and clarity * use common timezones from pytz for choices * Moved the openapi utils to the new folder structure * Added exception logging in GenericAssetEndpoint to improve error handling * Fixed code rabbit suggestions * Refactored IssueDetailAPIEndpoint to streamline issue retrieval and response handling, removing redundant external ID checks and custom ordering logic. --------- Co-authored-by: pablohashescobar <nikhilschacko@gmail.com> Co-authored-by: NarayanBavisetti <narayan3119@gmail.com>
493 lines
13 KiB
Python
493 lines
13 KiB
Python
"""
|
|
Common OpenAPI parameters for drf-spectacular.
|
|
|
|
This module provides reusable parameter definitions that can be shared
|
|
across multiple API endpoints to ensure consistency.
|
|
"""
|
|
|
|
from drf_spectacular.utils import OpenApiParameter, OpenApiExample
|
|
from drf_spectacular.types import OpenApiTypes
|
|
|
|
|
|
# Path Parameters
|
|
WORKSPACE_SLUG_PARAMETER = OpenApiParameter(
|
|
name="slug",
|
|
description="Workspace slug",
|
|
required=True,
|
|
type=OpenApiTypes.STR,
|
|
location=OpenApiParameter.PATH,
|
|
examples=[
|
|
OpenApiExample(
|
|
name="Example workspace",
|
|
value="my-workspace",
|
|
description="A typical workspace slug",
|
|
)
|
|
],
|
|
)
|
|
|
|
PROJECT_ID_PARAMETER = OpenApiParameter(
|
|
name="project_id",
|
|
description="Project ID",
|
|
required=True,
|
|
type=OpenApiTypes.UUID,
|
|
location=OpenApiParameter.PATH,
|
|
examples=[
|
|
OpenApiExample(
|
|
name="Example project ID",
|
|
value="550e8400-e29b-41d4-a716-446655440000",
|
|
description="A typical project UUID",
|
|
)
|
|
],
|
|
)
|
|
|
|
PROJECT_PK_PARAMETER = OpenApiParameter(
|
|
name="pk",
|
|
description="Project ID",
|
|
required=True,
|
|
type=OpenApiTypes.UUID,
|
|
location=OpenApiParameter.PATH,
|
|
examples=[
|
|
OpenApiExample(
|
|
name="Example project ID",
|
|
value="550e8400-e29b-41d4-a716-446655440000",
|
|
description="A typical project UUID",
|
|
)
|
|
],
|
|
)
|
|
|
|
PROJECT_IDENTIFIER_PARAMETER = OpenApiParameter(
|
|
name="project_identifier",
|
|
description="Project identifier (unique string within workspace)",
|
|
required=True,
|
|
type=OpenApiTypes.STR,
|
|
location=OpenApiParameter.PATH,
|
|
examples=[
|
|
OpenApiExample(
|
|
name="Example project identifier",
|
|
value="PROJ",
|
|
description="A typical project identifier",
|
|
)
|
|
],
|
|
)
|
|
|
|
ISSUE_IDENTIFIER_PARAMETER = OpenApiParameter(
|
|
name="issue_identifier",
|
|
description="Issue sequence ID (numeric identifier within project)",
|
|
required=True,
|
|
type=OpenApiTypes.INT,
|
|
location=OpenApiParameter.PATH,
|
|
examples=[
|
|
OpenApiExample(
|
|
name="Example issue identifier",
|
|
value=123,
|
|
description="A typical issue sequence ID",
|
|
)
|
|
],
|
|
)
|
|
|
|
ASSET_ID_PARAMETER = OpenApiParameter(
|
|
name="asset_id",
|
|
description="Asset ID",
|
|
required=True,
|
|
type=OpenApiTypes.UUID,
|
|
location=OpenApiParameter.PATH,
|
|
examples=[
|
|
OpenApiExample(
|
|
name="Example asset ID",
|
|
value="550e8400-e29b-41d4-a716-446655440000",
|
|
description="A typical asset UUID",
|
|
)
|
|
],
|
|
)
|
|
|
|
CYCLE_ID_PARAMETER = OpenApiParameter(
|
|
name="cycle_id",
|
|
description="Cycle ID",
|
|
required=True,
|
|
type=OpenApiTypes.UUID,
|
|
location=OpenApiParameter.PATH,
|
|
examples=[
|
|
OpenApiExample(
|
|
name="Example cycle ID",
|
|
value="550e8400-e29b-41d4-a716-446655440000",
|
|
description="A typical cycle UUID",
|
|
)
|
|
],
|
|
)
|
|
|
|
MODULE_ID_PARAMETER = OpenApiParameter(
|
|
name="module_id",
|
|
description="Module ID",
|
|
required=True,
|
|
type=OpenApiTypes.UUID,
|
|
location=OpenApiParameter.PATH,
|
|
examples=[
|
|
OpenApiExample(
|
|
name="Example module ID",
|
|
value="550e8400-e29b-41d4-a716-446655440000",
|
|
description="A typical module UUID",
|
|
)
|
|
],
|
|
)
|
|
|
|
MODULE_PK_PARAMETER = OpenApiParameter(
|
|
name="pk",
|
|
description="Module ID",
|
|
required=True,
|
|
type=OpenApiTypes.UUID,
|
|
location=OpenApiParameter.PATH,
|
|
examples=[
|
|
OpenApiExample(
|
|
name="Example module ID",
|
|
value="550e8400-e29b-41d4-a716-446655440000",
|
|
description="A typical module UUID",
|
|
)
|
|
],
|
|
)
|
|
|
|
ISSUE_ID_PARAMETER = OpenApiParameter(
|
|
name="issue_id",
|
|
description="Issue ID",
|
|
required=True,
|
|
type=OpenApiTypes.UUID,
|
|
location=OpenApiParameter.PATH,
|
|
examples=[
|
|
OpenApiExample(
|
|
name="Example issue ID",
|
|
value="550e8400-e29b-41d4-a716-446655440000",
|
|
description="A typical issue UUID",
|
|
)
|
|
],
|
|
)
|
|
|
|
STATE_ID_PARAMETER = OpenApiParameter(
|
|
name="state_id",
|
|
description="State ID",
|
|
required=True,
|
|
type=OpenApiTypes.UUID,
|
|
location=OpenApiParameter.PATH,
|
|
examples=[
|
|
OpenApiExample(
|
|
name="Example state ID",
|
|
value="550e8400-e29b-41d4-a716-446655440000",
|
|
description="A typical state UUID",
|
|
)
|
|
],
|
|
)
|
|
|
|
# Additional Path Parameters
|
|
LABEL_ID_PARAMETER = OpenApiParameter(
|
|
name="pk",
|
|
description="Label ID",
|
|
required=True,
|
|
type=OpenApiTypes.UUID,
|
|
location=OpenApiParameter.PATH,
|
|
examples=[
|
|
OpenApiExample(
|
|
name="Example label ID",
|
|
value="550e8400-e29b-41d4-a716-446655440000",
|
|
description="A typical label UUID",
|
|
)
|
|
],
|
|
)
|
|
|
|
COMMENT_ID_PARAMETER = OpenApiParameter(
|
|
name="pk",
|
|
description="Comment ID",
|
|
required=True,
|
|
type=OpenApiTypes.UUID,
|
|
location=OpenApiParameter.PATH,
|
|
examples=[
|
|
OpenApiExample(
|
|
name="Example comment ID",
|
|
value="550e8400-e29b-41d4-a716-446655440000",
|
|
description="A typical comment UUID",
|
|
)
|
|
],
|
|
)
|
|
|
|
LINK_ID_PARAMETER = OpenApiParameter(
|
|
name="pk",
|
|
description="Link ID",
|
|
required=True,
|
|
type=OpenApiTypes.UUID,
|
|
location=OpenApiParameter.PATH,
|
|
examples=[
|
|
OpenApiExample(
|
|
name="Example link ID",
|
|
value="550e8400-e29b-41d4-a716-446655440000",
|
|
description="A typical link UUID",
|
|
)
|
|
],
|
|
)
|
|
|
|
ATTACHMENT_ID_PARAMETER = OpenApiParameter(
|
|
name="pk",
|
|
description="Attachment ID",
|
|
required=True,
|
|
type=OpenApiTypes.UUID,
|
|
location=OpenApiParameter.PATH,
|
|
examples=[
|
|
OpenApiExample(
|
|
name="Example attachment ID",
|
|
value="550e8400-e29b-41d4-a716-446655440000",
|
|
description="A typical attachment UUID",
|
|
)
|
|
],
|
|
)
|
|
|
|
ACTIVITY_ID_PARAMETER = OpenApiParameter(
|
|
name="pk",
|
|
description="Activity ID",
|
|
required=True,
|
|
type=OpenApiTypes.UUID,
|
|
location=OpenApiParameter.PATH,
|
|
examples=[
|
|
OpenApiExample(
|
|
name="Example activity ID",
|
|
value="550e8400-e29b-41d4-a716-446655440000",
|
|
description="A typical activity UUID",
|
|
)
|
|
],
|
|
)
|
|
|
|
# Query Parameters
|
|
CURSOR_PARAMETER = OpenApiParameter(
|
|
name="cursor",
|
|
type=OpenApiTypes.STR,
|
|
location=OpenApiParameter.QUERY,
|
|
description="Pagination cursor for getting next set of results",
|
|
required=False,
|
|
examples=[
|
|
OpenApiExample(
|
|
name="Next page cursor",
|
|
value="20:1:0",
|
|
description="Cursor format: 'page_size:page_number:offset'",
|
|
)
|
|
],
|
|
)
|
|
|
|
PER_PAGE_PARAMETER = OpenApiParameter(
|
|
name="per_page",
|
|
type=OpenApiTypes.INT,
|
|
location=OpenApiParameter.QUERY,
|
|
description="Number of results per page (default: 20, max: 100)",
|
|
required=False,
|
|
examples=[
|
|
OpenApiExample(name="Default", value=20),
|
|
OpenApiExample(name="Maximum", value=100),
|
|
],
|
|
)
|
|
|
|
# External Integration Parameters
|
|
EXTERNAL_ID_PARAMETER = OpenApiParameter(
|
|
name="external_id",
|
|
type=OpenApiTypes.STR,
|
|
location=OpenApiParameter.QUERY,
|
|
description="External system identifier for filtering or lookup",
|
|
required=False,
|
|
examples=[
|
|
OpenApiExample(
|
|
name="GitHub Issue",
|
|
value="1234567890",
|
|
description="GitHub issue number",
|
|
)
|
|
],
|
|
)
|
|
|
|
EXTERNAL_SOURCE_PARAMETER = OpenApiParameter(
|
|
name="external_source",
|
|
type=OpenApiTypes.STR,
|
|
location=OpenApiParameter.QUERY,
|
|
description="External system source name for filtering or lookup",
|
|
required=False,
|
|
examples=[
|
|
OpenApiExample(
|
|
name="GitHub",
|
|
value="github",
|
|
description="GitHub integration source",
|
|
),
|
|
OpenApiExample(
|
|
name="Jira",
|
|
value="jira",
|
|
description="Jira integration source",
|
|
),
|
|
],
|
|
)
|
|
|
|
# Ordering Parameters
|
|
ORDER_BY_PARAMETER = OpenApiParameter(
|
|
name="order_by",
|
|
type=OpenApiTypes.STR,
|
|
location=OpenApiParameter.QUERY,
|
|
description="Field to order results by. Prefix with '-' for descending order",
|
|
required=False,
|
|
examples=[
|
|
OpenApiExample(
|
|
name="Created date descending",
|
|
value="-created_at",
|
|
description="Most recent items first",
|
|
),
|
|
OpenApiExample(
|
|
name="Priority ascending",
|
|
value="priority",
|
|
description="Order by priority (urgent, high, medium, low, none)",
|
|
),
|
|
OpenApiExample(
|
|
name="State group",
|
|
value="state__group",
|
|
description="Order by state group (backlog, unstarted, started, completed, cancelled)",
|
|
),
|
|
OpenApiExample(
|
|
name="Assignee name",
|
|
value="assignees__first_name",
|
|
description="Order by assignee first name",
|
|
),
|
|
],
|
|
)
|
|
|
|
# Search Parameters
|
|
SEARCH_PARAMETER = OpenApiParameter(
|
|
name="search",
|
|
type=OpenApiTypes.STR,
|
|
location=OpenApiParameter.QUERY,
|
|
description="Search query to filter results by name, description, or identifier",
|
|
required=False,
|
|
examples=[
|
|
OpenApiExample(
|
|
name="Name search",
|
|
value="bug fix",
|
|
description="Search for items containing 'bug fix'",
|
|
),
|
|
OpenApiExample(
|
|
name="Sequence ID",
|
|
value="123",
|
|
description="Search by sequence ID number",
|
|
),
|
|
],
|
|
)
|
|
|
|
SEARCH_PARAMETER_REQUIRED = OpenApiParameter(
|
|
name="search",
|
|
type=OpenApiTypes.STR,
|
|
location=OpenApiParameter.QUERY,
|
|
description="Search query to filter results by name, description, or identifier",
|
|
required=True,
|
|
examples=[
|
|
OpenApiExample(
|
|
name="Name search",
|
|
value="bug fix",
|
|
description="Search for items containing 'bug fix'",
|
|
),
|
|
OpenApiExample(
|
|
name="Sequence ID",
|
|
value="123",
|
|
description="Search by sequence ID number",
|
|
),
|
|
],
|
|
)
|
|
|
|
LIMIT_PARAMETER = OpenApiParameter(
|
|
name="limit",
|
|
type=OpenApiTypes.INT,
|
|
location=OpenApiParameter.QUERY,
|
|
description="Maximum number of results to return",
|
|
required=False,
|
|
examples=[
|
|
OpenApiExample(name="Default", value=10),
|
|
OpenApiExample(name="More results", value=50),
|
|
],
|
|
)
|
|
|
|
WORKSPACE_SEARCH_PARAMETER = OpenApiParameter(
|
|
name="workspace_search",
|
|
type=OpenApiTypes.STR,
|
|
location=OpenApiParameter.QUERY,
|
|
description="Whether to search across entire workspace or within specific project",
|
|
required=False,
|
|
examples=[
|
|
OpenApiExample(
|
|
name="Project only",
|
|
value="false",
|
|
description="Search within specific project only",
|
|
),
|
|
OpenApiExample(
|
|
name="Workspace wide",
|
|
value="true",
|
|
description="Search across entire workspace",
|
|
),
|
|
],
|
|
)
|
|
|
|
PROJECT_ID_QUERY_PARAMETER = OpenApiParameter(
|
|
name="project_id",
|
|
description="Project ID for filtering results within a specific project",
|
|
required=False,
|
|
type=OpenApiTypes.UUID,
|
|
location=OpenApiParameter.QUERY,
|
|
examples=[
|
|
OpenApiExample(
|
|
name="Example project ID",
|
|
value="550e8400-e29b-41d4-a716-446655440000",
|
|
description="Filter results for this project",
|
|
)
|
|
],
|
|
)
|
|
|
|
# Cycle View Parameter
|
|
CYCLE_VIEW_PARAMETER = OpenApiParameter(
|
|
name="cycle_view",
|
|
type=OpenApiTypes.STR,
|
|
location=OpenApiParameter.QUERY,
|
|
description="Filter cycles by status",
|
|
required=False,
|
|
examples=[
|
|
OpenApiExample(name="All cycles", value="all"),
|
|
OpenApiExample(name="Current cycles", value="current"),
|
|
OpenApiExample(name="Upcoming cycles", value="upcoming"),
|
|
OpenApiExample(name="Completed cycles", value="completed"),
|
|
OpenApiExample(name="Draft cycles", value="draft"),
|
|
OpenApiExample(name="Incomplete cycles", value="incomplete"),
|
|
],
|
|
)
|
|
|
|
# Field Selection Parameters
|
|
FIELDS_PARAMETER = OpenApiParameter(
|
|
name="fields",
|
|
type=OpenApiTypes.STR,
|
|
location=OpenApiParameter.QUERY,
|
|
description="Comma-separated list of fields to include in response",
|
|
required=False,
|
|
examples=[
|
|
OpenApiExample(
|
|
name="Basic fields",
|
|
value="id,name,description",
|
|
description="Include only basic fields",
|
|
),
|
|
OpenApiExample(
|
|
name="With relations",
|
|
value="id,name,assignees,state",
|
|
description="Include fields with relationships",
|
|
),
|
|
],
|
|
)
|
|
|
|
EXPAND_PARAMETER = OpenApiParameter(
|
|
name="expand",
|
|
type=OpenApiTypes.STR,
|
|
location=OpenApiParameter.QUERY,
|
|
description="Comma-separated list of related fields to expand in response",
|
|
required=False,
|
|
examples=[
|
|
OpenApiExample(
|
|
name="Expand assignees",
|
|
value="assignees",
|
|
description="Include full assignee details",
|
|
),
|
|
OpenApiExample(
|
|
name="Multiple expansions",
|
|
value="assignees,labels,state",
|
|
description="Include details for multiple relations",
|
|
),
|
|
],
|
|
)
|