Skip to content

Return object schemas are descriptive so that generated clients are more user friendly #43

@telday

Description

@telday

Currently the requests which return a JSON object to the user are simply specified in the OpenAPI spec as returning an "object". For example the secrets endpoint has SecretBatchValue specified as the endpoint which only specifies that the value returned is a JSON object. We should expand this to actually describe the object that will be returned. This should make the generated clients more user friendly. A good example of a complete schema is HostFactoryTokenRequest.

AC:

  • All response schema are properly described
    • secrets file
    • policies file
    • roles file
    • host_factory_tokens file
    • resources file
    • authentication file
    • cert-auth file
    • public-keys file
    • status file
  • Each endpoint returning an object has a proper example included
    • secrets file
    • policies file
    • roles file
    • host_factory_tokens file
    • resources file
    • authentication file
    • cert-auth file
    • public-keys file
    • status file

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions