Thanks to visit codestin.com
Credit goes to github.com

Skip to content

8.8 V2 API spec misaligned with released public docs version #39518

@tmetzke

Description

@tmetzke

Description

The V2 API spec for 8.8 between monorepository and public docs has diverged in more minor details.
This must be corrected to align our documentation release workflow and ensure the spec versions are consistent.

Steps to reproduce

  1. Open 8.8 monorepo spec
  2. Open 8.8 public docs spec
  3. Compare both specs

Current behavior

The specs are misaligned in some details, e.g., missing examples, a type clarification for an enum, and 415 response definitions.

Expected behavior

Both specs are aligned

Workaround

none

Environment

SaaS & SM

Version

  • Component Version: 8.8.0

Rootcause

The public docs spec is currently fed by the externally managed spec. The changes have not all been merged back to the monorepo.

Solution ideas

Align the changes back into the monorepo

Dev -> QA handover

No response

Links

No response

Automated Test Impact

No impact

Metadata

Metadata

Assignees

Labels

affects/8.8Issue is affecting 8.8 minor versionscomponent/c8-apiAll things unified C8 API, e.g. C8 RESTkind/bugCategorizes an issue or PR as a buglikelihood/highA recurring issueseverity/lowMarks a bug as having little to no noticeable impact for the userversion:8.8.1Label that represents issues released on version 8.8.1

Type

Projects

Status

Done

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions