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

Update to RFC 9457 #14

Merged
merged 3 commits into from
Oct 5, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# openapi-problem

This repository contains OpenAPI data types for problem messages, compliant to [RFC 7807 - Problem Details for HTTP APIs](https://tools.ietf.org/html/rfc7807).
This repository contains OpenAPI data types for problem messages, compliant to [RFC 9457 - Problem Details for HTTP APIs](https://www.rfc-editor.org/rfc/rfc9457) (which obsoletes RFC 7807).
Their proper use is documented in the [REST guide](https://www.gcloud.belgium.be/rest/#error-handling).

Within a major version, types remain backwards compatible once they are released.
Expand Down
2 changes: 1 addition & 1 deletion pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
<packaging>pom</packaging>

<name>${project.groupId}:${project.artifactId}</name>
<description>OpenAPI data types for problem messages, compliant to RFC 7807</description>
<description>OpenAPI data types for problem messages, compliant to RFC 9457</description>
<url>https://github.com/belgif/openapi-problem</url>

<build>
Expand Down
2 changes: 1 addition & 1 deletion src/main/openapi/problem/v1/problem-v1.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ components:
description: A problem caused by invalid input
schemas:
Problem:
description: A Problem Details object (RFC 7807)
description: A Problem Details object (RFC 9457)
type: object
properties:
type:
Expand Down
2 changes: 1 addition & 1 deletion src/main/swagger/problem/v1/problem-v1.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ responses:
$ref: "#/definitions/InputValidationProblem"
definitions:
Problem:
description: A Problem Details object (RFC 7807)
description: A Problem Details object (RFC 9457)
type: object
properties:
type:
Expand Down
Loading