Skip to content

JSV Root title and description #1030

@philsturgeon

Description

@philsturgeon

Describe the bug

The root of JSV is rather cluttered with information not entirely relevant in a HTTP Operation documentation context.

Summary

Let's make sure thee three scenarios have a root like these designs:

  • Array Body
  • Object Body
  • Root Combiner (anyOf/oneOf body)

image

Figma design: https://www.figma.com/file/IkNc59AU2JN5Kc1qbd2AiB/Elements?node-id=645%3A5074

MT: The only scenario I can think of that isn't covered above is the schema being a primitive. Let's figure out something reasonable for that.

Misc info

Let's remove the following:

  1. The caret next to the root object, the caret next to Body is enough
  2. The Title (the first "Installation" in this picture)
  3. The Description (the second "Installation" in this picture)
  4. One level of nesting. With the title gone, id and account in this image can move to the left where it was.

Currently an body containing an object looks like this:

image

Metadata

Metadata

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions