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

WIP: Bug 1863077 - Add OpenAPI spec for REST APIOpen api #2143

Open
wants to merge 29 commits into
base: master
Choose a base branch
from
Open
Changes from 1 commit
Commits
Show all changes
29 commits
Select commit Hold shift + click to select a range
4714224
Added openapi spec
Nov 27, 2023
2d36d30
Implemented mock-up OpenAPI spec
Nov 28, 2023
9240831
Added "Create a comment on a bug"
Nov 28, 2023
6f2edce
Added "Update tags for a comment"
Nov 28, 2023
19d3d1e
Removed custom property overrides since openapi-generator was complai…
Nov 28, 2023
c46ecf1
Added "Search for comment tags"
Nov 28, 2023
8829dcd
Added "Render comment as HTML"
Nov 28, 2023
895ef67
Added "Get Bug"
Nov 29, 2023
72b81a0
Added "Bug History"
Nov 29, 2023
eb7edf3
Added "Search Bugs"
Nov 29, 2023
5b59eb1
Added "Create Bug"
Nov 29, 2023
257905d
Added "Graph"
Nov 30, 2023
6f2e337
Added "Possible Duplicates"
Nov 30, 2023
38ba199
Added "Update Bug"
Nov 30, 2023
5f4e994
Let openapi-format reorder and format the file
Nov 30, 2023
c3c2f22
Added parameter component "BugIdOrAlias" for re usability.
Dec 4, 2023
5618567
Aligned "Comments" section
Dec 4, 2023
7408586
Aligned "Bugs" section [skip ci]
Dec 4, 2023
d4ccf99
Added "Get Attachment"
Dec 4, 2023
89ae6b5
Added "Create Attachment"
Dec 4, 2023
95c9186
Added "Update Attachment" [skip ci]
Dec 4, 2023
196a993
Resolved refrences
Dec 4, 2023
4c00e80
Added security schemes
Dec 4, 2023
11ad954
Improved description
Dec 4, 2023
3ac3c2e
Split OpenAPI spec into individual files
Dec 4, 2023
a468d72
Added Operation Ids
michaelvanstraten Feb 29, 2024
5bbab24
Added basic GH action for linting OpenAPI spec
michaelvanstraten Feb 29, 2024
1431ecf
Basic test generation of python Client
michaelvanstraten Feb 29, 2024
653655d
Made ref file relative
michaelvanstraten Feb 29, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Removed custom property overrides since openapi-generator was complai…
…ning
Michael van Straten committed Nov 28, 2023
commit 19d3d1ebd71962870100b87ba4e4bdb88592fa91
25 changes: 17 additions & 8 deletions openapi.yaml
Original file line number Diff line number Diff line change
@@ -72,14 +72,20 @@ paths:

comments: {}
default:
description: (Invalid Comment ID) You specified an id in the “comment_ids” argument that is invalid–either you specified something that wasn’t a number, or there is no comment with that id.
description: |
Various error responses, including:

* 100 (Invalid Bug Alias)
If you specified an alias and there is no bug with that alias.
* 101 (Invalid Bug ID)
The bug_id you specified doesn't exist in the database.
* 102 (Access Denied)
You do not have access to the bug_id you specified.

content:
application/json:
schema:
$ref: "#/components/schemas/Error"
properties:
code:
const: 111

/bug/comment/{comment_id}:
get:
@@ -123,14 +129,17 @@ paths:
id: 75
bugs: {}
default:
description: (Comment Is Private) You specified the id of a private comment in the “comment_ids” argument, and you are not in the “insider group” that can see private comments.
description: |
Various error responses, including:

* 110 (Comment Is Private)
You specified the id of a private comment in the “comment_ids” argument, and you are not in the “insider group” that can see private comments.
* 111 (Invalid Comment ID)
You specified an id in the “comment_ids” argument that is invalid–either you specified something that wasn’t a number, or there is no comment with that id.
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
properties:
code:
const: 110

/bug/{id}/comment:
post: