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

document updates #2087

Open
wants to merge 2 commits into
base: dev
Choose a base branch
from
Open

document updates #2087

wants to merge 2 commits into from

Conversation

LetterN
Copy link

@LetterN LetterN commented Jan 19, 2025

🆑 REST API
Flatten class names.
Add dummy "example" data.
Add some basic description to the authentication methods.
/🆑

@LetterN LetterN requested a review from Cyberboss as a code owner January 19, 2025 09:47
Copy link
Member

@Cyberboss Cyberboss left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Bump the API and API library patch versions in build/Version.props

/// </summary>
/// <example>Ooopsie, we did a fucky wucky!</example>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oopsie woopsie*

Comment on lines +8 to 9
using System.Text.RegularExpressions;
using Microsoft.Extensions.DependencyInjection;
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Newline required between system and other usings

@Cyberboss Cyberboss added this to the v6.13.0 milestone Jan 19, 2025
@Cyberboss Cyberboss added Documentation Documentation updates REST The JSON REST API for server control labels Jan 19, 2025
@@ -493,7 +493,6 @@ public void Apply(OpenApiDocument swaggerDoc, DocumentFilterContext context)
var productHeaderSchema = new OpenApiSchema
{
Type = "string",
Format = "productheader",
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why was this removed?

Copy link
Contributor

Thank you for contributing to tgstation-server! The workflow 'CI Gated PR Comments' requires repository secrets and will not run without approval. Maintainers can add the CI Cleared label to allow it to run. Note that any changes to ci-security.yml and ci-pipeline.yml will not be reflected.

@tgstation-server-ci tgstation-server-ci bot added size/L CI Approval Required CI Pipeline execution blocked. Maintainers, apply the "CI Cleared" label to allow execution labels Jan 19, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CI Approval Required CI Pipeline execution blocked. Maintainers, apply the "CI Cleared" label to allow execution Documentation Documentation updates REST The JSON REST API for server control size/L
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants