for-get / know-your-http-well Goto Github PK

HTTP headers, media-types, methods, relations and status codes, all summarized and linking to their specification.

License: The Unlicense

Emacs Lisp 99.03% JavaScript 0.97%

http http-status-code http-method http-header json emacs

know-your-http-well's Introduction

KNOW YOUR HTTP * WELL

HTTP encodings, headers, media types, methods, relations and status codes, all summarized and linking to their specification.

This project is used by HyperREST bin at bin.hyperrest.com .

How to convert to other formats

Packages

Emacs

(require 'know-your-http-well)
;; M-x http-header ;; content-type
;; M-x http-method ;; post | POST
;; M-x http-relation ;; describedby
;; M-x http-status-code ;; 500
;; M-x http-status-code ;; not_found | NOT_FOUND

JavaScript

var httpWell = require('know-your-http-well'),
    statusWell = httpWell.statusPhrasesToCodes,
    phraseWell = httpWell.statusCodesToPhrases;

// on the server side
res.statusCode = statusWell.NOT_FOUND

// on the client side
if (res.statusCode !== statusWell.OK) {
    // Log "Request returned 404 Not Found"
    log('Request returned ' + res.statusCode + ' ' + phraseWell[res.statusCode]);
}

JSON

Just take a look at ./json/*.json.

References

https://github.com/dret/webconcepts
DanaDanger on twitter.com: HTTP response codes for dummies. 50x: we fucked up. 40x: you fucked up. 30x: ask that dude over there. 20x: cool.
Steve Losh on twitter.com : HTTP status ranges in a nutshell: 1xx: hold on. 2xx: here you go. 3xx: go away. 4xx: you fucked up. 5xx: I fucked up

License

Unlicense.

Stargazers over time

know-your-http-well's People

Contributors

Stargazers

Watchers

Forkers

chinnurtb hazirguo typesend codeinpeace bbonamin tomarsamar pfrazee arianra ziir courtsansom purcaro y-lan bennyh26 kp666 29decibel howardpanton ataki osharim seanschade stormpat jeisc ahmadajmi aavaz alaal myko21 galati1337 josepepeourense skiold jameswei harshadsabne emilsoman teachshits iclosedz thatchristoph gsphanikumar purcell cmsimike l-yara dmitriid aoj julienfantin dthyresson marcewankenobi icon-touch gregnwosu jrencz dulanism dwsyoyo emacsmirror guruchat wjordan lblyweert sarvex frankmaina avgx fdogwood okovalov joprice robdb5 moraesmv henriqueeloi wudi bluehallu fredlackeyofficial patelprashant hunt mywaytojavajunior anymaster gilbert keviocastro christopheradams mitchellporter khouli00 ismail1432 lifengchuan2008 blestan johnnyghost tabbi89 jhong93 developerbackpack nimacks hongbinz doreln chmodas tang-junjie dleffert kaisbn andela-oadebayo elghailani pengdake ipenywis yudhisth57533 infrastrukt raduq-graveyard pebsconsulting cichy19 jrgosalia raisingstar samsu machdmach

know-your-http-well's Issues

update to RFC 4918

status-codes.md mentions RFC5218 several times. This is a typo for 2518.

RFC 2518 is obsoleted by RFC 4918.

add 103 status code

https://tools.ietf.org/html/draft-ietf-httpbis-early-hints-05

can't be added to zeal

When adding https://raw.githubusercontent.com/for-GET/know-your-http-well/master/docset/know-your-http-well.xml to Zeal it just shows a dialog saying Could not read docset feed!

update readme

readme is out-of-sync with emacs modules

Emacs: Use completing-read When Prompting

Hi,

Just installed your package and noticed that you don't use completing-read. Any reason why?

I can submit a pull request with the changes, but the source indicates that it was auto generated and I don't see where this is done.

Possibly related to #1

Tweets are protected

Many of the links in the Status entry are to protected tweets, and therefore inaccessible to the general viewing public

Duplicate Cache-Control header

$ grep '"header"' json/headers.json | sort | uniq -c | sort -n | grep -v 1
   2         "header": "Cache-Control",

Contribute docset to Dash

I've set up a repo where users can contribute docsets to Dash. You can check it out at https://github.com/Kapeli/Dash-User-Contributions. It should contain all the info you need to get started.

Docsets that are contributed in this way will appear in a separate User Contributed section under Dash's Preferences > Downloads (i.e. just like the current Ruby Gems or Cocoa Pods sections).

If you need any help with this, don't hesitate to contact me. Thank you!

dash: relative links don't work

add HTTP headers Client-Hints and Key

https://github.com/igrigorik/http-client-hints
https://github.com/mnot/I-D/tree/master/http-key

Missing status codes 408 & 418

The RFC might be a joke but it's typically supported by most libraries pertaining to HTTP.

Cookie spec is obsolete

The Cookie spec that documents what tools (browsers, etc.) actually implement is RFC 6265

Publish latest version to npm?

npm only has version 0.2.0. Could you publish the latest version to npm, @andreineculau?

add 308 status code, albeit experimental

https://tools.ietf.org/html/rfc7538

missing DanaDanger tweet

the tweet said

HTTP response codes for dummies. 50x: we fucked up. 40x: you fucked up. 30x: ask that dude over there. 20x: cool.

Suggestion: Submit a User Contributed Docset to Dash

Have you tried the following?

https://github.com/Kapeli/Dash-User-Contributions#contribute-a-new-docset

It seems to be the recent process for user-contributed doc-sets.

being an XML dinosaur, i'd love to get all of this as XML. but then again, there probably is not a enough regularity in the current markdown, so maybe that's too much to ask for? in whichever way it's implemented, wouldn't it be great to have a machine-readable version of all of this information? it would be simple to generate markdown, but much simpler to also generate other formats: whatever people want. and out of curiosity: how are the emacs and js versions generated currently?

Missing anchor entries in docset index

"507 Insufficient Storage" links to rfc2518.html#section-10.7. Unfortunately #section-10.7 does not exist in the rfc2518.html page.

Missing docset icon

Docset does not have an icon. See http://kapeli.com/docsets#addingicon for instructions on how to add this.

a missing HTTP method "POST"

I saw the methods.json, i tried to find POST method and found it wa missing.

Kindly add it.

and nice work.

404 entries in docset index

I found one entry that points to a page that does not exist: 7xx Developer Error. Note: there might be other pages that don't exist (I haven't checked all).

as alternative to #35 #31

add brotli encoding

http://tools.ietf.org/html/draft-alakuijala-brotli

add Server-Timing header

https://w3c.github.io/server-timing/

Can I delete an issue?

closed, wrong

emacs: access full list of items

Sometimes you have no idea how a relation/status-code/header/etc is named,
so it's better to just open up a buffer with the the .el/.md file.

(defun http-list-status-codes ...)
...

what about CORS?

CORS http://www.w3.org/TR/cors/ is not in there right now, correct? that might be a good thing to add, right?

prefer: transclude

https://github.com/inadarei/draft-prefer-transclude

CONNECT is not Safe

CONNECT is not Safe: https://tools.ietf.org/html/rfc7231#section-8.1.3

tag 0.3.0 release

We got 0.3.0 last month in 13858ba, but it'd be great to have a tagged release for MELPA.

Thanks!

specs.md to specs.json

Missing docset index page

The docset does not have an index page set. See http://kapeli.com/docsets#settingindexpage for details on how to add this.

Failing for webpack with Error: define cannot be used indirect

I am using raml-js-parser-2 which uses raml-definition-system which uses this module as dependency and during webpacking i am getting an error Error: define cannot be used indirect. Debugging error i found out that this module uses amdefine and my error is on that.

Looking into source code, I changed js/index.js file to use global function instead amdefine and it worked fine after webpacking.

Can anything be done about amdefine with webpack?