{"openapi":"3.0.1","info":{"title":"ProductPlan API V2","version":"v2"},"paths":{"/api/v2/bars":{"post":{"summary":"Create Bar","tags":["Bars"],"description":"Adds a new Bar to the specifed Roadmap. All Bars added will be parked by default.","security":[{"bearer":[]}],"parameters":[],"responses":{"201":{"description":"bar successfully created"},"401":{"description":"authentication failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"roadmap not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BarCreate"},"examples":{"basic":{"summary":"Creates a bar with the given name, description, and roadmap","value":{"roadmap_id":1,"name":"Find map to Monkey Island","description":"Or is it a recipe?"}}}}},"required":true}}},"/api/v2/bars/{id}":{"get":{"summary":"Get Bar","tags":["Bars"],"description":"Returns the specified bar.","security":[{"bearer":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"bar found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BarRead"}}}},"401":{"description":"authentication failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"bar not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"patch":{"summary":"Update Bar","tags":["Bars"],"description":"Updates the specified Bar.","security":[{"bearer":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"responses":{"204":{"description":"bar successfully updated"},"401":{"description":"authentication failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BarUpdate"},"examples":{"basic":{"summary":"Update a bar's name and description","value":{"name":"Find map to Monkey Island","description":"Or is it a recipe?"}}}}},"required":true}},"delete":{"summary":"Delete Bar","tags":["Bars"],"description":"Deletes the specified Bar.","security":[{"bearer":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"responses":{"204":{"description":"bar successfully deleted"},"401":{"description":"authentication failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"bar not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/api/v2/bars/{id}/child_bars":{"get":{"summary":"Get Child Bars","parameters":[{"name":"page","in":"query","schema":{"type":"integer","description":"Indicates which page number to retrieve (based on a given page size)","default":1}},{"name":"page_size","in":"query","schema":{"type":"integer","description":"The amount of items to return with each page (default: 200, max: 500)","default":200}},{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"tags":["Bars"],"description":"Returns a list of all Child Bars for the specified Bar.","security":[{"bearer":[]}],"responses":{"200":{"description":"lists child bars","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/BarRead"},"required":["items"]},"paging":{"$ref":"#/components/schemas/Pagination"}},"required":["results","paging"]}}}},"401":{"description":"authentication failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"bar not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"bad pagination parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/api/v2/bars/{id}/comments":{"get":{"summary":"Get Bar Comments","parameters":[{"name":"page","in":"query","schema":{"type":"integer","description":"Indicates which page number to retrieve (based on a given page size)","default":1}},{"name":"page_size","in":"query","schema":{"type":"integer","description":"The amount of items to return with each page (default: 200, max: 500)","default":200}},{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"tags":["Bars"],"description":"Returns a list of all Comments for the specified Bar.","security":[{"bearer":[]}],"responses":{"200":{"description":"lists bar comments","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/CommentRead"},"required":["items"]},"paging":{"$ref":"#/components/schemas/Pagination"}},"required":["results","paging"]}}}},"401":{"description":"authentication failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"bar not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"bad pagination parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/api/v2/bars/{bar_id}/connections":{"get":{"summary":"Get Bar Connections","tags":["Bars"],"description":"Returns a list of all Connections for the specified Bar.","security":[{"bearer":[]}],"parameters":[{"name":"bar_id","in":"path","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"lists connections","content":{"application/json":{"schema":{"type":"object","properties":{"requires":{"type":"array","items":{"$ref":"#/components/schemas/BarRead"}},"required_by":{"type":"array","items":{"$ref":"#/components/schemas/BarRead"}}},"required":["requires","required_by"]}}}},"401":{"description":"authentication failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"bar not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"post":{"summary":"Create Bar Connection","tags":["Bars"],"description":"Creates a new Connection.","security":[{"bearer":[]}],"parameters":[{"name":"bar_id","in":"path","required":true,"schema":{"type":"integer"}}],"responses":{"204":{"description":"connection successfully created"},"401":{"description":"authentication failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"required bar not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConnectionCreate"}}}}}},"/api/v2/bars/{bar_id}/connections/{id}":{"delete":{"summary":"Delete Bar Connection","tags":["Bars"],"description":"Deletes the specified Connection from one Bar to another Bar.","security":[{"bearer":[]}],"parameters":[{"name":"bar_id","in":"path","description":"The id of the the first connecting bar.","required":true,"schema":{"type":"integer"}},{"name":"id","in":"path","description":"The id of the the second connecting bar.","required":true,"schema":{"type":"integer"}}],"responses":{"204":{"description":"connection successfully deleted"},"401":{"description":"authentication failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"connection not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/api/v2/discovery/idea_forms":{"get":{"summary":"GET Idea Forms","parameters":[{"name":"page","in":"query","schema":{"type":"integer","description":"Indicates which page number to retrieve (based on a given page size)","default":1}},{"name":"page_size","in":"query","schema":{"type":"integer","description":"The amount of items to return with each page (default: 200, max: 500)","default":200}},{"name":"q","in":"query","schema":{"type":"object","description":"Filter and sort query. (Filterable attributes: `account_id,created_at,id,instructions,is_enabled,title,updated_at,url_token,user_id,custom_text_field,custom_dropdown_fields`). Visit our [filtering docs](/reference/filtering) for more information about how filtering works.","example":{"title_eq":"title filter"},"default":{"created_at_lt":"2024-01-01"}},"style":"deepObject","explode":true}],"tags":["Idea Forms"],"description":"Returns a list of all Idea Forms by user.","security":[{"bearer":[]}],"responses":{"200":{"description":"lists idea forms","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/IdeaFormIndex"},"required":["items"]},"paging":{"$ref":"#/components/schemas/Pagination"}},"required":["results","paging"]}}}},"401":{"description":"authentication failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"bad pagination parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/api/v2/discovery/idea_forms/{id}":{"get":{"summary":"GET Idea Form","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"tags":["Idea Forms"],"description":"Returns a list of all Idea Forms by user.","security":[{"bearer":[]}],"responses":{"200":{"description":"idea form found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IdeaFormShow"}}}},"401":{"description":"authentication failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"idea not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/api/v2/discovery/ideas":{"get":{"summary":"Get Ideas","parameters":[{"name":"page","in":"query","schema":{"type":"integer","description":"Indicates which page number to retrieve (based on a given page size)","default":1}},{"name":"page_size","in":"query","schema":{"type":"integer","description":"The amount of items to return with each page (default: 200, max: 500)","default":200}},{"name":"q","in":"query","schema":{"type":"object","description":"Filter and sort query. (Filterable attributes: `id,name,description,channel,customer,opportunities_count,source_name,source_email,location_status`). Visit our [filtering docs](/reference/filtering) for more information about how filtering works.","example":{"name_eq":"name filter"},"default":{"created_at_lt":"2024-01-01"}},"style":"deepObject","explode":true}],"tags":["Ideas"],"description":"Returns a list of all Ideas accessible by the authenticated user.","security":[{"bearer":[]}],"responses":{"200":{"description":"lists ideas","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/IdeaIndex"},"required":["items"]},"paging":{"$ref":"#/components/schemas/Pagination"}},"required":["results","paging"]}}}},"401":{"description":"authorization failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"post":{"summary":"Create Idea","tags":["Ideas"],"description":"Creates a new Idea.","security":[{"bearer":[]}],"parameters":[],"responses":{"201":{"description":"create successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IdeaShow"}}}},"400":{"description":"bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorWithAttrs"}}}},"401":{"description":"authorization failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IdeaCreateRequest"},"examples":{"basic":{"summary":"Creates a idea with the given name and description","value":{"name":"Find map to Monkey Island","description":"Or is it a recipe?"}}}}},"required":true}}},"/api/v2/discovery/ideas/{id}":{"get":{"summary":"Get Idea","tags":["Ideas"],"description":"Returns the specified Idea.","security":[{"bearer":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"idea found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IdeaShow"}}}},"401":{"description":"authorization failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"idea not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"patch":{"summary":"Update Idea","tags":["Ideas"],"description":"Updates the specified Idea.","security":[{"bearer":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"responses":{"204":{"description":"update successful"},"400":{"description":"bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorWithAttrs"}}}},"401":{"description":"authorization failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"idea not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IdeaUpdate"},"examples":{"basic":{"summary":"Update an idea's name and description","value":{"name":"Find map to Monkey Island","description":"Or is it a recipe?"}}}}},"required":true}}},"/api/v2/discovery/ideas/customers":{"get":{"summary":"Get Customers","tags":["Ideas"],"description":"Returns a list of customers created in ProductPlan that are associated with the Discovery Ideas model.","security":[{"bearer":[]}],"responses":{"200":{"description":"customers found","content":{"application/json":{"schema":{"type":"object","properties":{"customers":{"type":"array","items":{"type":"string"}}},"required":["customers"],"additionalProperties":false}}}},"401":{"description":"authorization failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/api/v2/discovery/ideas/tags":{"get":{"summary":"Get Tags","tags":["Ideas"],"description":"Returns a list of tags (keywords) created in ProductPlan that are associated with the Discovery Ideas model.","security":[{"bearer":[]}],"responses":{"200":{"description":"tags found","content":{"application/json":{"schema":{"type":"object","properties":{"tags":{"type":"array","items":{"type":"string"}}},"required":["tags"],"additionalProperties":false}}}},"401":{"description":"authorization failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/api/v2/discovery/opportunities":{"get":{"summary":"Get Opportunities","parameters":[{"name":"page","in":"query","schema":{"type":"integer","description":"Indicates which page number to retrieve (based on a given page size)","default":1}},{"name":"page_size","in":"query","schema":{"type":"integer","description":"The amount of items to return with each page (default: 200, max: 500)","default":200}},{"name":"q","in":"query","schema":{"type":"object","description":"Filter and sort query. (Filterable attributes: `id,problem_statement,workflow_status,location_status,description,user_id,ideas_count,bars_count`). Visit our [filtering docs](/reference/filtering) for more information about how filtering works.","example":{"problem_statement_eq":"problem_statement filter"},"default":{"created_at_lt":"2024-01-01"}},"style":"deepObject","explode":true}],"tags":["Opportunities"],"description":"Returns a list of all Opportunities accessible by the authenticated user.","security":[{"bearer":[]}],"responses":{"200":{"description":"lists opportunities","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/OpportunityIndex"},"required":["items"]},"paging":{"$ref":"#/components/schemas/Pagination"}},"required":["results","paging"]}}}},"401":{"description":"authorization failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"post":{"summary":"Create Opportunity","tags":["Opportunities"],"description":"Creates an Opportunity","security":[{"bearer":[]}],"parameters":[],"responses":{"201":{"description":"create successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpportunityShow"}}}},"400":{"description":"bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorWithAttrs"}}}},"401":{"description":"authorization failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpportunityCreateRequest"},"examples":{"basic":{"summary":"Create an opportunity with a meaningful problem statement","value":{"problem_statement":"An opportunity for something great","description":"Describe the opportunity"}}}}},"required":true}}},"/api/v2/discovery/opportunities/{id}":{"get":{"summary":"Get Opportunity","tags":["Opportunities"],"description":"Returns the specified Opportunity.","security":[{"bearer":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"opportunity found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpportunityShow"}}}},"401":{"description":"authentication failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"patch":{"summary":"Update Opportunity","tags":["Opportunities"],"description":"Updates the specified Opportunity","security":[{"bearer":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"responses":{"204":{"description":"update successful"},"401":{"description":"authentication failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpportunityUpdate"},"examples":{"basic":{"summary":"Update an opportunity","value":{"problem_statement":"Updated Name"}}}}}}}},"/api/v2/roadmaps/{roadmap_id}/lanes":{"get":{"summary":"Get Roadmap Lanes","parameters":[{"name":"page","in":"query","schema":{"type":"integer","description":"Indicates which page number to retrieve (based on a given page size)","default":1}},{"name":"page_size","in":"query","schema":{"type":"integer","description":"The amount of items to return with each page (default: 200, max: 500)","default":200}},{"name":"q","in":"query","schema":{"type":"object","description":"Filter and sort query. (Filterable attributes: `id,name,description,position,created_at,updated_at`). Visit our [filtering docs](/reference/filtering) for more information about how filtering works.","example":{"name_eq":"name filter"},"default":{}},"style":"deepObject","explode":true},{"name":"roadmap_id","in":"path","required":true,"schema":{"type":"integer"}}],"tags":["Roadmaps"],"description":"Returns a list of all Lanes for the specified Roadmap.","security":[{"bearer":[]}],"responses":{"200":{"description":"lists lanes","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/LaneRead"},"required":["items"]},"paging":{"$ref":"#/components/schemas/Pagination"}},"required":["results","paging"]}}}},"401":{"description":"authentication failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"roadmap not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"bad pagination parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"post":{"summary":"Create Roadmap Lane","tags":["Roadmaps"],"description":"Creates a new Lane for the specified Roadmap.","security":[{"bearer":[]}],"parameters":[{"name":"roadmap_id","in":"path","required":true,"schema":{"type":"integer"}}],"responses":{"201":{"description":"lane successfully created"},"401":{"description":"authentication failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"roadmap not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LaneCreate"},"examples":{"0":{"summary":"Create Roadmap Lane","value":{"name":"The most important stuff","description":"Initiatives that I want to prioritize","position":1}}}}},"required":true}}},"/api/v2/roadmaps/{roadmap_id}/lanes/{id}":{"patch":{"summary":"Update Roadmap Lane","tags":["Roadmaps"],"description":"Updates a specific Lane in a specific Roadmap.","security":[{"bearer":[]}],"parameters":[{"name":"roadmap_id","in":"path","required":true,"schema":{"type":"integer"}},{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"responses":{"204":{"description":"lane successfully updated"},"401":{"description":"authentication failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"lane does not belong to the roadmap","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"null position is not allowed","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"array","items":{"type":"string"}}}},"required":["errors"]}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"position":{"type":"integer"}}}}}}},"delete":{"summary":"Delete Roadmap Lane","tags":["Roadmaps"],"description":"Deletes a specific Lane in a specific Roadmap.","security":[{"bearer":[]}],"parameters":[{"name":"roadmap_id","in":"path","required":true,"schema":{"type":"integer"}},{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"responses":{"204":{"description":"lane successfully deleted"},"401":{"description":"authentication failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"roadmap not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/api/v2/launches/{launch_id}/tasks":{"get":{"summary":"Get Tasks","parameters":[{"name":"page","in":"query","schema":{"type":"integer","description":"Indicates which page number to retrieve (based on a given page size)","default":1}},{"name":"page_size","in":"query","schema":{"type":"integer","description":"The amount of items to return with each page (default: 200, max: 500)","default":200}},{"name":"q","in":"query","schema":{"type":"object","description":"Filter and sort query. (Filterable attributes: `id,name,status,description,due_date,assigned_user_id`). Visit our [filtering docs](/reference/filtering) for more information about how filtering works.","example":{"id_eq":"id filter"},"default":{}},"style":"deepObject","explode":true},{"name":"launch_id","in":"path","required":true,"description":"Launch ID","schema":{"type":"string"}}],"tags":["Tasks"],"description":"Returns a list of all Tasks associated with the specified Launch.","security":[{"bearer":[]}],"responses":{"200":{"description":"lists tasks","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/LaunchChecklistItemIndex"},"required":["items"]},"paging":{"$ref":"#/components/schemas/Pagination"}},"required":["results","paging"]}}}},"401":{"description":"authentication failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"post":{"summary":"Create Task","tags":["Tasks"],"description":"Creates a new Task associated with a specified Launch Checklist Section.","security":[{"bearer":[]}],"parameters":[{"name":"launch_id","in":"path","required":true,"description":"Launch ID","schema":{"type":"string"}}],"responses":{"201":{"description":"create successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LaunchChecklistItemShow"}}}},"400":{"description":"invalid request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorWithAttrs"}}}},"401":{"description":"authentication failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"checklist section not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LaunchChecklistItemCreateRequest"},"examples":{"task":{"summary":"Creates a task","value":{"name":"Product early access","description":"Product early access","due_date":"2022-01-01","status":"to_do","checklist_section_id":1,"assigned_user_id":1}}}}},"required":true}}},"/api/v2/launches/{launch_id}/tasks/{id}":{"get":{"summary":"Get Task","tags":["Tasks"],"description":"Returns the specified Task.","security":[{"bearer":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"Task ID","schema":{"type":"string"}},{"name":"launch_id","in":"path","required":true,"description":"Launch ID","schema":{"type":"string"}}],"responses":{"200":{"description":"show task","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LaunchChecklistItemShow"}}}},"401":{"description":"authentication failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"task not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"patch":{"summary":"Update Task","tags":["Tasks"],"description":"Updates the specified Task.","security":[{"bearer":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"Task ID","schema":{"type":"string"}},{"name":"launch_id","in":"path","required":true,"description":"Launch ID","schema":{"type":"string"}}],"responses":{"204":{"description":"update successful"},"400":{"description":"invalid request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorWithAttrs"}}}},"401":{"description":"authentication failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"task not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LaunchChecklistItemUpdate"},"examples":{"task":{"summary":"Updates a task","value":{"name":"Product early access","description":"Product early access","due_date":"2022-01-01","status":"to_do","checklist_section_id":1,"assigned_user_id":1}}}}},"required":true}},"delete":{"summary":"Delete Task","tags":["Tasks"],"description":"Deletes the specified Task.","security":[{"bearer":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"Task ID","schema":{"type":"string"}},{"name":"launch_id","in":"path","required":true,"description":"Launch ID","schema":{"type":"string"}}],"responses":{"204":{"description":"delete successful"},"401":{"description":"authentication failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"task not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/api/v2/launches/{launch_id}/checklist_sections":{"get":{"summary":"Get Checklist Sections","parameters":[{"name":"page","in":"query","schema":{"type":"integer","description":"Indicates which page number to retrieve (based on a given page size)","default":1}},{"name":"page_size","in":"query","schema":{"type":"integer","description":"The amount of items to return with each page (default: 200, max: 500)","default":200}},{"name":"q","in":"query","schema":{"type":"object","description":"Filter and sort query. (Filterable attributes: `id,name`). Visit our [filtering docs](/reference/filtering) for more information about how filtering works.","example":{"id_eq":"id filter"},"default":{}},"style":"deepObject","explode":true},{"name":"launch_id","in":"path","required":true,"description":"Launch ID","schema":{"type":"string"}}],"tags":["Checklist Sections"],"description":"Returns a list of all the Launch's Checklist Sections.","security":[{"bearer":[]}],"responses":{"200":{"description":"lists launch checklists","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/LaunchChecklistIndex"},"required":["items"]},"paging":{"$ref":"#/components/schemas/Pagination"}},"required":["results","paging"]}}}},"401":{"description":"authentication failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"post":{"summary":"Create Checklist Section","tags":["Checklist Sections"],"description":"Creates a new Launch Checklist Section.","security":[{"bearer":[]}],"parameters":[{"name":"launch_id","in":"path","required":true,"description":"Launch ID","schema":{"type":"string"}}],"responses":{"201":{"description":"create successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LaunchChecklistShow"}}}},"400":{"description":"create failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorWithAttrs"}}}},"401":{"description":"authentication failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LaunchChecklistCreateRequest"},"examples":{"checklist section":{"summary":"Creates a launch checklist section","value":{"name":"Product early access"}}}}},"required":true}}},"/api/v2/launches/{launch_id}/checklist_sections/{id}":{"get":{"summary":"Get Checklist Section","tags":["Checklist Sections"],"description":"Returns the specified Launch Checklist Section.","security":[{"bearer":[]}],"parameters":[{"name":"launch_id","in":"path","required":true,"description":"Launch ID","schema":{"type":"string"}},{"name":"id","in":"path","required":true,"description":"Launch Checklist ID","schema":{"type":"string"}}],"responses":{"200":{"description":"show launch checklist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LaunchChecklistShow"}}}},"401":{"description":"authentication failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"launch not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"patch":{"summary":"Update Checklist Section","tags":["Checklist Sections"],"description":"Updates the specified Launch Checklist Section.","security":[{"bearer":[]}],"parameters":[{"name":"launch_id","in":"path","required":true,"description":"Launch ID","schema":{"type":"string"}},{"name":"id","in":"path","required":true,"description":"Launch Checklist ID","schema":{"type":"string"}}],"responses":{"204":{"description":"update successful"},"400":{"description":"bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorWithAttrs"}}}},"401":{"description":"authentication failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LaunchChecklistUpdate"},"examples":{"launch_checklist":{"summary":"Updates a launch checklist section.","value":{"name":"Product early access"}}}}}}},"delete":{"summary":"Delete Checklist Section","tags":["Checklist Sections"],"description":"Deletes the specified Launch Checklist Section.","security":[{"bearer":[]}],"parameters":[{"name":"launch_id","in":"path","required":true,"description":"Launch ID","schema":{"type":"string"}},{"name":"id","in":"path","required":true,"description":"Launch Checklist ID","schema":{"type":"string"}}],"responses":{"204":{"description":"delete successful"},"401":{"description":"authentication failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"task not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/api/v2/launches":{"get":{"summary":"Get Launches","parameters":[{"name":"page","in":"query","schema":{"type":"integer","description":"Indicates which page number to retrieve (based on a given page size)","default":1}},{"name":"page_size","in":"query","schema":{"type":"integer","description":"The amount of items to return with each page (default: 200, max: 500)","default":200}},{"name":"q","in":"query","schema":{"type":"object","description":"Filter and sort query. (Filterable attributes: `id,name,description,launch_date,status,user_id`). Visit our [filtering docs](/reference/filtering) for more information about how filtering works.","example":{"id_eq":"id filter"},"default":{}},"style":"deepObject","explode":true}],"tags":["Launches"],"description":"Returns a list of all Launches.","security":[{"bearer":[]}],"responses":{"200":{"description":"lists launches","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/LaunchIndex"},"required":["items"]},"paging":{"$ref":"#/components/schemas/Pagination"}},"required":["results","paging"]}}}},"401":{"description":"authentication failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"post":{"summary":"Create Launch","tags":["Launches"],"description":"Creates a new Launch.","security":[{"bearer":[]}],"parameters":[],"responses":{"201":{"description":"create successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LaunchShow"}}}},"400":{"description":"create failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorWithAttrs"}}}},"401":{"description":"authentication failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LaunchCreateRequest"},"examples":{"launch":{"summary":"Creates a launch","value":{"name":"Product early access","description":"Product early access","launch_date":"2022-01-01","status":"low_risk"}}}}},"required":true}}},"/api/v2/launches/{id}":{"get":{"summary":"Get Launch","tags":["Launches"],"description":"Returns the specified Launch.","security":[{"bearer":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"Launch ID","schema":{"type":"string"}}],"responses":{"200":{"description":"show launch","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LaunchShow"}}}},"401":{"description":"authentication failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"launch not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"patch":{"summary":"Update Launch","tags":["Launches"],"description":"Updates the specified Launch.","security":[{"bearer":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"Launch ID","schema":{"type":"string"}}],"responses":{"204":{"description":"update successful"},"400":{"description":"bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"authentication failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LaunchUpdate"},"examples":{"launch":{"summary":"Updates a launch","value":{"name":"Product early access","description":"Product early access","launch_date":"2022-01-01","status":"low_risk"}}}}}}},"delete":{"summary":"Delete Launch","tags":["Launches"],"description":"Deletes the specified Launch.","security":[{"bearer":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"Launch ID","schema":{"type":"string"}}],"responses":{"204":{"description":"delete launch"},"401":{"description":"authentication failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"launch not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/api/v2/bars/{bar_id}/links":{"get":{"summary":"Get Bar Links","parameters":[{"name":"page","in":"query","schema":{"type":"integer","description":"Indicates which page number to retrieve (based on a given page size)","default":1}},{"name":"page_size","in":"query","schema":{"type":"integer","description":"The amount of items to return with each page (default: 200, max: 500)","default":200}},{"name":"bar_id","in":"path","required":true,"schema":{"type":"integer"}}],"tags":["Bars"],"description":"Returns a list of all Links for the specified Bar.","security":[{"bearer":[]}],"responses":{"200":{"description":"lists links","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/LinkIndex"},"required":["items"]},"paging":{"$ref":"#/components/schemas/Pagination"}},"required":["results","paging"]}}}},"401":{"description":"authentication failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"bar not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"bad pagination parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"post":{"summary":"Create Bar Link","tags":["Bars"],"description":"Creates a new Link for the specified Bar.","security":[{"bearer":[]}],"parameters":[{"name":"bar_id","in":"path","required":true,"schema":{"type":"integer"}}],"responses":{"201":{"description":"link successfully created"},"401":{"description":"authentication failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"bar not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LinkCreate"},"examples":{"link":{"summary":"Creates a link with a name and url","value":{"name":"Map to Monkey Island","url":"https://guybrushmaps.com"}}}}},"required":true}}},"/api/v2/bars/{bar_id}/links/{id}":{"delete":{"summary":"Delete Bar Link","tags":["Bars"],"description":"Deletes the specified Link.","security":[{"bearer":[]}],"parameters":[{"name":"bar_id","in":"path","required":true,"schema":{"type":"integer"}},{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"responses":{"204":{"description":"link successfully deleted"},"401":{"description":"authentication failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/api/v2/roadmaps/{roadmap_id}/milestones":{"get":{"summary":"Get Roadmap Milestones","tags":["Roadmaps"],"description":"Returns a list of all Milestones for the specified Roadmap.","security":[{"bearer":[]}],"parameters":[{"name":"roadmap_id","in":"path","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"lists milestones","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/MilestoneRead"},"required":["items"]},"paging":{"$ref":"#/components/schemas/Pagination"}},"required":["results","paging"]}}}},"401":{"description":"authentication failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"roadmap not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"post":{"summary":"Create Roadmap Milestone","tags":["Roadmaps"],"description":"Creates a new Milestone to the specified Roadmap.","security":[{"bearer":[]}],"parameters":[{"name":"roadmap_id","in":"path","required":true,"schema":{"type":"integer"}}],"responses":{"201":{"description":"milestone successfully created"},"401":{"description":"authentication failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"roadmap not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MilestoneCreate"},"examples":{"milestone":{"summary":"Creates a milestone with a title and date","value":{"title":"Arrived at Monkey Island","date":"2024-09-24"}}}}},"required":true}}},"/api/v2/roadmaps/{roadmap_id}/milestones/{id}":{"patch":{"summary":"Update Roadmap Milestone","tags":["Roadmaps"],"description":"Updates a specific Milestone in a specific Roadmap.","security":[{"bearer":[]}],"parameters":[{"name":"roadmap_id","in":"path","required":true,"schema":{"type":"integer"}},{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"responses":{"204":{"description":"milestone successfully updated"},"400":{"description":"invalid lane id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"authentication failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MilestoneRead"}}},"required":true}},"delete":{"summary":"Delete Roadmap Milestone","tags":["Roadmaps"],"description":"Deletes a specific Milestone in a specific Roadmap.","security":[{"bearer":[]}],"parameters":[{"name":"roadmap_id","in":"path","required":true,"schema":{"type":"integer"}},{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"responses":{"204":{"description":"milestone successfully deleted"},"401":{"description":"authentication failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"roadmap not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/api/v2/roadmaps":{"get":{"summary":"Get Roadmaps","parameters":[{"name":"page","in":"query","schema":{"type":"integer","description":"Indicates which page number to retrieve (based on a given page size)","default":1}},{"name":"page_size","in":"query","schema":{"type":"integer","description":"The amount of items to return with each page (default: 200, max: 500)","default":200}},{"name":"q","in":"query","schema":{"type":"object","description":"Filter and sort query. (Filterable attributes: `id,name,is_version,created_at,updated_at`). Visit our [filtering docs](/reference/filtering) for more information about how filtering works.","example":{"name_eq":"name filter"},"default":{"is_version_eq":false}},"style":"deepObject","explode":true},{"name":"exclude_shared","in":"query","schema":{"type":"boolean","description":"Whether or not to exclude roadmaps that have been shared with the authenticated user (i.e. only show owned roadmaps). Defaults to false.","default":false,"example":false}},{"name":"edit_only","in":"query","schema":{"type":"boolean","description":"Whether or not to only show roadmaps that the authenticated user can edit. Defaults to false.","default":false,"example":false}}],"tags":["Roadmaps"],"description":"Returns a list of all Roadmaps accessible by the authenticated user. By default, it does not return versions. You can change this behavior by modifying the filtering (`q`) parameter.","security":[{"bearer":[]}],"responses":{"200":{"description":"lists roadmaps","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/RoadmapRead"},"required":["items"]},"paging":{"$ref":"#/components/schemas/Pagination"}},"required":["results","paging"]}}}},"401":{"description":"authentication failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/api/v2/roadmaps/{id}":{"get":{"summary":"Get Roadmap","tags":["Roadmaps"],"description":"Returns the specified Roadmap.","security":[{"bearer":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"roadmap found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RoadmapRead"}}}},"401":{"description":"authentication failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"roadmap not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/api/v2/roadmaps/{id}/bars":{"get":{"summary":"Get Roadmap Bars","parameters":[{"name":"page","in":"query","schema":{"type":"integer","description":"Indicates which page number to retrieve (based on a given page size)","default":1}},{"name":"page_size","in":"query","schema":{"type":"integer","description":"The amount of items to return with each page (default: 200, max: 500)","default":200}},{"name":"q","in":"query","schema":{"type":"object","description":"Filter and sort query. (Filterable attributes: `id,name,starts_on,ends_on,is_container,created_at,updated_at`). Visit our [filtering docs](/reference/filtering) for more information about how filtering works.","example":{"name_eq":"name filter"},"default":{}},"style":"deepObject","explode":true},{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"tags":["Roadmaps"],"description":"Returns a list of all Bars for the specified Roadmap.","security":[{"bearer":[]}],"responses":{"200":{"description":"lists roadmap bars","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/BarRead"},"required":["items"]},"paging":{"$ref":"#/components/schemas/Pagination"}},"required":["results","paging"]}}}},"401":{"description":"authentication failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"roadmap not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"bad pagination parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/api/v2/roadmaps/{id}/comments":{"get":{"summary":"Get Roadmap Comments","parameters":[{"name":"page","in":"query","schema":{"type":"integer","description":"Indicates which page number to retrieve (based on a given page size)","default":1}},{"name":"page_size","in":"query","schema":{"type":"integer","description":"The amount of items to return with each page (default: 200, max: 500)","default":200}},{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"tags":["Roadmaps"],"description":"Returns a list of all Comments for the specified Roadmap.","security":[{"bearer":[]}],"responses":{"200":{"description":"lists roadmap comments","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/CommentRead"},"required":["items"]},"paging":{"$ref":"#/components/schemas/Pagination"}},"required":["results","paging"]}}}},"401":{"description":"authentication failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"roadmap not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"bad pagination parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/api/v2/status":{"get":{"summary":"Reports application status","description":"Provides a simple _ping_ to let you know if the application is up and running.","tags":["Status"],"security":[{},{"bearer":[]}],"responses":{"200":{"description":"Application is up","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Status"}}}}}}},"/api/v2/strategy/objectives/{objective_id}/key_results":{"get":{"summary":"Get Key Results","parameters":[{"name":"page","in":"query","schema":{"type":"integer","description":"Indicates which page number to retrieve (based on a given page size)","default":1}},{"name":"page_size","in":"query","schema":{"type":"integer","description":"The amount of items to return with each page (default: 200, max: 500)","default":200}},{"name":"q","in":"query","schema":{"type":"object","description":"Filter and sort query. (Filterable attributes: `id,description,start,target,current,type`). Visit our [filtering docs](/reference/filtering) for more information about how filtering works.","example":{"id_eq":"id filter"},"default":{}},"style":"deepObject","explode":true},{"name":"objective_id","in":"path","required":true,"description":"Objective ID","schema":{"type":"string"}}],"tags":["Key Results"],"description":"Returns a list of all Key Results associated with the specified objective.","security":[{"bearer":[]}],"responses":{"200":{"description":"lists key results","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/KeyResultIndex"},"required":["items"]},"paging":{"$ref":"#/components/schemas/Pagination"}},"required":["results","paging"]}}}},"401":{"description":"authentication failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"post":{"summary":"Create Key Result","tags":["Key Results"],"description":"Creates a new Key Result.","security":[{"bearer":[]}],"parameters":[{"name":"objective_id","in":"path","required":true,"description":"Objective ID","schema":{"type":"string"}}],"responses":{"201":{"description":"create successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KeyResultShow"}}}},"400":{"description":"validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorWithAttrs"}}}},"401":{"description":"authorization failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KeyResultCreateRequest"},"examples":{"key_result":{"summary":"Creates a key result","value":{"description":"This is the key result title","start":0,"target":100,"type":"PercentResult"}}}}},"required":true}}},"/api/v2/strategy/objectives/{objective_id}/key_results/{id}":{"get":{"summary":"Get Key Result","tags":["Key Results"],"description":"Returns the specified Key Result.","security":[{"bearer":[]}],"parameters":[{"name":"objective_id","in":"path","required":true,"description":"Objective ID","schema":{"type":"string"}},{"name":"id","in":"path","required":true,"description":"Key Result ID","schema":{"type":"string"}}],"responses":{"200":{"description":"shows key result","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KeyResultShow"}}}},"401":{"description":"authorization failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"objective not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"patch":{"summary":"Update Key Result","tags":["Key Results"],"description":"Updates the specified Key Result.","security":[{"bearer":[]}],"parameters":[{"name":"objective_id","in":"path","required":true,"description":"Objective ID","schema":{"type":"string"}},{"name":"id","in":"path","required":true,"description":"Key Result ID","schema":{"type":"string"}}],"responses":{"204":{"description":"update successful"},"401":{"description":"authorization failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KeyResultUpdate"}}}}},"delete":{"summary":"Delete Key result","tags":["Key Results"],"description":"Deletes the specified Key Result.","security":[{"bearer":[]}],"parameters":[{"name":"objective_id","in":"path","required":true,"description":"Objective ID","schema":{"type":"string"}},{"name":"id","in":"path","required":true,"description":"Key Result ID","schema":{"type":"string"}}],"responses":{"204":{"description":"delete successful"},"401":{"description":"authorization failed"},"404":{"description":"not found"}}}},"/api/v2/strategy/objectives":{"get":{"summary":"Get Objectives","parameters":[{"name":"page","in":"query","schema":{"type":"integer","description":"Indicates which page number to retrieve (based on a given page size)","default":1}},{"name":"page_size","in":"query","schema":{"type":"integer","description":"The amount of items to return with each page (default: 200, max: 500)","default":200}},{"name":"q","in":"query","schema":{"type":"object","description":"Filter and sort query. (Filterable attributes: `id,label_id,label_name,label_description,label_position,label_created_at,label_updated_at`). Visit our [filtering docs](/reference/filtering) for more information about how filtering works.","example":{"id_eq":"id filter"},"default":{}},"style":"deepObject","explode":true}],"tags":["Objectives"],"description":"Returns a list of all Objectives accessible by the authenticated user.","security":[{"bearer":[]}],"responses":{"200":{"description":"lists objectives","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/ObjectiveIndex"},"required":["items"]},"paging":{"$ref":"#/components/schemas/Pagination"}},"required":["results","paging"]}}}},"401":{"description":"authentication failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"post":{"summary":"Create Objective","tags":["Objectives"],"description":"Creates a new Objective.","security":[{"bearer":[]}],"parameters":[],"responses":{"201":{"description":"create successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ObjectiveShow"}}}},"400":{"description":"validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorWithAttrs"}}}},"401":{"description":"authorization failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ObjectiveCreateRequest"},"examples":{"objective":{"summary":"Creates an objective with a name and description","value":{"name":"Find the Excalibur","description":"I want to find the sword so I can become the King of Camelot","team_ids":[1,2]}}}}},"required":true}}},"/api/v2/strategy/objectives/{id}":{"get":{"summary":"Get Objective","tags":["Objectives"],"description":"Returns the specified Objective.","security":[{"bearer":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"objective found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ObjectiveShow"}}}},"401":{"description":"authorization failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"objective not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"patch":{"summary":"Update Objective","tags":["Objectives"],"description":"Updates the specified Objective.","security":[{"bearer":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"responses":{"204":{"description":"update successful"},"400":{"description":"validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorWithAttrs"}}}},"401":{"description":"authorization failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ObjectiveUpdate"},"examples":{"objective":{"summary":"Updates an objective with a name and description","value":{"name":"Found the Excalibur","description":"I can become the King of Camelot!","team_ids":[1,2]}}}}}}},"delete":{"summary":"Delete Objective","tags":["Objectives"],"description":"Deletes the specified Objective.","security":[{"bearer":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"responses":{"204":{"description":"delete successful"},"401":{"description":"authorization failed"},"404":{"description":"not found"}}}},"/api/v2/teams":{"get":{"summary":"Gets all teams","parameters":[{"name":"page","in":"query","schema":{"type":"integer","description":"Indicates which page number to retrieve (based on a given page size)","default":1}},{"name":"page_size","in":"query","schema":{"type":"integer","description":"The amount of items to return with each page (default: 200, max: 500)","default":200}},{"name":"q","in":"query","schema":{"type":"object","description":"Filter and sort query. (Filterable attributes: `id,name`). Visit our [filtering docs](/reference/filtering) for more information about how filtering works.","example":{"name_eq":"name filter"},"default":{}},"style":"deepObject","explode":true}],"tags":["Teams"],"description":"Returns a list of all teams associated to the account of the authenticated user.","security":[{"bearer":[]}],"responses":{"200":{"description":"lists teams","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/TeamIndex"},"required":["items"]},"paging":{"$ref":"#/components/schemas/Pagination"}},"required":["results","paging"]}}}},"401":{"description":"authorization failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/api/v2/users":{"get":{"summary":"Gets all users that belong to the account","parameters":[{"name":"page","in":"query","schema":{"type":"integer","description":"Indicates which page number to retrieve (based on a given page size)","default":1}},{"name":"page_size","in":"query","schema":{"type":"integer","description":"The amount of items to return with each page (default: 200, max: 500)","default":200}},{"name":"q","in":"query","schema":{"type":"object","description":"Filter and sort query. (Filterable attributes: `id,name,email,phone_number,status,ref_source,created_at`). Visit our [filtering docs](/reference/filtering) for more information about how filtering works.","example":{"name_eq":"name filter"},"default":{}},"style":"deepObject","explode":true}],"tags":["Users"],"description":"Returns a list of all users that belong to the account.","security":[{"bearer":[]}],"responses":{"200":{"description":"lists users","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/UserShow"},"required":["items"]},"paging":{"$ref":"#/components/schemas/Pagination"}},"required":["results","paging"]}}}},"401":{"description":"authorization failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}}},"tags":[{"name":"Roadmaps"},{"name":"Bars"},{"name":"Opportunities"},{"name":"Ideas"},{"name":"Idea Forms"},{"name":"Objectives"},{"name":"Key Results"},{"name":"Launches"},{"name":"Checklist Sections"},{"name":"Tasks"},{"name":"Users"},{"name":"Teams"},{"name":"Status"}],"servers":[{"url":"https://{defaultHost}","variables":{"defaultHost":{"default":"app.productplan.com"}}}],"components":{"schemas":{"BarCreate":{"type":"object","properties":{"name":{"type":"string","description":"Title of the bar.","example":"Sail to Monkey Island"},"description":{"type":"string","nullable":true,"description":"In-depth explanation of what the bar represents.","example":"Board the Sea Monkey and find a way to get to Monkey Island."},"starts_on":{"type":"string","format":"date","nullable":true,"description":"Date for which work associated with the bar is to begin."},"ends_on":{"type":"string","format":"date","nullable":true,"description":"Date for which work associated with the bar is to end."},"strategic_value":{"type":"string","nullable":true,"description":"Why this bar is important.","example":"Discover what the Secret is all about"},"notes":{"type":"string","nullable":true,"description":"Additional information to be shared.","example":"Make sure we bring a rubber chicken with a pulley in the middle"},"percent_done":{"type":"integer","nullable":true,"minimum":0,"maximum":100,"description":"Determines the shading of the bar to indicate progress. Null is fully saturated. 0-100 displays a gradual shading until fully saturated.","example":20},"tags":{"type":"array","items":{"type":"string"},"description":"Keywords and terms associated with the bar.","example":["sail","adventure"]},"lane":{"type":"string","nullable":true,"description":"The lane assigned to the bar."},"legend":{"type":"string","nullable":true,"description":"The legend assigned to the bar."},"custom_text_fields":{"type":"array","items":{"$ref":"#/components/schemas/CustomField"}},"custom_dropdown_fields":{"type":"array","items":{"$ref":"#/components/schemas/CustomField"}},"is_container":{"type":"boolean","description":"Whether or not this bar is a container","example":false},"parked":{"type":"boolean","description":"Whether or not this bar is parked","example":true,"default":true},"container_bar_id":{"type":"integer","description":"Bar ID of the container to which we want to add the bar.","example":1},"roadmap_id":{"type":"integer","description":"Id of the roadmap to which we want to add the bar","example":1}},"required":["name","roadmap_id"],"additionalProperties":false},"BarRead":{"type":"object","properties":{"id":{"type":"integer","description":"The bar's unique database identifier.","example":1},"name":{"type":"string","description":"Title of the bar.","example":"Sail to Monkey Island"},"description":{"type":"string","nullable":true,"description":"In-depth explanation of what the bar represents.","example":"Board the Sea Monkey and find a way to get to Monkey Island."},"roadmap":{"type":"object","nullable":true,"description":"Related roadmap resource, to which the bar belongs.","$ref":"#/components/schemas/RoadmapReference"},"starts_on":{"type":"string","format":"date","nullable":true,"description":"Date for which work associated with the bar is to begin."},"ends_on":{"type":"string","format":"date","nullable":true,"description":"Date for which work associated with the bar is to end."},"strategic_value":{"type":"string","nullable":true,"description":"Why this bar is important.","example":"Discover what the Secret is all about"},"notes":{"type":"string","nullable":true,"description":"Additional information to be shared.","example":"Make sure we bring a rubber chicken with a pulley in the middle"},"percent_done":{"type":"integer","nullable":true,"minimum":0,"maximum":100,"description":"Determines the shading of the bar to indicate progress. Null is fully saturated. 0-100 displays a gradual shading until fully saturated.","example":20},"tags":{"type":"array","items":{"type":"string"},"description":"Keywords and terms associated with the bar.","example":["sail","adventure"]},"lane":{"type":"string","nullable":true,"description":"The lane assigned to the bar."},"legend":{"type":"string","nullable":true,"description":"The legend assigned to the bar."},"custom_text_fields":{"type":"array","items":{"$ref":"#/components/schemas/CustomField"}},"custom_dropdown_fields":{"type":"array","items":{"$ref":"#/components/schemas/CustomField"}},"url":{"type":"string","description":"URL to view the bar in a browser.","example":"https://app.productplan.com/bars/1"},"is_container":{"type":"boolean","description":"Whether or not this bar is a container","example":false},"parent":{"type":"object","nullable":true,"description":"Container of the bar.","$ref":"#/components/schemas/BarReference"},"parked":{"type":"boolean","description":"Whether or not this bar is parked","example":true,"default":true},"created_at":{"type":"string","format":"date-time","description":"Date and time the bar was first created."},"updated_at":{"type":"string","format":"date-time","description":"Date and time the bar was last updated."},"child_bar_count":{"type":"integer","description":"The number of child bars associated with the container.","example":2},"comment_count":{"type":"integer","description":"The number of comments associated with the bar.","example":3},"link_count":{"type":"integer","description":"The number of links associated with the bar.","example":1},"requires_connection_count":{"type":"integer","description":"The number of requires connections associated with the bar.","example":1},"required_by_connection_count":{"type":"integer","description":"The number of required by connections associated with the bar.","example":1}},"required":["id","name","description","roadmap","starts_on","ends_on","strategic_value","notes","percent_done","tags","lane","legend","custom_text_fields","custom_dropdown_fields","url","is_container","parent","parked","created_at","updated_at","child_bar_count","comment_count","link_count","requires_connection_count","required_by_connection_count"],"additionalProperties":false},"BarReference":{"type":"object","properties":{"id":{"type":"integer","description":"The bar's unique database identifier.","example":1},"name":{"type":"string","description":"Title of the bar.","example":"Sail to Monkey Island"},"url":{"type":"string","description":"URL to view the bar in a browser.","example":"https://app.productplan.com/bars/1"},"api_path":{"type":"string","description":"API path for the bar.","example":"/api/v2/bars/1"}},"required":["id","name","url","api_path"],"additionalProperties":false},"BarUpdate":{"type":"object","properties":{"name":{"type":"string","description":"Title of the bar.","example":"Sail to Monkey Island"},"description":{"type":"string","nullable":true,"description":"In-depth explanation of what the bar represents.","example":"Board the Sea Monkey and find a way to get to Monkey Island."},"starts_on":{"type":"string","format":"date","nullable":true,"description":"Date for which work associated with the bar is to begin."},"ends_on":{"type":"string","format":"date","nullable":true,"description":"Date for which work associated with the bar is to end."},"strategic_value":{"type":"string","nullable":true,"description":"Why this bar is important.","example":"Discover what the Secret is all about"},"notes":{"type":"string","nullable":true,"description":"Additional information to be shared.","example":"Make sure we bring a rubber chicken with a pulley in the middle"},"percent_done":{"type":"integer","nullable":true,"minimum":0,"maximum":100,"description":"Determines the shading of the bar to indicate progress. Null is fully saturated. 0-100 displays a gradual shading until fully saturated.","example":20},"tags":{"type":"array","items":{"type":"string"},"description":"Keywords and terms associated with the bar.","example":["sail","adventure"]},"lane":{"type":"string","nullable":true,"description":"The lane assigned to the bar."},"legend":{"type":"string","nullable":true,"description":"The legend assigned to the bar."},"custom_text_fields":{"type":"array","items":{"$ref":"#/components/schemas/CustomField"}},"custom_dropdown_fields":{"type":"array","items":{"$ref":"#/components/schemas/CustomField"}},"is_container":{"type":"boolean","description":"Whether or not this bar is a container","example":false},"parked":{"type":"boolean","description":"Whether or not this bar is parked","example":true,"default":true},"container_bar_id":{"type":"integer","description":"Bar ID of the container to which we want to add the bar.","example":1}},"additionalProperties":false},"CommentRead":{"type":"object","properties":{"id":{"type":"integer","description":"The comment's unique database identifier.","example":1},"bar":{"type":"object","nullable":true,"description":"Related bar resource, to which the comment belongs.","$ref":"#/components/schemas/BarReference"},"roadmap":{"type":"object","nullable":true,"description":"Related roadmap resource, to which the comment's bar belongs.","$ref":"#/components/schemas/RoadmapReference"},"body":{"type":"string","description":"Contents of the comment","example":"This is a really awesome idea!"},"owner":{"type":"object","nullable":true,"description":"The user who commented.","$ref":"#/components/schemas/UserShow"},"created_at":{"type":"string","format":"date-time","description":"Date and time the comment was first created."},"updated_at":{"type":"string","format":"date-time","description":"Date and time the comment was last updated."}},"required":["id","bar","roadmap","body","owner","created_at","updated_at"],"additionalProperties":false},"ConnectionCreate":{"type":"object","properties":{"required_by":{"type":"integer","description":"The ID of the bar that requires the bar being connected. Either this or 'requires' fields should be present, but not both.","example":2},"requires":{"type":"integer","description":"The ID of the bar that is required by the bar being connected. Either this or 'required_by' fields should be present, but not both.","example":1}},"additionalProperties":false},"CustomField":{"type":"object","properties":{"label":{"type":"string","description":"The field's label","example":"Ship name"},"value":{"type":"string","nullable":true,"description":"Value assigned to the field","example":"Sea Monkey"}},"required":["label","value"],"additionalProperties":false},"IdeaCreateRequest":{"type":"object","properties":{"name":{"type":"string","description":"Title of the Idea.","example":"Sail to Monkey Island"},"description":{"type":"string"},"customer":{"type":"string","description":"The customer associated to the Idea.","nullable":true},"source_name":{"type":"string","description":"The name of the account that created the Idea.","nullable":true},"source_email":{"type":"string","description":"The email of the account that created the Idea.","nullable":true},"location_status":{"type":"string","enum":["visible","archived"],"description":"Status that defines whether an Idea is shown in the default visible list or the archived list (defaults to visible).","example":"visible"},"tags":{"type":"array","items":{"type":"string"},"description":"Keywords that are associated with the Idea.","example":["sail","adventure"]},"opportunity_ids":{"type":"array","description":"A list of ids corresponding to opportunities.","example":[1,2,3]},"team_ids":{"type":"array","items":{"type":"integer"},"description":"A list of team IDs that are associated with this Idea.","example":[1,2,3]},"custom_text_fields":{"type":"array","items":{"$ref":"#/components/schemas/CustomField"}},"custom_dropdown_fields":{"type":"array","items":{"$ref":"#/components/schemas/CustomField"}},"idea_form_id":{"type":"integer","description":"Idea Form identifier.","example":123,"nullable":true}},"required":["name","description","source_name","source_email"],"additionalProperties":false},"IdeaCustomFieldValue":{"type":"object","properties":{"label":{"type":"string","description":"The field's label","example":"Ship name"}},"required":["label"],"additionalProperties":false},"IdeaCustomLabelGroup":{"type":"object","properties":{"label":{"type":"string","description":"The field's label","example":"Ship name"},"allowed_values":{"type":"array","description":"The allowed values for the field","example":["Sea Monkey","Sea Cucumber"]}},"required":["label","allowed_values"],"additionalProperties":false},"IdeaFormIndex":{"type":"object","properties":{"id":{"type":"integer","description":"The Idea Form's unique database identifier.","example":1},"title":{"type":"string","description":"Title of the Idea Form.","example":"Feedback of new admin process"},"instructions":{"type":"string","description":"Instructions of the Idea Form.","example":"Please fill with your feedback"},"is_enabled":{"type":"boolean","description":"Defines availability of the Idea Form to incoming new ideas","example":true,"default":true},"created_at":{"type":"string","format":"date-time","description":"Date and time the Idea Form was first created."},"updated_at":{"type":"string","format":"date-time","description":"Date and time the Idea Form was last updated."},"custom_text_fields":{"type":"array","items":{"$ref":"#/components/schemas/IdeaCustomFieldValue"}},"custom_dropdown_fields":{"type":"array","items":{"$ref":"#/components/schemas/IdeaCustomLabelGroup"}}},"additionalProperties":false},"IdeaFormShow":{"type":"object","properties":{"id":{"type":"integer","description":"The Idea Form's unique database identifier.","example":1},"title":{"type":"string","description":"Title of the Idea Form.","example":"Feedback of new admin process"},"instructions":{"type":"string","description":"Instructions of the Idea Form.","example":"Please fill with your feedback"},"is_enabled":{"type":"boolean","description":"Defines availability of the Idea Form to incoming new ideas","example":true,"default":true},"created_at":{"type":"string","format":"date-time","description":"Date and time the Idea Form was first created."},"updated_at":{"type":"string","format":"date-time","description":"Date and time the Idea Form was last updated."},"custom_text_fields":{"type":"array","items":{"$ref":"#/components/schemas/IdeaCustomFieldValue"}},"custom_dropdown_fields":{"type":"array","items":{"$ref":"#/components/schemas/IdeaCustomLabelGroup"}}},"additionalProperties":false},"IdeaIndex":{"type":"object","properties":{"id":{"type":"integer","description":"The Ideas's unique database identifier.","example":1},"name":{"type":"string","description":"Title of the Idea.","example":"Sail to Monkey Island"},"description":{"type":"string"},"channel":{"type":"string","nullable":true},"customer":{"type":"string","description":"The customer associated to the Idea.","nullable":true},"opportunities_count":{"type":"integer","description":"The number of opportunities associated to the Idea.","example":1},"source_name":{"type":"string","description":"The name of the account that created the Idea.","nullable":true},"source_email":{"type":"string","description":"The email of the account that created the Idea.","nullable":true},"location_status":{"type":"string","enum":["visible","archived"],"description":"Status that defines whether an Idea is shown in the default visible list or the archived list (defaults to visible).","example":"visible"},"tags":{"type":"array","items":{"type":"string"},"description":"Keywords that are associated with the Idea.","example":["sail","adventure"]},"team_ids":{"type":"array","items":{"type":"integer"},"description":"A list of team IDs that are associated with this Idea.","example":[1,2,3]},"custom_text_fields":{"type":"array","items":{"$ref":"#/components/schemas/CustomField"}},"custom_dropdown_fields":{"type":"array","items":{"$ref":"#/components/schemas/CustomField"}},"idea_form_id":{"type":"integer","description":"The identifier of the Idea Form used to submit the Idea.","example":123,"nullable":true}},"additionalProperties":false},"IdeaShow":{"type":"object","properties":{"id":{"type":"integer","description":"The Ideas's unique database identifier.","example":1},"name":{"type":"string","description":"Title of the Idea.","example":"Sail to Monkey Island"},"description":{"type":"string"},"channel":{"type":"string","nullable":true},"customer":{"type":"string","description":"The customer associated to the Idea.","nullable":true},"opportunities_count":{"type":"integer","description":"The number of opportunities associated to the Idea.","example":1},"source_name":{"type":"string","description":"The name of the account that created the Idea.","nullable":true},"source_email":{"type":"string","description":"The email of the account that created the Idea.","nullable":true},"location_status":{"type":"string","enum":["visible","archived"],"description":"Status that defines whether an Idea is shown in the default visible list or the archived list (defaults to visible).","example":"visible"},"tags":{"type":"array","items":{"type":"string"},"description":"Keywords that are associated with the Idea.","example":["sail","adventure"]},"created_at":{"type":"string","format":"date-time","description":"Date and time (UTC) the Idea was first created."},"updated_at":{"type":"string","format":"date-time","description":"Date and time (UTC) the Idea was last updated."},"opportunity_ids":{"type":"array","description":"A list of ids corresponding to opportunities.","example":[1,2,3]},"team_ids":{"type":"array","items":{"type":"integer"},"description":"A list of team IDs that are associated with this Idea.","example":[1,2,3]},"custom_text_fields":{"type":"array","items":{"$ref":"#/components/schemas/CustomField"}},"custom_dropdown_fields":{"type":"array","items":{"$ref":"#/components/schemas/CustomField"}},"idea_form_id":{"type":"integer","description":"The identifier of the Idea Form used to submit the Idea.","example":123,"nullable":true}},"required":["id","name","description","channel","customer","opportunities_count","source_name","source_email","location_status","tags","created_at","updated_at","opportunity_ids","team_ids","custom_text_fields","custom_dropdown_fields","idea_form_id"],"additionalProperties":false},"IdeaUpdate":{"type":"object","properties":{"name":{"type":"string","description":"Title of the Idea.","example":"Sail to Monkey Island"},"description":{"type":"string"},"customer":{"type":"string","description":"The customer associated to the Idea.","nullable":true},"source_name":{"type":"string","description":"The name of the account that created the Idea.","nullable":true},"source_email":{"type":"string","description":"The email of the account that created the Idea.","nullable":true},"location_status":{"type":"string","enum":["visible","archived"],"description":"Status that defines whether an Idea is shown in the default visible list or the archived list (defaults to visible).","example":"visible"},"tags":{"type":"array","items":{"type":"string"},"description":"Keywords that are associated with the Idea.","example":["sail","adventure"]},"opportunity_ids":{"type":"array","description":"A list of ids corresponding to opportunities.","example":[1,2,3]},"team_ids":{"type":"array","items":{"type":"integer"},"description":"A list of team IDs that are associated with this Idea.","example":[1,2,3]},"custom_text_fields":{"type":"array","items":{"$ref":"#/components/schemas/CustomField"}},"custom_dropdown_fields":{"type":"array","items":{"$ref":"#/components/schemas/CustomField"}}},"additionalProperties":false},"OpportunityCreateRequest":{"type":"object","properties":{"problem_statement":{"type":"string","description":"A descriptive name for a business Opportunity.","example":"Product early access"},"workflow_status":{"type":"string","enum":["draft","in_discovery","validated","invalidated","completed"],"description":"Current state of the Opportunity (defaults to draft)."},"location_status":{"type":"string","enum":["visible","archived"],"description":"Status that defines whether an Opportunity is shown in the default visible list or the archived list (defaults to visible)."},"description":{"type":"string","description":"Additional details supporting the problem statement.","example":"Product early access","nullable":true},"user_id":{"type":"integer","description":"The user that this Opportunity should belong to (defaults to the creator).","nullable":true},"bar_ids":{"type":"array","description":"A list of bar IDs that are associated with this Opportunity."},"idea_ids":{"type":"array","description":"A list of idea IDs that are associated with this Opportunity."},"team_ids":{"type":"array","items":{"type":"integer"},"description":"A list of team IDs that are associated with this Opportunity."},"objective_ids":{"type":"array","items":{"type":"integer"},"description":"A list of objective IDs that are associated with this Opportunity."}},"required":["problem_statement"],"additionalProperties":false},"OpportunityIndex":{"type":"object","properties":{"id":{"type":"integer","description":"The Opportunity's unique database identifier.","example":1},"problem_statement":{"type":"string","description":"A descriptive name for a business Opportunity.","example":"Product early access"},"workflow_status":{"type":"string","enum":["draft","in_discovery","validated","invalidated","completed"],"description":"Current state of the Opportunity (defaults to draft)."},"location_status":{"type":"string","enum":["visible","archived"],"description":"Status that defines whether an Opportunity is shown in the default visible list or the archived list (defaults to visible)."},"description":{"type":"string","description":"Additional details supporting the problem statement.","example":"Product early access","nullable":true},"user_id":{"type":"integer","description":"The user that this Opportunity should belong to (defaults to the creator).","nullable":true},"ideas_count":{"type":"integer","description":"The number of ideas associated with this Opportunity."},"bars_count":{"type":"integer","description":"The number of bars associated with this Opportunity."},"team_ids":{"type":"array","items":{"type":"integer"},"description":"A list of team IDs that are associated with this Opportunity."},"objective_count":{"type":"integer","description":"The number of objectives associated with the Opportunity.","example":2}},"required":["id","problem_statement","workflow_status","location_status","description","user_id","ideas_count","bars_count","team_ids","objective_count"],"additionalProperties":false},"OpportunityShow":{"type":"object","properties":{"id":{"type":"integer","description":"The Opportunity's unique database identifier.","example":1},"problem_statement":{"type":"string","description":"A descriptive name for a business Opportunity.","example":"Product early access"},"workflow_status":{"type":"string","enum":["draft","in_discovery","validated","invalidated","completed"],"description":"Current state of the Opportunity (defaults to draft)."},"location_status":{"type":"string","enum":["visible","archived"],"description":"Status that defines whether an Opportunity is shown in the default visible list or the archived list (defaults to visible)."},"description":{"type":"string","description":"Additional details supporting the problem statement.","example":"Product early access","nullable":true},"user_id":{"type":"integer","description":"The user that this Opportunity should belong to (defaults to the creator).","nullable":true},"ideas_count":{"type":"integer","description":"The number of ideas associated with this Opportunity."},"bars_count":{"type":"integer","description":"The number of bars associated with this Opportunity."},"bar_ids":{"type":"array","description":"A list of bar IDs that are associated with this Opportunity."},"idea_ids":{"type":"array","description":"A list of idea IDs that are associated with this Opportunity."},"team_ids":{"type":"array","items":{"type":"integer"},"description":"A list of team IDs that are associated with this Opportunity."},"objective_ids":{"type":"array","items":{"type":"integer"},"description":"A list of objective IDs that are associated with this Opportunity."},"created_at":{"type":"string","format":"date-time","description":"Date and time (UTC) the Opportunity was first created."},"updated_at":{"type":"string","format":"date-time","description":"Date and time (UTC) the Opportunity was last updated."}},"required":["id","problem_statement","workflow_status","location_status","description","user_id","ideas_count","bars_count","bar_ids","idea_ids","team_ids","objective_ids","created_at","updated_at"],"additionalProperties":false},"OpportunityUpdate":{"type":"object","properties":{"problem_statement":{"type":"string","description":"A descriptive name for a business Opportunity.","example":"Product early access"},"workflow_status":{"type":"string","enum":["draft","in_discovery","validated","invalidated","completed"],"description":"Current state of the Opportunity (defaults to draft)."},"location_status":{"type":"string","enum":["visible","archived"],"description":"Status that defines whether an Opportunity is shown in the default visible list or the archived list (defaults to visible)."},"description":{"type":"string","description":"Additional details supporting the problem statement.","example":"Product early access","nullable":true},"user_id":{"type":"integer","description":"The user that this Opportunity should belong to (defaults to the creator).","nullable":true},"bar_ids":{"type":"array","description":"A list of bar IDs that are associated with this Opportunity."},"idea_ids":{"type":"array","description":"A list of idea IDs that are associated with this Opportunity."},"team_ids":{"type":"array","items":{"type":"integer"},"description":"A list of team IDs that are associated with this Opportunity."},"objective_ids":{"type":"array","items":{"type":"integer"},"description":"A list of objective IDs that are associated with this Opportunity."}},"additionalProperties":false},"Error":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}},"required":["errors"],"additionalProperties":false},"ErrorWithAttrs":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"attribute":{"type":"string"},"message":{"type":"string"}}}}},"additionalProperties":false},"LaneCreate":{"type":"object","properties":{"name":{"type":"string","description":"Name of the lane.","example":"Lane Sail to Monkey Island"},"description":{"type":"string","nullable":true,"description":"In-depth explanation of what the lane represents.","example":"Board the Sea Monkey and find a way to get to Monkey Island."},"position":{"type":"integer","description":"Position of the lane in the roadmap.","example":1}},"required":["name"],"additionalProperties":false},"LaneRead":{"type":"object","properties":{"id":{"type":"integer","description":"The lane's unique database identifier.","example":1},"name":{"type":"string","description":"Name of the lane.","example":"Lane Sail to Monkey Island"},"description":{"type":"string","nullable":true,"description":"In-depth explanation of what the lane represents.","example":"Board the Sea Monkey and find a way to get to Monkey Island."},"position":{"type":"integer","description":"Position of the lane in the roadmap.","example":1},"created_at":{"type":"string","format":"date-time","description":"Date and time the lane was first created."},"updated_at":{"type":"string","format":"date-time","description":"Date and time the lane was last updated."}},"required":["id","name","description","position","created_at","updated_at"],"additionalProperties":false},"LaunchChecklistCreateRequest":{"type":"object","properties":{"name":{"type":"string","description":"The name of the Checklist Section.","example":"Become a Mighty Pirate"}},"required":["name"],"additionalProperties":false},"LaunchChecklistIndex":{"type":"object","properties":{"id":{"type":"integer","description":"The Checklist Section's unique database identifier.","example":1},"name":{"type":"string","description":"The name of the Checklist Section.","example":"Become a Mighty Pirate"},"task_count":{"type":"integer","description":"The number of tasks connected to the Checklist Section.","example":3}},"required":["id","name","task_count"],"additionalProperties":false},"LaunchChecklistItemCreateRequest":{"type":"object","properties":{"name":{"type":"string","description":"The name of the Task.","example":"Product early access"},"status":{"type":"string","enum":["to_do","in_progress","completed","blocked"],"description":"The status of the Task. Defaults to \"to_do\".","example":"to_do","nullable":true},"description":{"type":"string","description":"The description of the Task.","example":"Product early access","nullable":true},"due_date":{"type":"string","format":"date","description":"The due date of the Task.","nullable":true},"assigned_user_id":{"type":"integer","description":"The ID of the user assigned as the Task owner's. Assignment requires share permissions on the associated Launch.","example":1,"nullable":true},"checklist_section_id":{"type":"integer","description":"The unique ID of the Checklist Section that the Task is assigned to.","example":1}},"required":["name","owner_id"],"additionalProperties":false},"LaunchChecklistItemIndex":{"type":"object","properties":{"id":{"type":"integer","description":"The Task's unique database identifier.","example":1},"name":{"type":"string","description":"The name of the Task.","example":"Product early access"},"status":{"type":"string","enum":["to_do","in_progress","completed","blocked"],"description":"The status of the Task.","example":"completed"},"description":{"type":"string","description":"The description of the Task.","example":"Product early access","nullable":true},"due_date":{"type":"string","format":"date","description":"The due date of the Task.","nullable":true},"assigned_user_id":{"type":"integer","description":"The ID of the user assigned as the Task owner's. Assignment requires share permissions on the associated Launch.","example":1,"nullable":true},"checklist_section_id":{"type":"integer","description":"The unique ID of the Checklist Section that the Task is assigned to.","example":1}},"required":["id","name","status","description","due_date","assigned_user_id","checklist_section_id"],"additionalProperties":false},"LaunchChecklistItemShow":{"type":"object","properties":{"id":{"type":"integer","description":"The Task's unique database identifier.","example":1},"name":{"type":"string","description":"The name of the Task.","example":"Product early access"},"status":{"type":"string","enum":["to_do","in_progress","completed","blocked"],"description":"The status of the Task.","example":"completed"},"description":{"type":"string","description":"The description of the Task.","example":"Product early access","nullable":true},"due_date":{"type":"string","format":"date","description":"The due date of the Task.","nullable":true},"assigned_user_id":{"type":"integer","description":"The ID of the user assigned as the Task owner's. Assignment requires share permissions on the associated Launch.","example":1,"nullable":true},"checklist_section_id":{"type":"integer","description":"The unique ID of the Checklist Section that the Task is assigned to.","example":1},"created_at":{"type":"string","format":"date-time","description":"Date and time (UTC) the Task was first created."},"updated_at":{"type":"string","format":"date-time","description":"Date and time (UTC) the Task was last updated."}},"required":["id","name","status","description","due_date","assigned_user_id","checklist_section_id","created_at","updated_at"],"additionalProperties":false},"LaunchChecklistItemUpdate":{"type":"object","properties":{"name":{"type":"string","description":"The name of the Task.","example":"Product early access"},"status":{"type":"string","enum":["to_do","in_progress","completed","blocked"],"description":"The status of the Task.","example":"completed"},"description":{"type":"string","description":"The description of the Task.","example":"Product early access","nullable":true},"due_date":{"type":"string","format":"date","description":"The due date of the Task.","nullable":true},"assigned_user_id":{"type":"integer","description":"The ID of the user assigned as the Task owner's. Assignment requires share permissions on the associated Launch.","example":1,"nullable":true},"checklist_section_id":{"type":"integer","description":"The unique ID of the Checklist Section that the Task is assigned to.","example":1}},"additionalProperties":false},"LaunchChecklistShow":{"type":"object","properties":{"id":{"type":"integer","description":"The Checklist Section's unique database identifier.","example":1},"name":{"type":"string","description":"The name of the Checklist Section.","example":"Become a Mighty Pirate"},"created_at":{"type":"string","format":"date-time","description":"Date and time (UTC) the Checklist Section was first created."},"updated_at":{"type":"string","format":"date-time","description":"Date and time (UTC) the Checklist Section was last updated."},"launch_id":{"type":"integer","description":"The Launch ID that the Checklist Section is associated to.","example":1},"task_ids":{"type":"array","items":{"type":"integer"},"description":"The unique database identifiers of the tasks connected to the Checklist Section.","example":[1,2,3]}},"required":["id","name","created_at","updated_at","launch_id","task_ids"],"additionalProperties":false},"LaunchChecklistUpdate":{"type":"object","properties":{"name":{"type":"string","description":"The name of the Checklist Section.","example":"Become a Mighty Pirate"}},"additionalProperties":false},"LaunchCreateRequest":{"type":"object","properties":{"name":{"type":"string","description":"The name of the Launch.","example":"Product early access"},"description":{"type":"string","description":"The description of the Launch.","example":"Product early access","nullable":true},"launch_date":{"type":"string","format":"date","description":"The date the Launch is scheduled to occur. Must be in YYYY-MM-DD format. If no value is provided it defaults to today's date.","nullable":true},"status":{"type":"string","description":"The status of the Launch.","example":"Low Risk","enum":["low_risk","medium_risk","high_risk","launched"],"nullable":true},"bar_ids":{"type":"array","items":{"type":"integer"},"description":"The unique database identifiers of the bars connected to the Launch.","example":[1,2,3]},"team_ids":{"type":"array","items":{"type":"integer"},"description":"A list of team IDs that are associated with this Launch.","example":[1,2,3]}},"required":["name"],"additionalProperties":false},"LaunchIndex":{"type":"object","properties":{"id":{"type":"integer","description":"The Launch's unique database identifier.","example":1},"name":{"type":"string","description":"The name of the Launch.","example":"Product early access"},"description":{"type":"string","description":"The description of the Launch.","example":"Product early access","nullable":true},"launch_date":{"type":"string","format":"date","description":"The date the Launch is scheduled to occur."},"status":{"type":"string","description":"The status of the Launch.","example":"Low Risk","enum":["low_risk","medium_risk","high_risk","launched"],"nullable":true},"progress":{"type":"integer","description":"Progress indicates the percentage of tasks assigned a completed status vs the total tasks assigned to a Launch.","example":50,"nullable":true},"user_id":{"type":"integer","description":"The id of the user who owns the Launch. Defaults to the user who created the Launch.","example":1},"team_ids":{"type":"array","items":{"type":"integer"},"description":"A list of team IDs that are associated with this Launch.","example":[1,2,3]},"bar_count":{"type":"integer","description":"The number of Bars connected to the Launch.","example":3},"checklist_section_count":{"type":"integer","description":"The number of Checklist Sections connected to the Launch.","example":3},"task_count":{"type":"integer","description":"The number of Tasks connected to the Launch.","example":3}},"required":["id","name","description","launch_date","status","progress","user_id","team_ids","bar_count","checklist_section_count","task_count"],"additionalProperties":false},"LaunchShow":{"type":"object","properties":{"id":{"type":"integer","description":"The Launch's unique database identifier.","example":1},"name":{"type":"string","description":"The name of the Launch.","example":"Product early access"},"description":{"type":"string","description":"The description of the Launch.","example":"Product early access","nullable":true},"launch_date":{"type":"string","format":"date","description":"The date the Launch is scheduled to occur."},"status":{"type":"string","description":"The status of the Launch.","example":"Low Risk","enum":["low_risk","medium_risk","high_risk","launched"],"nullable":true},"progress":{"type":"integer","description":"Progress indicates the percentage of tasks assigned a completed status vs the total tasks assigned to a Launch.","example":50,"nullable":true},"user_id":{"type":"integer","description":"The id of the user who owns the Launch. Defaults to the user who created the Launch.","example":1},"checklist_section_ids":{"type":"array","items":{"type":"integer"},"description":"The unique database identifiers of the Checklist Sections connected to the Launch.","example":[1,2,3]},"task_ids":{"type":"array","items":{"type":"integer"},"description":"The unique database identifiers of the Tasks connected to the Launch.","example":[1,2,3]},"bar_ids":{"type":"array","items":{"type":"integer"},"description":"The unique database identifiers of the bars connected to the Launch.","example":[1,2,3]},"team_ids":{"type":"array","items":{"type":"integer"},"description":"A list of team IDs that are associated with this Launch.","example":[1,2,3]},"created_at":{"type":"string","format":"date-time","description":"Date and time (UTC) the Launch was first created."},"updated_at":{"type":"string","format":"date-time","description":"Date and time (UTC) the Launch was last updated."}},"required":["id","name","description","launch_date","status","progress","user_id","checklist_section_ids","task_ids","bar_ids","team_ids","created_at","updated_at"],"additionalProperties":false},"LaunchUpdate":{"type":"object","properties":{"name":{"type":"string","description":"The name of the Launch.","example":"Product early access"},"description":{"type":"string","description":"The description of the Launch.","example":"Product early access","nullable":true},"launch_date":{"type":"string","format":"date","description":"The date the Launch is scheduled to occur. Must be in YYYY-MM-DD format. If no value is provided it defaults to today's date.","nullable":true},"status":{"type":"string","description":"The status of the Launch.","example":"Low Risk","enum":["low_risk","medium_risk","high_risk","launched"],"nullable":true},"bar_ids":{"type":"array","items":{"type":"integer"},"description":"The unique database identifiers of the bars connected to the Launch.","example":[1,2,3]},"team_ids":{"type":"array","items":{"type":"integer"},"description":"A list of team IDs that are associated with this Launch.","example":[1,2,3]}},"additionalProperties":false},"LinkCreate":{"type":"object","properties":{"name":{"type":"string","description":"Title of the link.","example":"User Test Cases"},"url":{"type":"string","format":"uri","description":"href to the resource.","example":"https://acme.atlassian.net/browse/UTC-27"}},"required":["name","url"],"additionalProperties":false},"LinkIndex":{"type":"object","properties":{"id":{"type":"integer","description":"The link's unique database identifier.","example":1},"bar":{"type":"object","description":"Related bar resource, to which the link belongs.","$ref":"#/components/schemas/BarReference"},"type":{"type":"string","enum":["web","jira","ado","trello","github"],"description":"Type of the linked resource.","example":"jira"},"name":{"type":"string","description":"Title of the link.","example":"User Test Cases"},"url":{"type":"string","format":"uri","description":"href to the resource.","example":"https://acme.atlassian.net/browse/UTC-27"},"created_at":{"type":"string","format":"date-time","description":"Date and time the link was first created."},"updated_at":{"type":"string","format":"date-time","description":"Date and time the link was last updated."}},"required":["id","bar","type","name","url","created_at","updated_at"],"additionalProperties":false},"MilestoneCreate":{"type":"object","properties":{"title":{"type":"string","description":"Name of the miletone.","example":"Sailed to Monkey Island!"},"description":{"type":"string","nullable":true,"description":"In-depth explanation of what the milestone represents.","example":"Completed course to Monkey Island."},"date":{"type":"string","format":"date","nullable":true,"description":"Date for which the milestone is to be completed."},"expanded":{"type":"boolean","description":"Whether or not this milestone is expanded."},"lane":{"type":"string","nullable":true,"description":"The lane where the milestone is located."}},"required":["title","date"],"additionalProperties":false},"MilestoneRead":{"type":"object","properties":{"id":{"type":"integer","description":"The milestone's unique database identifier.","example":1},"title":{"type":"string","description":"Name of the miletone.","example":"Sailed to Monkey Island!"},"description":{"type":"string","nullable":true,"description":"In-depth explanation of what the milestone represents.","example":"Completed course to Monkey Island."},"date":{"type":"string","format":"date","nullable":true,"description":"Date for which the milestone is to be completed."},"expanded":{"type":"boolean","description":"Whether or not this milestone is expanded."},"location_type":{"type":"string","description":"Type of location associated with the milestone.","example":"Roadmap"},"location_name":{"type":"string","nullable":true,"description":"The lane or roadmap assigned to the milestone."},"created_at":{"type":"string","format":"date-time","description":"Date and time the milestone was first created."},"updated_at":{"type":"string","format":"date-time","description":"Date and time the milestone was last updated."}},"required":["id","title","description","date","expanded","location_type","location_name","created_at","updated_at"],"additionalProperties":false},"MilestoneUpdate":{"type":"object","properties":{"title":{"type":"string","description":"Name of the miletone.","example":"Sailed to Monkey Island!"},"description":{"type":"string","nullable":true,"description":"In-depth explanation of what the milestone represents.","example":"Completed course to Monkey Island."},"date":{"type":"string","format":"date","nullable":true,"description":"Date for which the milestone is to be completed."},"expanded":{"type":"boolean","description":"Whether or not this milestone is expanded."},"lane":{"type":"string","nullable":true,"description":"The lane where the milestone is located."}},"additionalProperties":false},"Pagination":{"type":"object","properties":{"record_count":{"type":"integer","description":"The total number of elements existing in the collection (pre-paging)"},"page_count":{"type":"integer","description":"The total number of pages"},"current_page":{"type":"integer","description":"The current page"},"page_size":{"type":"integer","description":"The number of elements returned in the current page"}},"required":["record_count","page_count","current_page","page_size"],"additionalProperties":false},"RoadmapRead":{"type":"object","properties":{"id":{"type":"integer","description":"The roadmap's unique database identifier.","example":1},"name":{"type":"string","description":"Title of the roadmap.","example":"Adventures of Guybrush Threepwood"},"description":{"type":"string","nullable":true,"description":"In-depth explanation of what the roadmap represents."},"owner":{"type":"object","nullable":true,"description":"The owner of the roadmap.","$ref":"#/components/schemas/UserShow"},"permission":{"type":"string","enum":["owner","editor","viewer"],"description":"The level of permission that the current user has with the roadmap."},"legends":{"type":"array","items":{"type":"string"},"description":"Available legend values for bar's on the roadmap."},"lanes":{"type":"array","items":{"type":"string"},"description":"Available lane values for bar's on the roadmap."},"custom_text_fields":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string","description":"Label applied to the field"}},"required":["label"]}},"custom_dropdown_fields":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string","description":"Label applied to the field"},"allowed_values":{"type":"array","items":{"type":"string"},"description":"Allowed values for the dropdown field"}},"required":["label","allowed_values"]}},"url":{"type":"string","description":"URL to view the roadmap in a browser","example":"https://app.productplan.com/roadmaps/1"},"is_version":{"type":"boolean","description":"Whether or not the roadmap is a version","example":false},"created_at":{"type":"string","format":"date-time","description":"Date and time the roadmap was first created."},"updated_at":{"type":"string","format":"date-time","description":"Date and time the roadmap was last updated."}},"required":["id","name","description","owner","permission","legends","lanes","custom_text_fields","custom_dropdown_fields","url","is_version","created_at","updated_at"],"additionalProperties":false},"RoadmapReference":{"type":"object","properties":{"id":{"type":"integer","description":"The roadmap's unique database identifier.","example":1},"name":{"type":"string","description":"Title of the roadmap.","example":"Adventures of Guybrush Threepwood"},"url":{"type":"string","description":"URL to view the roadmap in a browser.","example":"https://app.productplan.com/roadmaps/1"},"api_path":{"type":"string","description":"API path for the roadmap.","example":"/api/v2/roadmaps/1"}},"required":["id","name","url","api_path"],"additionalProperties":false},"Status":{"type":"object","properties":{"application":{"type":"string","example":"ProductPlan API"},"version":{"type":"integer","example":2},"generated_at":{"type":"string","format":"date-time"},"status":{"type":"object","properties":{"application":{"type":"string","example":"up","enum":["up","down"]},"database":{"type":"string","example":"up","enum":["up","down"]}},"required":["application","database"]},"user":{"type":"object","properties":{"name":{"type":"string","example":"Guybrush Threepwood","nullable":true},"email":{"type":"string","example":"guybrush@threepwood.test","nullable":true}},"required":["name","email"]}},"required":["application","version","generated_at","status","user"],"additionalProperties":false},"KeyResultCreateRequest":{"type":"object","properties":{"description":{"type":"string","description":"The description of the Key Result.","example":"Product early access","nullable":true},"start":{"type":"number","format":"float","description":"The starting value of the Key Result.","example":1.1},"target":{"type":"number","format":"float","description":"The target value of the Key Result.","example":1.1},"type":{"type":"string","description":"The type of the Key Result.","example":"NumberResult","enum":["PercentResult","MoneyResult","NumberResult"]}},"required":["description","start","target"],"additionalProperties":false},"KeyResultIndex":{"type":"object","properties":{"id":{"type":"integer","description":"The Key Result's unique database identifier.","example":1},"description":{"type":"string","description":"The description of the Key Result.","example":"Product early access","nullable":true},"start":{"type":"number","format":"float","description":"The starting value of the Key Result.","example":1.1},"target":{"type":"number","format":"float","description":"The target value of the Key Result.","example":1.1},"current":{"type":"number","format":"float","description":"The current value of the Key Result.","example":1.1},"progress":{"type":"integer","description":"The progress of the Key Result.","example":75},"type":{"type":"string","description":"The type of the Key Result.","example":"NumberResult","enum":["PercentResult","MoneyResult","NumberResult"]}},"required":["id","description","start","target","current","progress","type"],"additionalProperties":false},"KeyResultShow":{"type":"object","properties":{"id":{"type":"integer","description":"The Key Result's unique database identifier.","example":1},"description":{"type":"string","description":"The description of the Key Result.","example":"Product early access","nullable":true},"start":{"type":"number","format":"float","description":"The starting value of the Key Result.","example":1.1},"target":{"type":"number","format":"float","description":"The target value of the Key Result.","example":1.1},"current":{"type":"number","format":"float","description":"The current value of the Key Result.","example":1.1},"progress":{"type":"integer","description":"The progress of the Key Result.","example":75},"type":{"type":"string","description":"The type of the Key Result.","example":"NumberResult","enum":["PercentResult","MoneyResult","NumberResult"]},"created_at":{"type":"string","format":"date-time","description":"Date and time (UTC) the Key Result was first created."},"updated_at":{"type":"string","format":"date-time","description":"Date and time (UTC) the Key Result was last updated."}},"required":["id","description","start","target","current","progress","type","created_at","updated_at"],"additionalProperties":false},"KeyResultUpdate":{"type":"object","properties":{"description":{"type":"string","description":"The description of the Key Result.","example":"Product early access","nullable":true},"start":{"type":"number","format":"float","description":"The starting value of the Key Result.","example":1.1},"target":{"type":"number","format":"float","description":"The target value of the Key Result.","example":1.1},"current":{"type":"number","format":"float","description":"The current value of the Key Result.","example":1.1},"type":{"type":"string","description":"The type of the Key Result.","example":"NumberResult","enum":["PercentResult","MoneyResult","NumberResult"]}},"additionalProperties":false},"ObjectiveCreateRequest":{"type":"object","properties":{"name":{"type":"string","description":"The name of the Objective.","example":"Product early access"},"description":{"type":"string","description":"The description of the Objective.","example":"Product early access","nullable":true},"team_ids":{"type":"array","items":{"type":"integer"},"description":"A list of team IDs that are associated with this Objective.","example":[1,2,3]},"opportunity_ids":{"type":"array","items":{"type":"integer"},"description":"A list of opportunity IDs that are associated with this Objective.","example":[1,2,3]},"risk_status":{"type":"string","enum":["low_risk","medium_risk","high_risk"],"description":"Current Risk Status of the Objective.","nullable":true,"example":"low_risk"},"location_status":{"type":"string","enum":["active","archived"],"description":"Current Status of the Objective that defines whether or not the Objective is Archived or Active.","example":"archived"},"start_date":{"type":"string","format":"date-time","description":"Start date of the Objective.","nullable":true},"end_date":{"type":"string","format":"date-time","description":"End date of the Objective.","nullable":true}},"required":["name"],"additionalProperties":false},"ObjectiveIndex":{"type":"object","properties":{"id":{"type":"integer","description":"The Objective's unique database identifier.","example":1},"name":{"type":"string","description":"The name of the Objective.","example":"Product early access"},"description":{"type":"string","description":"The description of the Objective.","example":"Product early access","nullable":true},"subject":{"type":"string","description":"Whether this is a team or company objective.","example":"CompanyWide"},"team_ids":{"type":"array","items":{"type":"integer"},"description":"A list of team IDs that are associated with this Objective.","example":[1,2,3]},"risk_status":{"type":"string","enum":["low_risk","medium_risk","high_risk"],"description":"Current Risk Status of the Objective.","nullable":true,"example":"low_risk"},"location_status":{"type":"string","enum":["active","archived"],"description":"Current Status of the Objective that defines whether or not the Objective is Archived or Active.","example":"archived"},"start_date":{"type":"string","format":"date-time","description":"Start date of the Objective.","nullable":true},"end_date":{"type":"string","format":"date-time","description":"End date of the Objective.","nullable":true},"key_results_count":{"type":"integer","description":"The number of key results associated with the Objective.","example":2},"bar_count":{"type":"integer","description":"The number of bars associated with the Objective.","example":2},"opportunity_count":{"type":"integer","description":"The number of opportunities associated with the Objective.","example":2}},"required":["id","name","description","subject","team_ids","risk_status","location_status","key_results_count","bar_count","opportunity_count"],"additionalProperties":false},"ObjectiveShow":{"type":"object","properties":{"id":{"type":"integer","description":"The Objective's unique database identifier.","example":1},"name":{"type":"string","description":"The name of the Objective.","example":"Product early access"},"description":{"type":"string","description":"The description of the Objective.","example":"Product early access","nullable":true},"subject":{"type":"string","description":"Whether this is a team or company objective.","example":"CompanyWide"},"team_ids":{"type":"array","items":{"type":"integer"},"description":"A list of team IDs that are associated with this Objective.","example":[1,2,3]},"opportunity_ids":{"type":"array","items":{"type":"integer"},"description":"A list of opportunity IDs that are associated with this Objective.","example":[1,2,3]},"key_result_ids":{"type":"array","description":"The associated Key Results' unique database identifiers.","example":[1,2]},"bar_ids":{"type":"array","description":"The associated Bars' unique database identifiers.","example":[1,2]},"created_at":{"type":"string","format":"date-time","description":"Date and time (UTC) the Objective was first created."},"updated_at":{"type":"string","format":"date-time","description":"Date and time (UTC) the Objective was last updated."},"risk_status":{"type":"string","enum":["low_risk","medium_risk","high_risk"],"description":"Current Risk Status of the Objective.","nullable":true,"example":"low_risk"},"location_status":{"type":"string","enum":["active","archived"],"description":"Current Status of the Objective that defines whether or not the Objective is Archived or Active.","example":"archived"},"start_date":{"type":"string","format":"date-time","description":"Start date of the Objective.","nullable":true},"end_date":{"type":"string","format":"date-time","description":"End date of the Objective.","nullable":true}},"required":["id","name","description","subject","team_ids","opportunity_ids","key_result_ids","bar_ids","created_at","updated_at","risk_status","location_status"],"additionalProperties":false},"ObjectiveUpdate":{"type":"object","properties":{"name":{"type":"string","description":"The name of the Objective.","example":"Product early access"},"description":{"type":"string","description":"The description of the Objective.","example":"Product early access","nullable":true},"team_ids":{"type":"array","items":{"type":"integer"},"description":"A list of team IDs that are associated with this Objective.","example":[1,2,3]},"opportunity_ids":{"type":"array","items":{"type":"integer"},"description":"A list of opportunity IDs that are associated with this Objective.","example":[1,2,3]},"risk_status":{"type":"string","enum":["low_risk","medium_risk","high_risk"],"description":"Current Risk Status of the Objective.","nullable":true,"example":"low_risk"},"location_status":{"type":"string","enum":["active","archived"],"description":"Current Status of the Objective that defines whether or not the Objective is Archived or Active.","example":"archived"},"start_date":{"type":"string","format":"date-time","description":"Start date of the Objective.","nullable":true},"end_date":{"type":"string","format":"date-time","description":"End date of the Objective.","nullable":true}},"additionalProperties":false},"TeamIndex":{"type":"object","properties":{"id":{"type":"integer","description":"The team's unique database identifier.","example":1},"name":{"type":"string","description":"The team's name","example":"Team 1"}},"required":["id","name"],"additionalProperties":false},"UserShow":{"type":"object","properties":{"id":{"type":"integer","description":"The user's unique database identifier.","example":1},"name":{"type":"string","description":"The user's full name","example":"Guybrush Threepwood"},"email":{"type":"string","description":"The user's email address","example":"guybrush@threepwood.test"},"license_type":{"type":"string","enum":["editor","viewer"],"description":"The users license type","example":"editor"}},"required":["id","name","email","license_type"],"additionalProperties":false}},"securitySchemes":{"bearer":{"type":"http","scheme":"bearer"}}},"x-readme":{"explorer-enabled":true,"proxy-enabled":true}}