From 191e781b28d9bfebb37d5a53b9e36101a44dcb23 Mon Sep 17 00:00:00 2001 From: Ethan Resnick Date: Mon, 3 Dec 2018 11:54:52 -0500 Subject: [PATCH] feat(format): better define unsupported client-required profile error --- _config.yml | 11 ++++++++++- _errors/profile-not-supported.md | 3 +++ _format/1.1/index.md | 8 +++++++- _layouts/{profile_error.html => error.html} | 0 4 files changed, 20 insertions(+), 2 deletions(-) create mode 100644 _errors/profile-not-supported.md rename _layouts/{profile_error.html => error.html} (100%) diff --git a/_config.yml b/_config.yml index 6df3b6036..ddce180bd 100644 --- a/_config.yml +++ b/_config.yml @@ -50,6 +50,8 @@ port: 9876 collections: format: output: true + errors: + output: true profiles: output: true permalink: /:collection/:path @@ -66,7 +68,14 @@ defaults: path: "" type: "profiles" values: - layout: profile_error + layout: error + is_spec_page: false + show_sidebar: false + - scope: + path: "" + type: "errors" + values: + layout: error is_spec_page: false show_sidebar: false - scope: diff --git a/_errors/profile-not-supported.md b/_errors/profile-not-supported.md new file mode 100644 index 000000000..ba06f10d9 --- /dev/null +++ b/_errors/profile-not-supported.md @@ -0,0 +1,3 @@ +--- +redirect_to: /format/1.1/#profile-query-parameter +--- diff --git a/_format/1.1/index.md b/_format/1.1/index.md index 27dfec236..d033a6b61 100644 --- a/_format/1.1/index.md +++ b/_format/1.1/index.md @@ -1970,7 +1970,13 @@ query parameter **MUST** equal a URI-encoded whitespace-separated list of profil If a server receives a request requiring the application of a profile or combination of profiles that it can not apply, it **MUST** respond with a `400 -Bad Request` status code. +Bad Request` status code. The response **MUST** contain an [error object] that +identifies the `profile` query parameter as the `source` and has the following +URI as (one of) its `type`s: + +``` +https://jsonapi.org/errors/profile-not-supported +``` > Note: When a client lists a profile in the `Accept` header, it's asking the > server to compute its response as normal, but then send the response document diff --git a/_layouts/profile_error.html b/_layouts/error.html similarity index 100% rename from _layouts/profile_error.html rename to _layouts/error.html pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.

Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy