Skip to content

docs(swagger): add all endpoints#3667

Open
fiftin wants to merge 1 commit intodevelopfrom
update_swagger
Open

docs(swagger): add all endpoints#3667
fiftin wants to merge 1 commit intodevelopfrom
update_swagger

Conversation

@fiftin
Copy link
Copy Markdown
Collaborator

@fiftin fiftin commented Feb 25, 2026

No description provided.

Copy link
Copy Markdown

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 459d282e78

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread api-docs.yml
schemes:
- ws
- wss
type: object
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 Badge Document /options GET as an array response

GET /options is documented with schema: { type: object }, but the handler returns a slice from helpers.Store(r).GetOptions(...) and writes it directly (api/options.go), so the payload is an array of options. Generated clients using this spec will deserialize into the wrong shape and fail or drop data when calling this endpoint.

Useful? React with 👍 / 👎.

Comment thread api-docs.yml
Comment on lines +1855 to +1856
200:
description: Integration received
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 Badge Mark integration webhook success as 204

The webhook endpoint documents successful GET/POST /integrations/{integration_alias} responses as 200, but ReceiveIntegration ends with w.WriteHeader(http.StatusNoContent) (api/integration.go), i.e. 204 on success. Clients generated from this spec may treat valid 204 responses as undocumented/unexpected and surface false failures.

Useful? React with 👍 / 👎.

Comment thread api-docs.yml
Comment on lines +4086 to +4087
204:
description: Valid cron format
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 Badge Advertise 200 for successful cron validation

The new /project/{project_id}/schedules/validate docs list success as 204, but ValidateScheduleCronFormat returns without writing a status when validation passes (api/projects/schedules.go), so net/http sends 200 OK. Keeping 204 here makes the spec disagree with runtime behavior and can break strict status-code handling in API clients.

Useful? React with 👍 / 👎.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant