Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Specs 1.1 and 1.2 lack a title for "Flow information" type #1000

Closed
DMRobertson opened this issue Mar 24, 2022 · 5 comments · Fixed by #1003
Closed

Specs 1.1 and 1.2 lack a title for "Flow information" type #1000

DMRobertson opened this issue Mar 24, 2022 · 5 comments · Fixed by #1003
Labels
aesthetic A suggestion or issue relating to the representation of the spec

Comments

@DMRobertson
Copy link
Contributor

Link to problem area: any request which may return user interactive auth flow information, e.g. here.

Issue: The description of a 401 response refers to a Flow information type. That type is described below, but without a <caption> making it hard to find.

diagnosis

Cause unclear, though I wonder if the space in Flow information is causing trouble.

@DMRobertson DMRobertson added the aesthetic A suggestion or issue relating to the representation of the spec label Mar 24, 2022
@DMRobertson DMRobertson changed the title Spec 1.2 lacks a <caption> for "Flow information" type Specs 1.1 and 1.2 lacks a <caption> for "Flow information" type Mar 24, 2022
@DMRobertson DMRobertson changed the title Specs 1.1 and 1.2 lacks a <caption> for "Flow information" type Specs 1.1 and 1.2 lack a <caption> for "Flow information" type Mar 24, 2022
@turt2live turt2live changed the title Specs 1.1 and 1.2 lack a <caption> for "Flow information" type Specs 1.1 and 1.2 lack a title for "Flow information" type Mar 24, 2022
@turt2live
Copy link
Member

this would be the OpenAPI title missing for the type, I believe.

@DMRobertson
Copy link
Contributor Author

AFAICS the title exists:

title: Authentication response
description: |-
Used by servers to indicate that additional authentication information is required,
type: object
properties:
flows:
description: A list of the login flows supported by the server for this API.
title: Flow information
type: array
items:
type: object
properties:
stages:
description: |-
The login type of each of the stages required to complete this
authentication flow
type: array
items:
type: string
example: "example.type.foo"
required:
- stages

@DMRobertson
Copy link
Contributor Author

Adding {{ printf "%#v" .title }} just before this line, I see that .title is <nil> when generating the table for Flow information.

@DMRobertson
Copy link
Contributor Author

Additional debugging: it looks like this call to get-additional-objects produces an additional object whose enum is nil.

{{ $additional_objects = partial "get-additional-objects" (dict "this_object" $property "additional_objects" $additional_objects) }}

@DMRobertson
Copy link
Contributor Author

Having dug through far too much hugo templating, I think I now see what the problem is: the title in the OpenAPI spec is misplaced.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
aesthetic A suggestion or issue relating to the representation of the spec
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants