USACE / USACE/cwms-data-api

Add servers to the swagger docs for use with openapi generators

Open
#587 0 comments 0 reactions 1 assignee View on GitHub

@krowvin is already working on this.

Since Mar 19, 2024.

priority:low
Dominant language
Java
Stars
28
Forks
25
Avg merge
4d 22h
Merged PRs (30d)
20

Description

While working on discussion #351 I had to add the servers to the swagger docs manually.

This is useful because it will default to these servers on the generators making it so users do not need to specify which server to use.
They can still do this manually and override the server.

My manual edit on the output is here

And the generated output with the servers in it here
The generator I used typescript-fetch pulled the first in the list in the above output.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.