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

[BUG]: POST /repos/{owner}/{repo}/check-runs status Type is Incomplete #438

Open
1 task done
aayachnes opened this issue Oct 31, 2024 · 2 comments
Open
1 task done
Labels
Status: Blocked Some technical or requirement is blocking the issue Type: Bug Something isn't working as documented

Comments

@aayachnes
Copy link

What happened?

The POST /repos/{owner}/{repo}/check-runs API has a request body field status which, according to the API docs and the OpenAPI document (relevant snippet pasted below), is an enum that can take on the following values: queued, in_progress, completed, waiting, requested, pending.

OpenAPI document snippet:

"/repos/{owner}/{repo}/check-runs":
 <REDACTED>
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
<REDACTED>
                status:
                  type: string
                  description: The current status of the check run. Only GitHub Actions
                    can set a status of `waiting`, `pending`, or `requested`.
                  enum:
                  - queued
                  - in_progress
                  - completed
                  - waiting
                  - requested
                  - pending
                  default: queued
<REDACTED>

However, the status field's type in @octokit/openapi-types v22.2.0 is:

// types.d.ts
/**
 * @description The current status.
 * @default queued
 * @enum {string}
 */
status?: "queued" | "in_progress" | "completed";

I think the types for this package may need to be regenerated.

Versions

  • @octokit/openapi-types version 22.2.0

Relevant log output

No response

Code of Conduct

  • I agree to follow this project's Code of Conduct
@aayachnes aayachnes added Status: Triage This is being looked at and prioritized Type: Bug Something isn't working as documented labels Oct 31, 2024
Copy link

👋 Hi! Thank you for this contribution! Just to let you know, our GitHub SDK team does a round of issue and PR reviews twice a week, every Monday and Friday! We have a process in place for prioritizing and responding to your input. Because you are a part of this community please feel free to comment, add to, or pick up any issues/PRs that are labeled with Status: Up for grabs. You & others like you are the reason all of this works! So thank you & happy coding! 🚀

@wolfy1339
Copy link
Member

Blocked by octokit/openapi#452

@wolfy1339 wolfy1339 added Status: Blocked Some technical or requirement is blocking the issue and removed Status: Triage This is being looked at and prioritized labels Oct 31, 2024
@wolfy1339 wolfy1339 moved this from 🆕 Triage to 🛑 Blocked/Awaiting Response in 🧰 Octokit Active Oct 31, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Status: Blocked Some technical or requirement is blocking the issue Type: Bug Something isn't working as documented
Projects
Status: 🛑 Blocked/Awaiting Response
Development

No branches or pull requests

2 participants