Skip to content

Update Web API documentation #981

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.

Sign up for GitHub

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

Jump to bottom
Open
drmathias wants to merge 9 commits into
base: release/1.6.0.0
Choose a base branch
from
Open

Update Web API documentation #981

drmathias wants to merge 9 commits into from

Conversation

@drmathias
Copy link
Contributor

@drmathias drmathias commented May 13, 2022 •
edited
Loading

  • Generate XML documentation for every feature
  • Utilise assembly scanning to generate OAS from XML documentation
  • Added Stratis Platform website URL and license to OAS
  • Concise summaries for controllers (OpenAPI tags)
  • Consistent path casing for routes
  • Request parameter descriptions
  • Response descriptions

Results:

image

@fassadlr fassadlr changed the base branch from release/1.4.0.0 to release/1.5.0.0 October 21, 2022 12:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@drmathias