Skip to content
This repository has been archived by the owner on Nov 11, 2024. It is now read-only.

Validate Accept header in all REST endpoints and update OpenAPI docs #602

Merged
merged 17 commits into from
Jul 26, 2024
Merged

Validate Accept header in all REST endpoints and update OpenAPI docs #602

merged 17 commits into from
Jul 26, 2024

Conversation

eamansour
Copy link
Member

Why?

See galasa-dev/projectmanagement#1925

Changes

  • Lifted up "Accept" header processing from OpenAPI endpoint to the base route class for use by all routes
  • Added validation of the "Accept" header to all routes that should have been processing it
    • If an unsupported MIME type is provided in the header, then endpoints will return a 406 Not Acceptable error with an appropriate error message rather than continue to serve a response
  • Updated the OpenAPI docs to include the new 406 error response and created common responses that are referenced by REST endpoints to reduce duplication of responses

KirbyKatcher and others added 14 commits July 23, 2024 12:56
@KirbyKatcher
updated base servlet and resources route to check the accepts header …
3653a1b 
…if present

Signed-off-by: Savvas Kyriacou <[email protected]>
@KirbyKatcher
updated schedule runs route to check the accepts header if present
d69ff3e 
Signed-off-by: Savvas Kyriacou <[email protected]>
@KirbyKatcher
updated the check for the Accept header to allow values aside from ap…
73e4fc1 
…plication/json to be specified and added RAS tests

Signed-off-by: Savvas Kyriacou <[email protected]>
@KirbyKatcher
Updated to merge with code from openapi to prevent code duplication
efcd089 
Co-authored-by: Eamonn Mansour <[email protected]>
Signed-off-by: Savvas Kyriacou <[email protected]>
@eamansour
Lift accept header processing into BaseRoute and apply to existing ro…
18fffbf 
…utes

Signed-off-by: Eamonn Mansour <[email protected]>
@eamansour
Rename checkRequestorAcceptContent to validateAcceptHeader and defaul…
6e65193 
…t to JSON

Signed-off-by: Eamonn Mansour <[email protected]>
@eamansour
Validate Accept header in auth and bootstrap routes
ec1074d 
Signed-off-by: Eamonn Mansour <[email protected]>
@eamansour
Reuse 500 and 401 errors in OpenAPI spec
b7a3e39 
Signed-off-by: Eamonn Mansour <[email protected]>
@eamansour
Add missing env vars to local API testing docs
012a295 
Signed-off-by: Eamonn Mansour <[email protected]>
@eamansour
Add tests for wildcard mime type enum
aaa12c2 
Signed-off-by: Eamonn Mansour <[email protected]>
@eamansour
Add 406 error to OpenAPI spec
10dae46 
Signed-off-by: Eamonn Mansour <[email protected]>
@eamansour
Change unsupported mime type API error from 5070 to 5406 for consistency
0eccddd 
Signed-off-by: Eamonn Mansour <[email protected]>
@eamansour
Bump changed bundle versions to 0.36.0
c45af66 
Signed-off-by: Eamonn Mansour <[email protected]>
@eamansour
Merge remote-tracking branch 'origin/main' into issue-1927-resources-…
08d4bfd 
…defect

Signed-off-by: Eamonn Mansour <[email protected]>
@galasa-team
Copy link

Build successful

@eamansour eamansour force-pushed the issue-1927-resources-defect branch from 1ed1a5b to 8540281 Compare July 26, 2024 09:21
@galasa-team
Copy link

Build successful

1 similar comment
@galasa-team
Copy link

Build successful

@galasa-team
Copy link

Build successful

@galasa-team
Copy link

Build successful

@KirbyKatcher KirbyKatcher merged commit fb2a05a into main Jul 26, 2024
7 checks passed
@KirbyKatcher KirbyKatcher deleted the issue-1927-resources-defect branch July 26, 2024 12:24
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@KirbyKatcher KirbyKatcher KirbyKatcher approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@eamansour @galasa-team @KirbyKatcher