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.

Sign up for GitHub

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

Add spec for HTTP Accept header #456

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add spec for HTTP Accept header #456

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
25 changes: 25 additions & 0 deletions spec/accept-header.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# BinAST `Accept` header

## Motivation

BinAST has seen multiple iterations of its encoder, but clients might only support a specific version.

## Syntax

The HTTP header `Accept` with the value `application/javascript-binast; version=VERSION`.

Where the parameter `VERSION` is one of the following:
- [context02](https://github.com/binast/binjs-ref/blob/master/spec/old-context.md)
- [context01](https://github.com/binast/binjs-ref/blob/master/spec/context.md)
- multipart

This list should be updated when a new encoder is implemented.

## Backward compatibility

Clients are currently sending an `Accept` header without any parameter. We will continue to support them by assuming the version is `multipart`.

## Unsupported version

If the server receives a request with an unsupported version, we should make sure to fail gracefully.
The client is recommanded to also accept `application/javascript` so that the server can send the original JavaScript.