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

Incomplete / Misleading Hooks section documentation in Swagger #9039

Closed
5 tasks
pecastro opened this issue Nov 15, 2019 · 0 comments · Fixed by #9558
Closed
5 tasks

Incomplete / Misleading Hooks section documentation in Swagger #9039

pecastro opened this issue Nov 15, 2019 · 0 comments · Fixed by #9558
Labels
type/docs This PR mainly updates/creates documentation

Comments

@pecastro
Copy link
Contributor

HI,

  • Gitea version 1.9.3
  • Git version: Not relevant
  • Operating system:
  • Database (use [x]):
    • [x ] PostgreSQL
    • MySQL
    • MSSQL
    • SQLite
  • Can you reproduce the bug at https://try.gitea.io:
    • [x ] Yes (provide example URL)
    • No
    • Not relevant
  • Log gist:

Description

The swagger definitions for all of the hooks API's are incomplete and wrong.

curl -H "accept: application/json" -X GET "http://user:[email protected]/api/v1/repos/TestOrg/TestRepo/hooks/1" | jq .
{
  "id": 1,
  "type": "gitea",
  "config": {
    "content_type": "json",
    "url": "http://jenkins.xxx.xxx/gitea-webhook/post"
  },
  "events": [
    "push"
  ],
  "active": true,
  "updated_at": "2019-11-03T23:15:32Z",
  "created_at": "2019-11-03T23:09:59Z"
}

Screenshots

image

content_type is a required field also not mentioned in Swagger.

@lunny lunny added the type/docs This PR mainly updates/creates documentation label Nov 16, 2019
@go-gitea go-gitea locked and limited conversation to collaborators Nov 24, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
type/docs This PR mainly updates/creates documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants