DevEx: API Platform (#200) · Epics · Epics · Developer Experience

DevEx: API Platform

This epic is the SSOT for ongoing and planned API Platform group work. Please find below the work that is currently in-progress. ## Hours Worked | Epic | Category | DRI | Total Hours | |------|----------|-----|-------------| | [API Platform - Business As Usual](https://gitlab.com/groups/gitlab-org/quality/-/epics/231) | ~"infra-category::KTLO" | @mwoolf | 0.0 | | [API - Security bug fixes](https://gitlab.com/groups/gitlab-org/quality/-/epics/260) | ~"infra-category::Tech Debt" | @pjphillips | 19.0  | | [Prevent REST Entity Exposure Growth](https://gitlab.com/groups/gitlab-org/-/epics/20829) | ~"infra-category::Internal Innovation" | @abignotti | 12.0  | | [OpenAPI Annotations - REST Endpoint Lifecycle](https://gitlab.com/groups/gitlab-org/quality/-/epics/316) | ~"infra-category::Customer Innovation" | @mwoolf | 14.0  | | [Deploy interactive documentation for OpenAPI v3.0 specification](https://gitlab.com/groups/gitlab-org/quality/-/epics/261) | ~"infra-category::Customer Innovation" | @cfeick | 20.0  | | [OpenAPI 3.0 Spec Bug Fixes/Polish required before Docs Launch](https://gitlab.com/groups/gitlab-org/quality/-/epics/285) | ~"infra-category::Tech Debt" | @abignotti @mwoolf @vwolanyk | 24.0  | | [Support all Grape keywords](https://gitlab.com/groups/gitlab-org/quality/-/epics/321) | ~"infra-category::Internal Innovation" | @abignotti @vwolanyk | 38.0  | ## Project Work ### :hourglass: Work In Progress These epics are currently in progress | **Topic** | **Start Date** | **Target End Date** | **Summary** | |-----------|----------------|---------------------|-------------| | [API Platform - Business As Usual](https://gitlab.com/groups/gitlab-org/quality/-/epics/231) @mwoolf (+0 participants) ~"group::api platform" | 2025-08-04 | 2026-06-05 | **2026-03-05**: No time spent on BAU this week. :clock1: **total hours spent this week by all contributors**: 0 :tada: **achievements**: - :issue-blocked: **blockers**: - :arrow_forward: **next**: - _Copied from https://gitlab.com/groups/gitlab-org/quality/-/epics/231#note_3132931665_  | | [API - Security bug fixes](https://gitlab.com/groups/gitlab-org/quality/-/epics/260) @pjphillips (+0 participants) ~"group::api platform" | 2025-09-01 | 2026-07-01 | **2026-03-05**: :clock1: **total hours spent this week by all contributors**: 19h _Copied from https://gitlab.com/groups/gitlab-org/quality/-/epics/260#note_3132931729_  **Nested Epics: 1** • https://gitlab.com/groups/gitlab-org/quality/-/epics/314+ | | [Prevent REST Entity Exposure Growth](https://gitlab.com/groups/gitlab-org/-/epics/20829) @abignotti (+0 participants) ~"group::api platform" | 2026-03-03 | 2026-03-27 | **2026-03-05**: :clock1: **total hours spent this week by all contributors**: 12 :tada: **achievements**: * Analyzed how many endpoints are affected by all REST API entities, and identified the high-impact ones. `UserBasic` for example affects 212 endpoints, and there are 41 entities affecting >= 15 endpoints. For more info: https://gitlab.com/gitlab-org/gitlab/-/merge_requests/225538 * Opened a MR that adds a RuboCop linter to trigger offenses when fields are added to those high-impact entities :issue-blocked: **blockers**: * :arrow_forward: **next**: * Receive feedback on the analysis from the rest of the team, merge the open MR, update the relevant documentation _Copied from https://gitlab.com/groups/gitlab-org/-/epics/20829#note_3134859395_  | | [OpenAPI Annotations - REST Endpoint Lifecycle](https://gitlab.com/groups/gitlab-org/quality/-/epics/316) @mwoolf (+0 participants) ~"group::api platform" | | 2026-03-19 | **2026-03-05**: Initial progress has begun on this epic with the OpenAPI conversion logic already merged. :clock1: **total hours spent this week by all contributors**: 14 :tada: **achievements**: - [Added support](https://gitlab.com/gitlab-org/gitlab/-/issues/587171) for API lifecycle declarations on REST API endpoints. - Started on linter to enforce API lifecycle values (`experiment`, `beta`, or `general_availability`). :issue-blocked: **blockers**: - Started a discussion about whether we _assume_ GA for non-annotated endpoints which will block https://gitlab.com/gitlab-org/gitlab/-/issues/591897 until decided. :arrow_forward: **next**: - Start work on frontend components to display lifecycle, and consider ways to improve developer experience to ensure all new endpoints have a lifecycle defined. _Copied from https://gitlab.com/groups/gitlab-org/quality/-/epics/316#note_3132931810_  | | [Deploy interactive documentation for OpenAPI v3.0 specification](https://gitlab.com/groups/gitlab-org/quality/-/epics/261) @cfeick (+0 participants) ~"group::api platform" | 2025-11-15 | 2026-03-11 | **2026-03-05**: :clock1: **total hours spent this week by all contributors**: 20 :tada: **achievements**: - With the [initial deployment](https://api-docs-a0ae81.gitlab.io/) of the API Docs [project](https://gitlab.com/gitlab-com/gl-infra/api-docs) completed, we started engagement with the Branding team on design direction and finalized remaining discussion points with the Technical Writing team on scope - This epic originally started as tool selection and prototyping, so description and issues will be cleaned up as initial foundation has been successfully laid down :issue-blocked: **blockers**: - N/A :arrow_forward: **next**: - Create new epic for production readiness - Begin remaining launch work based on branding feedback _Copied from https://gitlab.com/groups/gitlab-org/quality/-/epics/261#note_3132931897_  | | [OpenAPI 3.0 Spec Bug Fixes/Polish required before Docs Launch](https://gitlab.com/groups/gitlab-org/quality/-/epics/285) @abignotti @mwoolf @vwolanyk (+1 participants) ~"group::api platform" | 2025-11-19 | 2026-03-05 | **2026-03-05**: Focused on [validating the OpenAPI 3.0 specification](https://gitlab.com/gitlab-org/gitlab/-/work_items/591007) this week. :clock1: **total hours spent this week by all contributors**: 24 :tada: **achievements**: * Fixed all validation issues in the OpenAPI 3.0 specification, now the specification is valid according to Swagger CLI (the validator used for the OpenAPI 2.0 specification)! * Since [Swagger CLI has been deprecated](https://github.com/APIDevTools/swagger-cli#:~:text=%E2%9A%A0%EF%B8%8F,Won%27t%20Hate.), we [investigated other tooling to validate the OpenAPI 3.0 specification](https://gitlab.com/gitlab-org/gitlab/-/issues/591007#note_3131112870) and settled for Redocly CLI * We decided not to validate in `gitlab-org/gitlab`, since it could be a non-actionable issue for devs making changes that inadvertently break the OpenAPI 3.0 specification validation (more info [here](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/225252#note_3125408195)). Instead, we'll validate in [`gitlab-com/gl-infra/api-docs`](https://gitlab.com/gitlab-com/gl-infra/api-docs), the project that renders the interactive documentation for OpenAPI v3.0 specification :issue-blocked: **blockers**: * :arrow_forward: **next**: * Fix the validation issues that Redocly CLI finds (this tool is stricter than Swagger CLI, which is why we still have validation issues after having fixed all the ones Swagger CLI was flagging) _Copied from https://gitlab.com/groups/gitlab-org/quality/-/epics/285#note_3132931967_  | | [Support all Grape keywords](https://gitlab.com/groups/gitlab-org/quality/-/epics/321) @abignotti @vwolanyk (+0 participants) ~"group::api platform" | 2026-01-10 | 2026-03-31 | **2026-03-05**: :clock1: **total hours spent this week by all contributors**: 17 hours :tada: **achievements**: - closed out gitlab-org/gitlab#587241 - gitlab-org/gitlab#586866 should be merged by EOW - a few issues were assigned for learning purposes to mentees :issue-blocked: **blockers**: - security issues have been prioritized slowing some of the work on this epic, though there are no critical blockers to the release of the openAPI 3.0 docs :arrow_forward: **next**: - Continue work on the last of the issues in this epic _Copied from https://gitlab.com/groups/gitlab-org/quality/-/epics/321#note_3132932048_  | ### :stop_button: Triage Epics that are currently being triaged | **Topic** | **Summary** | |-----------|-------------| | [Establish API endpoint lifecycle policies](https://gitlab.com/groups/gitlab-org/quality/-/epics/269) ~"group::api platform" | | | [Enable API-First Development Through Enhanced Training and Documentation](https://gitlab.com/groups/gitlab-org/quality/-/epics/270) ~"group::api platform" | | | [Make OpenAPI 3.0 REST SSoT](https://gitlab.com/groups/gitlab-org/quality/-/epics/287) ~"group::api platform" | | ### :white_check_mark: Completed Work Items that have been completed <details> | **Topic** | **Started** | **Ended** | **Summary** | |-----------| ------------| ----------| ------------ | | [Create API team roadmap](https://gitlab.com/groups/gitlab-org/quality/-/epics/203) ~"group::api platform" | 2025-08-18 | 2025-09-24 | **2025-09-17**: Max and Chance presented the team and our roadmap at the Engineering All Hands, so I think we can consider this epic fully complete :tada: _Copied from https://gitlab.com/groups/gitlab-org/quality/-/epics/203#note_2756017387_  | | [REST API Style Enforcement for the benefit of OpenAPI enforcement](https://gitlab.com/groups/gitlab-org/quality/-/epics/233) ~"group::api platform" | 2025-09-13 | 2026-01-09 | **2026-01-07**: :clock1: **total hours spent this week by all contributors**: 0 :tada: **achievements**: * See [closing statement](https://gitlab.com/groups/gitlab-org/quality/-/epics/233#note_2984959726) _Copied from https://gitlab.com/groups/gitlab-org/quality/-/epics/233#note_2987487672_  | | [Implement OpenAPI 3.0 Spec Generation](https://gitlab.com/groups/gitlab-org/quality/-/epics/232) ~"group::api platform" | 2025-10-11 | 2025-11-21 | **2025-11-20**: :tada: **achievements**: This Epic can be closed, please see the [closing statement](https://gitlab.com/groups/gitlab-org/quality/-/epics/232#closing-statement)  | | [GraphQL Metadata Enforcement Initiative](https://gitlab.com/groups/gitlab-org/quality/-/epics/243) ~"group::api platform" | 2026-01-06 | 2026-01-26 | **2026-01-21**: :clock1: **total hours spent this week by all contributors**: 18 :tada: **achievements**: - @mwoolf wrote an uncharacteristically large amount of JavaScript this week. ([MR](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/218657)) - Once this MR is merged, we can close this epic and allow feature teams to backfill their own feature categories. - Filled in feature categories for the _most_ popular GraphQL queries. - Announced changes to engineering week-in-review. :issue-blocked: **blockers**: - None. :arrow_forward: **next**: - @mwoolf responding to frontend maintainer comments on the above MR. Merge it. Close the epic :tada: Update 2026-01-22: Engineering work nearing a close. New linting rules are enforced in the GitLab monolith and announcements across engineering have been very well received. | | [OpenAPI 3.0 Specification Generation and Validation](https://gitlab.com/groups/gitlab-org/quality/-/epics/284) ~"group::api platform" | 2026-01-12 | 2026-02-06 | **2026-02-04**: :clock1: **total hours spent this week by all contributors**: 2 :tada: **achievements**: * Completed the task! Added automated tooling (rake tasks ran in local linters and in CI jobs) in the GitLab project to trigger the generation and validation of the OpenAPI 3.0 specification :issue-blocked: **blockers**: * :arrow_forward: **next**: * Epic can be closed by our Grand Reviewers! _Copied from https://gitlab.com/groups/gitlab-org/quality/-/epics/284#note_3056319803_  | </details> ### :rotating_light: Epics that need attention These linked epics are not in the correct state or missing a workflow label <details> | **Topic** | **Links** | **Reason** | |-----------|-----------|-------------| | [OpenAPI 3](https://gitlab.com/groups/gitlab-org/quality/-/epics/218) (+0) group::api platform | Labeling problem, epic has no workflow label | | [API Platform tooling survey - FY26Q1](https://gitlab.com/groups/gitlab-org/quality/-/epics/352) (+0) | Labeling problem, epic has no workflow label | </details>

epic