⌈⌋ branch:  freshcode


Hex Artifact Content

Artifact e11500b873c14fcb003578464667016b31e40218:

Wiki page [API2] by glen 2015-08-10 11:58:08.
0000: 44 20 32 30 31 35 2d 30 38 2d 31 30 54 31 31 3a  D 2015-08-10T11:
0010: 35 38 3a 30 38 2e 37 39 36 0a 4c 20 41 50 49 32  58:08.796.L API2
0020: 0a 4e 20 74 65 78 74 2f 78 2d 6d 61 72 6b 64 6f  .N text/x-markdo
0030: 77 6e 0a 50 20 37 66 64 39 35 36 62 36 64 39 30  wn.P 7fd956b6d90
0040: 30 30 31 35 39 65 32 61 66 36 61 61 61 38 34 34  00159e2af6aaa844
0050: 35 30 35 32 33 62 38 33 37 33 33 61 30 0a 55 20  50523b83733a0.U 
0060: 67 6c 65 6e 0a 57 20 31 35 32 37 34 0a 53 74 61  glen.W 15274.Sta
0070: 74 65 3a 20 2a 2a 2a 64 65 73 69 67 6e 2a 2a 2a  te: ***design***
0080: 2c 20 2a 74 65 73 74 69 6e 67 2a 0d 0a 0d 0a 0d  , *testing*.....
0090: 0a 23 23 20 53 69 6d 70 6c 65 72 20 4a 53 4f 4e  .## Simpler JSON
00a0: 20 41 50 49 0d 0a 0d 0a 54 6f 20 75 70 64 61 74   API....To updat
00b0: 65 20 61 6e 64 20 73 75 62 6d 69 74 20 70 72 6f  e and submit pro
00c0: 6a 65 63 74 20 72 65 63 6f 72 64 73 2c 20 74 68  ject records, th
00d0: 65 72 65 27 73 20 67 6f 69 6e 67 20 74 6f 20 62  ere's going to b
00e0: 65 20 61 20 73 69 6d 70 6c 69 66 69 65 64 0d 0a  e a simplified..
00f0: 4a 53 4f 4e 20 69 6e 74 65 72 66 61 63 65 2e 0d  JSON interface..
0100: 0a 0d 0a 20 2a 20 54 68 65 20 74 65 73 74 69 6e  ... * The testin
0110: 67 20 41 50 49 20 65 6e 64 70 6f 69 6e 74 20 69  g API endpoint i
0120: 73 20 3c 6b 62 64 3e 60 68 74 74 70 73 3a 2f 2f  s <kbd>`https://
0130: 74 65 73 74 2e 66 72 65 73 68 63 6f 64 65 2e 63  test.freshcode.c
0140: 6c 75 62 2f e2 80 a6 60 3c 2f 6b 62 64 3e 2c 20  lub/...`</kbd>, 
0150: 20 0d 0a 20 20 20 77 68 69 63 68 20 63 61 6e 20   ..   which can 
0160: 62 65 20 75 73 65 64 20 66 6f 72 20 62 72 6f 77  be used for brow
0170: 73 69 6e 67 20 61 73 20 77 65 6c 6c 2e 0d 0a 0d  sing as well....
0180: 0a 20 2a 20 54 68 65 20 72 65 67 75 6c 61 72 20  . * The regular 
0190: 41 50 49 20 65 6e 64 70 6f 69 6e 74 20 69 73 20  API endpoint is 
01a0: 3c 6b 62 64 3e 60 68 74 74 70 73 3a 2f 2f 61 70  <kbd>`https://ap
01b0: 69 2e 66 72 65 73 68 63 6f 64 65 2e 63 6c 75 62  i.freshcode.club
01c0: 2f e2 80 a6 60 3c 2f 6b 62 64 3e 2c 20 20 0d 0a  /...`</kbd>,  ..
01d0: 20 20 20 62 75 74 20 69 73 20 2a 63 75 72 72 65     but is *curre
01e0: 6e 74 6c 79 2a 20 66 69 78 61 74 65 64 20 6f 6e  ntly* fixated on
01f0: 20 74 68 65 20 74 65 73 74 20 64 61 74 61 62 61   the test databa
0200: 73 65 20 74 6f 6f 2e 0d 0a 0d 0a 0d 0a 23 23 20  se too.......## 
0210: 55 52 4c 20 73 63 68 65 6d 65 0d 0a 0d 0a 55 70  URL scheme....Up
0220: 64 61 74 69 6e 67 20 61 6e 64 20 72 65 6c 65 61  dating and relea
0230: 73 65 20 70 75 62 6c 69 73 68 69 6e 67 20 63 61  se publishing ca
0240: 6e 20 6e 6f 77 20 62 65 20 63 6f 6d 62 69 6e 65  n now be combine
0250: 64 20 69 6e 74 6f 20 6f 6e 65 20 50 55 54 2f 50  d into one PUT/P
0260: 4f 53 54 0d 0a 72 65 71 75 65 73 74 2e 20 54 68  OST..request. Th
0270: 65 20 55 52 4c 20 64 69 63 74 20 63 61 6e 20 6e  e URL dict can n
0280: 6f 77 20 62 65 20 65 6d 62 65 64 64 65 64 20 65  ow be embedded e
0290: 76 65 72 79 77 68 65 72 65 20 6f 72 20 70 61 73  verywhere or pas
02a0: 73 65 64 20 61 6c 6f 6e 67 73 69 64 65 2e 0d 0a  sed alongside...
02b0: 0d 0a 0d 0a 6d 65 74 68 6f 64 09 7c 20 55 52 4c  ....method.| URL
02c0: 20 70 61 74 68 09 09 09 09 09 09 7c 66 75 6e 63   path......|func
02d0: 74 69 6f 6e 2b 70 75 72 70 6f 73 65 0d 0a 2d 2d  tion+purpose..--
02e0: 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d  ----------------
02f0: 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d  ----------------
0300: 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d  ----------------
0310: 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d  ----------------
0320: 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 0d 0a  --------------..
0330: 47 45 54 09 7c 60 2f 70 72 6f 6a 65 63 74 73 2f  GET.|`/projects/
0340: 3c 6e 61 6d 65 3e 2e 6a 73 6f 6e 60 09 09 09 09  <name>.json`....
0350: 7c 71 75 65 72 79 20 61 6c 6c 20 66 69 65 6c 64  |query all field
0360: 73 0d 0a 50 55 54 09 7c 60 2f 70 72 6f 6a 65 63  s..PUT.|`/projec
0370: 74 73 2f 3c 6e 61 6d 65 3e 2e 6a 73 6f 6e 60 09  ts/<name>.json`.
0380: 09 09 09 7c 75 70 64 61 74 65 5f 63 6f 72 65 2b  ...|update_core+
0390: 72 65 6c 65 61 73 65 0d 0a 43 52 45 41 54 45 09  release..CREATE.
03a0: 7c 60 2f 70 72 6f 6a 65 63 74 73 2f 3c 6e 61 6d  |`/projects/<nam
03b0: 65 3e 2e 6a 73 6f 6e 60 09 09 09 09 7c 6e 65 77  e>.json`....|new
03c0: 5f 70 72 6f 6a 65 63 74 2b 75 70 64 61 74 65 0d  _project+update.
03d0: 0a 3c 73 3e 50 4f 53 54 09 7c 3c 73 3e 60 2f 70  .<s>POST.|<s>`/p
03e0: 72 6f 6a 65 63 74 73 2f 3c 6e 61 6d 65 3e 2f 72  rojects/<name>/r
03f0: 65 6c 65 61 73 65 73 2e 6a 73 6f 6e 60 3c 2f 73  eleases.json`</s
0400: 3e 09 09 7c 3c 73 3e 70 75 62 6c 69 73 68 3c 2f  >..|<s>publish</
0410: 73 3e 09 0d 0a 44 45 4c 45 54 45 09 7c 60 2f 70  s>...DELETE.|`/p
0420: 72 6f 6a 65 63 74 73 2f 3c 6e 61 6d 65 3e 2f 72  rojects/<name>/r
0430: 65 6c 65 61 73 65 73 2f 3c 76 65 72 73 74 72 3e  eleases/<verstr>
0440: 2e 6a 73 6f 6e 60 2a 3f 61 75 74 68 5f 63 6f 64  .json`*?auth_cod
0450: 65 3d 2a 09 7c 77 69 74 68 64 72 61 77 20 76 65  e=*.|withdraw ve
0460: 72 73 69 6f 6e 09 0d 0a 3c 73 3e 50 55 53 48 09  rsion...<s>PUSH.
0470: 7c 3c 73 3e 60 2f 70 72 6f 6a 65 63 74 73 2f 3c  |<s>`/projects/<
0480: 6e 61 6d 65 3e 2f 75 72 6c 73 2e 6a 73 6f 6e 60  name>/urls.json`
0490: 3c 2f 73 3e 09 09 09 7c 3c 73 3e 75 70 64 61 74  </s>...|<s>updat
04a0: 65 5f 75 72 6c 73 3c 2f 73 3e 0d 0a 47 45 54 09  e_urls</s>..GET.
04b0: 7c 60 2f 66 65 65 64 2f 3c 6e 61 6d 65 3e 2e 6a  |`/feed/<name>.j
04c0: 73 6f 6e 60 09 09 09 09 09 7c 72 65 6c 65 61 73  son`.....|releas
04d0: 65 5f 6c 69 73 74 2b 66 65 64 65 72 61 74 69 6f  e_list+federatio
04e0: 6e 0d 0a 0d 0a 54 68 65 20 3c 6b 62 64 3e 50 55  n....The <kbd>PU
04f0: 54 3c 2f 6b 62 64 3e 20 6d 65 74 68 6f 64 20 6c  T</kbd> method l
0500: 69 6b 65 77 69 73 65 20 77 6f 72 6b 73 20 77 69  ikewise works wi
0510: 74 68 20 3c 6b 62 64 3e 50 4f 53 54 3c 2f 6b 62  th <kbd>POST</kb
0520: 64 3e 20 6f 72 0d 0a 3c 6b 62 64 3e 50 55 53 48  d> or..<kbd>PUSH
0530: 3c 2f 6b 62 64 3e 20 28 22 50 55 53 48 22 20 62  </kbd> ("PUSH" b
0540: 65 63 61 75 73 65 20 69 74 27 73 20 61 20 70 72  ecause it's a pr
0550: 6f 67 72 61 6d 6d 69 6e 67 20 73 69 74 65 2c 20  ogramming site, 
0560: 61 6e 64 20 65 6e 74 72 69 65 73 20 61 72 65 0d  and entries are.
0570: 0a 62 61 73 69 63 61 6c 6c 79 20 61 20 73 74 61  .basically a sta
0580: 63 6b 29 2e 20 46 69 65 6c 64 73 20 61 72 65 20  ck). Fields are 
0590: 65 71 75 69 76 61 6c 65 6e 74 20 66 6f 72 20 74  equivalent for t
05a0: 68 65 20 69 6e 69 74 69 61 6c 69 7a 69 6e 67 20  he initializing 
05b0: 3c 6b 62 64 3e 43 52 45 41 54 45 3c 2f 6b 62 64  <kbd>CREATE</kbd
05c0: 3e 2e 0d 0a 0d 0a 0d 0a 23 23 20 4a 53 4f 4e 20  >.......## JSON 
05d0: 6f 62 6a 65 63 74 20 6b 65 79 73 0d 0a 0d 0a 57  object keys....W
05e0: 68 65 72 65 20 74 68 65 20 4a 53 4f 4e 20 66 69  here the JSON fi
05f0: 65 6c 64 20 6e 61 6d 65 73 20 61 72 65 20 6d 61  eld names are ma
0600: 70 70 65 64 20 61 73 20 66 6f 6c 6c 6f 77 73 3a  pped as follows:
0610: 0d 0a 0d 0a 3c 73 74 79 6c 65 3e 0d 0a 20 2e 63  ....<style>.. .c
0620: 6f 6e 74 65 6e 74 20 74 61 62 6c 65 20 7b 20 77  ontent table { w
0630: 69 64 74 68 3a 20 39 35 25 3b 20 7d 0d 0a 20 2e  idth: 95%; }.. .
0640: 63 6f 6e 74 65 6e 74 20 74 61 62 6c 65 20 74 72  content table tr
0650: 20 74 64 3a 6e 74 68 2d 63 68 69 6c 64 28 35 29   td:nth-child(5)
0660: 20 7b 20 63 6f 6c 6f 72 3a 20 23 39 39 63 3b 20   { color: #99c; 
0670: 66 6f 6e 74 2d 73 74 79 6c 65 3a 20 69 74 61 6c  font-style: ital
0680: 69 63 3b 20 7d 0d 0a 20 2e 63 6f 6e 74 65 6e 74  ic; }.. .content
0690: 20 74 61 62 6c 65 20 74 72 20 74 64 3a 6e 74 68   table tr td:nth
06a0: 2d 63 68 69 6c 64 28 33 29 20 7b 20 66 6f 6e 74  -child(3) { font
06b0: 2d 77 65 69 67 68 74 3a 20 62 6f 6c 64 3b 20 63  -weight: bold; c
06c0: 6f 6c 6f 72 3a 20 23 32 37 32 3b 20 7d 20 0d 0a  olor: #272; } ..
06d0: 20 2e 63 6f 6e 74 65 6e 74 20 74 61 62 6c 65 20   .content table 
06e0: 74 72 20 74 64 3a 6e 74 68 2d 63 68 69 6c 64 28  tr td:nth-child(
06f0: 31 29 20 7b 20 63 6f 6c 6f 72 3a 20 23 62 62 62  1) { color: #bbb
0700: 3b 20 66 6f 6e 74 2d 77 65 69 67 68 74 3a 20 62  ; font-weight: b
0710: 6f 6c 64 3b 20 7d 0d 0a 3c 2f 73 74 79 6c 65 3e  old; }..</style>
0720: 0d 0a 0d 0a 0d 0a 20 77 6f 72 6b 73 20 77 69 74  ...... works wit
0730: 68 20 20 20 7c 20 20 66 72 65 73 68 63 6f 64 65  h   |  freshcode
0740: 20 44 42 20 20 20 7c 20 20 4a 53 4f 4e 20 66 69   DB   |  JSON fi
0750: 65 6c 64 20 20 20 20 20 7c 20 66 72 65 65 63 6f  eld     | freeco
0760: 64 65 2d 73 75 62 6d 69 74 20 20 7c 20 53 61 6d  de-submit  | Sam
0770: 70 6c 65 20 64 61 74 61 0d 0a 2d 2d 2d 2d 2d 2d  ple data..------
0780: 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d  ----------------
0790: 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d  ----------------
07a0: 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d  ----------------
07b0: 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d  ----------------
07c0: 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d  ----------------
07d0: 2d 2d 2d 2d 0d 0a 20 43 52 45 41 54 45 20 20 20  ----.. CREATE   
07e0: 20 20 20 20 7c 20 20 6e 61 6d 65 20 20 20 20 20      |  name     
07f0: 20 20 20 20 20 20 7c 20 20 60 3c 6e 61 6d 65 3e        |  `<name>
0800: 60 20 20 20 20 20 20 20 7c 20 50 72 6f 6a 65 63  `       | Projec
0810: 74 20 20 20 20 20 20 20 20 20 20 7c 20 75 6e 69  t          | uni
0820: 78 2d 6e 61 6d 65 0d 0a 20 20 20 50 55 54 20 20  x-name..   PUT  
0830: 20 20 20 20 20 20 7c 20 20 74 69 74 6c 65 20 20        |  title  
0840: 20 20 20 20 20 20 20 20 7c 20 20 74 69 74 6c 65          |  title
0850: 20 20 20 20 20 20 20 20 20 20 7c 20 50 72 6f 6a            | Proj
0860: 65 63 74 20 20 20 20 20 20 20 20 20 20 7c 20 46  ect          | F
0870: 6f 6f 20 42 61 72 20 47 74 6b 2b 0d 0a 20 20 20  oo Bar Gtk+..   
0880: 50 55 54 20 20 20 20 20 20 20 20 7c 20 20 73 75  PUT        |  su
0890: 6d 6d 61 72 79 20 20 20 20 20 20 20 20 7c 20 20  mmary        |  
08a0: 73 75 6d 6d 61 72 79 20 20 20 20 20 20 20 20 7c  summary        |
08b0: 20 53 75 6d 6d 61 72 79 20 20 20 20 20 20 20 20   Summary        
08c0: 20 20 7c 20 73 68 6f 72 74 20 73 6c 6f 67 61 6e    | short slogan
08d0: 0d 0a 20 20 20 50 55 54 20 20 20 20 20 20 20 20  ..   PUT        
08e0: 7c 20 20 64 65 73 63 72 69 70 74 69 6f 6e 20 20  |  description  
08f0: 20 20 7c 20 20 64 65 73 63 72 69 70 74 69 6f 6e    |  description
0900: 20 20 20 20 7c 20 44 65 73 63 72 69 70 74 69 6f      | Descriptio
0910: 6e 20 20 20 20 20 20 7c 20 4c 6f 6e 67 20 20 74  n      | Long  t
0920: 65 78 74 2e 2e 2e 0d 0a 20 20 20 50 55 54 20 20  ext.....   PUT  
0930: 20 20 20 20 20 20 7c 20 20 74 61 67 73 20 20 20        |  tags   
0940: 20 20 20 20 20 20 20 20 7c 20 60 70 72 6f 6a 65          | `proje
0950: 63 74 5f 74 61 67 73 60 20 20 7c 20 50 72 6f 6a  ct_tags`  | Proj
0960: 65 63 74 2d 54 61 67 2d 4c 69 73 74 20 7c 20 63  ect-Tag-List | c
0970: 2c 20 63 2b 2b 2c 20 63 6c 69 0d 0a 20 20 20 50  , c++, cli..   P
0980: 55 54 20 20 20 20 20 20 20 20 7c 20 20 6c 69 63  UT        |  lic
0990: 65 6e 73 65 20 20 20 20 20 20 20 20 7c 20 60 6c  ense        | `l
09a0: 69 63 65 6e 73 65 5f 6c 69 73 74 60 20 20 7c 20  icense_list`  | 
09b0: 4c 69 63 65 6e 73 65 2d 4c 69 73 74 20 20 20 20  License-List    
09c0: 20 7c 20 4d 49 54 4c 2c 20 47 4e 55 20 47 50 4c   | MITL, GNU GPL
09d0: 0d 0a 20 20 20 50 55 54 2c 20 55 52 4c 20 20 20  ..   PUT, URL   
09e0: 7c 20 20 68 6f 6d 65 70 61 67 65 20 20 20 20 20  |  homepage     
09f0: 20 20 7c 20 20 75 72 6c 73 20 7b e2 80 a6 7d 20    |  urls {...} 
0a00: 20 20 20 20 20 20 7c 20 48 6f 6d 65 70 61 67 65        | Homepage
0a10: 2d 55 52 4c 20 20 20 20 20 7c 20 68 74 74 70 3a  -URL     | http:
0a20: 2f 2f 65 78 6d 70 6c 0d 0a 20 20 20 50 55 54 2c  //exmpl..   PUT,
0a30: 20 55 52 4c 20 20 20 7c 20 20 68 6f 6d 65 70 61   URL   |  homepa
0a40: 67 65 20 20 20 20 20 20 20 7c 20 20 75 72 6c 73  ge       |  urls
0a50: 20 7b e2 80 a6 7d 20 20 20 20 20 20 20 7c 20 57   {...}       | W
0a60: 65 62 73 69 74 65 2d 55 52 4c 20 20 20 20 20 20  ebsite-URL      
0a70: 7c 20 68 74 74 70 3a 2f 2f 65 78 6d 70 6c 0d 0a  | http://exmpl..
0a80: 20 20 20 50 55 54 2c 20 55 52 4c 20 20 20 7c 20     PUT, URL   | 
0a90: 20 69 6d 61 67 65 3a 20 20 20 20 20 20 20 20 20   image:         
0aa0: 7c 20 20 75 72 6c 73 20 7b e2 80 a6 7d 20 20 20  |  urls {...}   
0ab0: 20 20 20 20 7c 20 53 63 72 65 65 6e 73 68 6f 74      | Screenshot
0ac0: 2d 55 52 4c 20 20 20 7c 20 68 74 74 70 3a 2f 2f  -URL   | http://
0ad0: 70 6e 67 0d 0a 20 20 20 50 55 54 2c 20 55 52 4c  png..   PUT, URL
0ae0: 20 20 20 7c 20 20 61 75 74 6f 75 70 64 61 74 65     |  autoupdate
0af0: 5f 75 72 6c 20 7c 20 20 75 72 6c 73 20 7b e2 80  _url |  urls {..
0b00: a6 7d 20 20 20 20 20 20 20 7c 20 43 68 61 6e 67  .}       | Chang
0b10: 65 6c 6f 67 2d 55 52 4c 20 20 20 20 7c 20 2e 2e  elog-URL    | ..
0b20: 2e 2f 4e 45 57 53 2e 6d 64 0d 0a 20 20 20 50 55  ./NEWS.md..   PU
0b30: 54 2c 20 55 52 4c 20 20 20 7c 20 20 75 72 6c 73  T, URL   |  urls
0b40: 20 7b e2 80 a6 7d 20 20 20 20 20 20 20 7c 20 20   {...}       |  
0b50: 75 72 6c 73 20 7b e2 80 a6 7d 20 20 20 20 20 20  urls {...}      
0b60: 20 7c 20 2a 2a 2a 2a 2a 2a 2a 2d 55 52 4c 20 20   | *******-URL  
0b70: 20 20 20 20 7c 20 54 69 74 6c 65 20 3d 20 68 74      | Title = ht
0b80: 74 70 3a 2f 2f 2e 2e 2e 0d 0a 20 20 20 20 20 52  tp://.....     R
0b90: 45 4c 45 41 53 45 20 20 7c 20 20 64 6f 77 6e 6c  ELEASE  |  downl
0ba0: 6f 61 64 20 20 20 20 20 20 20 7c 20 20 64 6f 77  oad       |  dow
0bb0: 6e 6c 6f 61 64 20 20 20 20 20 20 20 7c 20 44 6f  nload       | Do
0bc0: 77 6e 6c 6f 61 64 2d 55 52 4c 20 20 20 20 20 7c  wnload-URL     |
0bd0: 20 68 74 74 70 3a 2f 2f 73 66 2e 6e 65 74 0d 0a   http://sf.net..
0be0: 20 20 20 20 20 52 45 4c 45 41 53 45 20 20 7c 20       RELEASE  | 
0bf0: 20 76 65 72 73 69 6f 6e 20 20 20 20 20 20 20 20   version        
0c00: 7c 20 20 76 65 72 73 69 6f 6e 20 20 20 20 20 20  |  version      
0c10: 20 20 7c 20 56 65 72 73 69 6f 6e 20 20 20 20 20    | Version     
0c20: 20 20 20 20 20 7c 20 31 2e 30 2e 33 2d 72 63 35       | 1.0.3-rc5
0c30: 0d 0a 20 20 20 20 20 52 45 4c 45 41 53 45 20 20  ..     RELEASE  
0c40: 7c 20 20 63 68 61 6e 67 65 73 20 20 20 20 20 20  |  changes      
0c50: 20 20 7c 20 20 63 68 61 6e 67 65 73 20 20 20 20    |  changes    
0c60: 20 20 20 20 7c 20 43 68 61 6e 67 65 73 20 20 20      | Changes   
0c70: 20 20 20 20 20 20 20 7c 20 41 64 64 65 64 20 58         | Added X
0c80: 79 2e 20 46 69 78 65 64 20 5a 79 2e 0d 0a 20 20  y. Fixed Zy...  
0c90: 20 20 20 52 45 4c 45 41 53 45 20 20 7c 20 20 68     RELEASE  |  h
0ca0: 69 64 64 65 6e 20 20 20 20 20 20 20 20 20 7c 20  idden         | 
0cb0: 60 68 69 64 65 60 20 20 20 20 20 20 20 20 20 20  `hide`          
0cc0: 7c 20 48 69 64 65 20 20 20 20 20 20 20 20 20 20  | Hide          
0cd0: 20 20 20 7c 20 30 0d 0a 20 20 20 20 20 52 45 4c     | 0..     REL
0ce0: 45 41 53 45 20 20 7c 20 20 73 74 61 74 65 20 20  EASE  |  state  
0cf0: 20 20 20 20 20 20 20 20 7c 20 60 72 65 6c 65 61          | `relea
0d00: 73 65 5f 74 61 67 73 60 20 20 7c 20 52 65 6c 65  se_tags`  | Rele
0d10: 61 73 65 2d 54 61 67 2d 4c 69 73 74 20 7c 20 73  ase-Tag-List | s
0d20: 74 61 62 6c 65 0d 0a 20 20 20 20 20 52 45 4c 45  table..     RELE
0d30: 41 53 45 20 20 7c 20 20 73 63 6f 70 65 20 20 20  ASE  |  scope   
0d40: 20 20 20 20 20 20 20 7c 20 60 72 65 6c 65 61 73         | `releas
0d50: 65 5f 74 61 67 73 60 20 20 7c 20 52 65 6c 65 61  e_tags`  | Relea
0d60: 73 65 2d 54 61 67 2d 4c 69 73 74 20 7c 20 6d 69  se-Tag-List | mi
0d70: 6e 6f 72 2c 20 62 75 67 66 69 78 0d 0a 20 43 52  nor, bugfix.. CR
0d80: 45 41 54 45 20 20 20 20 20 20 20 7c 20 20 73 75  EATE       |  su
0d90: 62 6d 69 74 74 65 72 20 20 20 20 20 20 7c 20 20  bmitter      |  
0da0: 61 75 74 68 6f 72 20 20 20 20 20 20 20 20 20 7c  author         |
0db0: 20 41 75 74 68 6f 72 20 20 20 20 20 20 20 20 20   Author         
0dc0: 20 20 7c 20 42 6f 62 0d 0a 20 43 52 45 41 54 45    | Bob.. CREATE
0dd0: 20 20 20 20 20 20 20 7c 20 20 73 75 62 6d 69 74         |  submit
0de0: 74 65 72 5f 69 6d 67 20 20 7c 20 20 2d 20 20 20  ter_img  |  -   
0df0: 20 20 20 20 20 20 20 20 20 20 20 7c 20 41 75 74             | Aut
0e00: 68 6f 72 20 20 20 20 20 20 20 20 20 20 20 7c 20  hor           | 
0e10: 42 6f 62 2c 20 62 6f 62 40 67 69 74 75 62 0d 0a  Bob, bob@gitub..
0e20: 20 20 20 20 20 20 2d 20 20 20 20 20 20 20 7c 20        -       | 
0e30: 20 65 64 69 74 6f 72 5f 6e 6f 74 65 20 20 20 20   editor_note    
0e40: 7c 20 20 2d 20 20 20 20 20 20 20 20 20 20 20 20  |  -            
0e50: 20 20 7c 20 2d 20 20 20 20 20 20 20 20 20 20 20    | -           
0e60: 20 20 20 20 20 7c 20 2d 20 20 0d 0a 20 20 20 20       | -  ..    
0e70: 20 20 2d 20 20 20 20 20 20 20 7c 20 20 66 6c 61    -       |  fla
0e80: 67 20 20 20 20 20 20 20 20 20 20 20 7c 20 20 2d  g           |  -
0e90: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 7c 20                | 
0ea0: 2d 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20  -               
0eb0: 20 7c 20 2d 20 20 0d 0a 20 43 52 45 41 54 45 20   | -  .. CREATE 
0ec0: 20 20 20 20 20 20 7c 20 20 6c 6f 63 6b 20 20 20        |  lock   
0ed0: 20 20 20 20 20 20 20 20 7c 20 20 60 3c 61 75 74          |  `<aut
0ee0: 68 5f 63 6f 64 65 3e 60 20 20 7c 20 3c 6b 62 64  h_code>`  | <kbd
0ef0: 3e 2e 6e 65 74 72 63 3c 2f 6b 62 64 3e 7c 20 2d  >.netrc</kbd>| -
0f00: 0d 0a 20 20 20 20 20 20 2d 20 20 20 20 20 20 20  ..      -       
0f10: 7c 20 20 73 6f 63 69 61 6c 5f 6c 69 6e 6b 73 20  |  social_links 
0f20: 20 20 7c 20 20 2d 20 20 20 20 20 20 20 20 20 20    |  -          
0f30: 20 20 20 20 7c 20 2d 20 20 20 20 20 20 20 20 20      | -         
0f40: 20 20 20 20 20 20 20 7c 20 2d 20 20 0d 0a 20 20         | -  ..  
0f50: 20 20 20 20 2d 20 20 20 20 20 20 20 7c 20 20 61      -       |  a
0f60: 75 74 6f 75 70 64 61 74 65 5f 2a 20 20 20 7c 20  utoupdate_*   | 
0f70: 20 2d 20 20 20 20 20 20 20 20 20 20 20 20 20 20   -              
0f80: 7c 20 2d 20 20 20 20 20 20 20 20 20 20 20 20 20  | -             
0f90: 20 20 20 7c 20 2d 20 20 0d 0a 20 20 20 20 20 20     | -  ..      
0fa0: 20 44 45 4c 45 54 45 20 7c 20 20 6e 61 6d 65 20   DELETE |  name 
0fb0: 20 20 20 20 20 20 20 20 20 20 7c 20 20 60 3c 6e            |  `<n
0fc0: 61 6d 65 3e 60 20 20 20 20 20 20 20 7c 20 2d 50  ame>`       | -P
0fd0: 20 6e 61 6d 65 20 20 20 20 20 20 20 20 20 20 7c   name          |
0fe0: 20 75 6e 69 78 2d 6e 61 6d 65 0d 0a 20 20 20 20   unix-name..    
0ff0: 20 20 20 44 45 4c 45 54 45 20 7c 20 20 64 65 6c     DELETE |  del
1000: 65 74 65 64 20 20 20 20 20 20 20 20 7c 20 60 3c  eted        | `<
1010: 76 65 72 73 69 6f 6e 73 74 72 3e 60 20 20 7c 20  versionstr>`  | 
1020: 2d 64 20 20 20 20 20 20 20 20 20 20 20 20 20 20  -d              
1030: 20 7c 20 31 2e 30 2e 33 2d 72 63 35 20 20 0d 0a   | 1.0.3-rc5  ..
1040: 0d 0a 0d 0a 2d 20 52 65 6e 61 6d 65 64 3a 20 60  ....- Renamed: `
1050: 70 65 72 6d 61 6c 69 6e 6b 60 20 e2 86 92 20 60  permalink` ... `
1060: 6e 61 6d 65 60 2c 20 61 6e 64 20 60 63 68 61 6e  name`, and `chan
1070: 67 65 6c 6f 67 60 20 e2 86 92 20 60 63 68 61 6e  gelog` ... `chan
1080: 67 65 73 60 0d 0a 2d 20 4e 65 77 3a 20 60 74 69  ges`..- New: `ti
1090: 74 6c 65 60 2c 20 60 73 75 6d 6d 61 72 79 60 20  tle`, `summary` 
10a0: 28 6f 6e 65 6c 69 6e 65 72 29 2c 20 60 75 72 6c  (oneliner), `url
10b0: 73 60 20 61 73 20 64 69 63 74 20 7b e2 80 a6 7d  s` as dict {...}
10c0: 2c 20 60 61 75 74 68 6f 72 60 20 66 6f 72 20 60  , `author` for `
10d0: 73 75 62 6d 69 74 74 65 72 60 0d 0a 2d 20 43 68  submitter`..- Ch
10e0: 61 6e 67 65 73 3a 20 60 70 72 6f 6a 65 63 74 5f  anges: `project_
10f0: 74 61 67 5f 6c 69 73 74 60 20 69 73 20 6e 6f 77  tag_list` is now
1100: 20 60 70 72 6f 6a 65 63 74 5f 74 61 67 5f 6c 69   `project_tag_li
1110: 73 74 60 20 61 6e 64 20 43 53 56 20 74 65 78 74  st` and CSV text
1120: 20 69 6e 73 74 65 61 64 20 6f 66 0d 0a 20 20 61   instead of..  a
1130: 20 4a 53 4f 4e 20 6c 69 73 74 2c 20 73 61 6d 65   JSON list, same
1140: 20 66 6f 72 20 60 6c 69 63 65 6e 73 65 5f 6c 69   for `license_li
1150: 73 74 60 20 77 69 74 68 20 73 70 61 63 69 6e 67  st` with spacing
1160: 20 69 72 72 65 6c 65 76 61 6e 74 0d 0a 2d 20 60   irrelevant..- `
1170: 72 65 6c 65 61 73 65 5f 74 61 67 73 60 20 63 6f  release_tags` co
1180: 75 6c 64 20 70 65 72 68 61 70 73 20 62 65 20 73  uld perhaps be s
1190: 70 6c 69 74 20 75 70 2c 20 62 75 74 20 74 68 65  plit up, but the
11a0: 20 75 70 64 61 74 65 20 68 61 6e 64 6c 65 72 20   update handler 
11b0: 69 74 73 65 6c 66 20 73 65 70 61 72 61 74 65 73  itself separates
11c0: 0d 0a 20 20 22 73 74 61 62 6c 65 2f 62 65 74 61  ..  "stable/beta
11d0: 2f 70 72 65 72 65 6c 65 61 73 65 22 20 66 72 6f  /prerelease" fro
11e0: 6d 20 22 6d 69 6e 6f 72 2f 6d 61 6a 6f 72 2f 62  m "minor/major/b
11f0: 75 67 66 69 78 2f 66 65 61 74 75 72 65 2f 73 65  ugfix/feature/se
1200: 63 75 72 69 74 79 22 20 65 74 63 2e 0d 0a 2d 20  curity" etc...- 
1210: 49 6e 74 65 72 6e 61 6c 20 2f 20 55 6e 61 73 73  Internal / Unass
1220: 69 67 6e 65 64 20 79 65 74 3a 20 60 65 64 69 74  igned yet: `edit
1230: 6f 72 5f 6e 6f 74 65 60 2c 20 60 66 6c 61 67 60  or_note`, `flag`
1240: 2c 20 60 6c 6f 63 6b 60 2c 20 60 73 6f 63 69 61  , `lock`, `socia
1250: 6c 5f 6c 69 6e 6b 73 60 2c 0d 0a 20 20 60 61 75  l_links`,..  `au
1260: 74 6f 75 70 64 61 74 65 5f 2a 2a 2a 60 0d 0a 0d  toupdate_***`...
1270: 0a 0d 0a 23 23 23 20 41 75 74 68 6f 72 69 7a 61  ...### Authoriza
1280: 74 69 6f 6e 3a 0d 0a 0d 0a 41 6c 6c 20 72 65 71  tion:....All req
1290: 75 65 73 74 73 20 63 61 6e 20 61 70 70 65 6e 64  uests can append
12a0: 20 61 6e 20 60 3f 61 75 74 68 5f 63 6f 64 65 3d   an `?auth_code=
12b0: 60 20 74 6f 20 72 65 71 75 65 73 74 20 55 52 4c  ` to request URL
12c0: 73 20 74 6f 20 63 61 72 72 79 20 61 20 70 6c 61  s to carry a pla
12d0: 69 6e 20 70 61 73 73 77 6f 72 64 2e 0d 0a 57 68  in password...Wh
12e0: 69 63 68 20 69 73 20 70 72 69 6d 61 72 69 6c 79  ich is primarily
12f0: 20 75 73 65 64 20 77 69 74 68 20 74 68 65 20 3c   used with the <
1300: 6b 62 64 3e 44 45 4c 45 54 45 3c 2f 6b 62 64 3e  kbd>DELETE</kbd>
1310: 20 6d 65 74 68 6f 64 2e 20 54 68 65 20 3c 6b 62   method. The <kb
1320: 64 3e 47 45 54 3c 2f 6b 62 64 3e 20 6d 65 74 68  d>GET</kbd> meth
1330: 6f 64 0d 0a 6f 6e 6c 79 20 68 69 64 65 73 20 61  od..only hides a
1340: 20 66 65 77 20 69 6e 74 65 72 6e 61 6c 20 66 69   few internal fi
1350: 65 6c 64 73 20 77 68 65 6e 20 75 6e 61 75 74 68  elds when unauth
1360: 6f 72 69 7a 65 64 2e 0d 0a 0d 0a 3c 6b 62 64 3e  orized.....<kbd>
1370: 50 4f 53 54 3c 2f 6b 62 64 3e 2f 3c 6b 62 64 3e  POST</kbd>/<kbd>
1380: 50 55 54 3c 2f 6b 62 64 3e 2f 65 74 63 2e 20 72  PUT</kbd>/etc. r
1390: 65 71 75 65 73 74 73 20 69 6e 73 74 65 61 64 20  equests instead 
13a0: 73 68 6f 75 6c 64 20 77 72 61 70 20 74 68 65 0d  should wrap the.
13b0: 0a 70 61 73 73 77 6f 72 64 20 6f 75 74 65 72 6d  .password outerm
13c0: 6f 73 74 20 69 6e 20 74 68 65 20 4a 53 4f 4e 20  ost in the JSON 
13d0: 70 61 79 6c 6f 61 64 3a 0d 0a 0d 0a 20 20 20 20  payload:....    
13e0: 7b 0d 0a 20 20 20 20 20 20 20 20 22 61 75 74 68  {..        "auth
13f0: 5f 63 6f 64 65 22 3a 20 22 70 6c 61 69 6e 5f 70  _code": "plain_p
1400: 77 5f 31 32 33 22 2c 0d 0a 20 20 20 20 20 20 20  w_123",..       
1410: 20 22 70 72 6f 6a 65 63 74 22 3a 20 7b 0d 0a 20   "project": {.. 
1420: 20 20 20 20 20 20 20 20 20 20 20 22 6b 65 79 22             "key"
1430: 3a 20 22 56 61 6c 75 65 22 2c 0d 0a 20 20 20 20  : "Value",..    
1440: 20 20 20 20 20 20 20 20 2e 2e 2e 0d 0a 20 20 20          .....   
1450: 20 20 20 20 20 7d 0d 0a 20 20 20 20 7d 0d 0a 0d       }..    }...
1460: 0a 0d 0a 23 23 20 51 75 65 72 79 20 3c 6b 62 64  ...## Query <kbd
1470: 3e 47 45 54 3c 2f 6b 62 64 3e 20 60 2f 70 72 6f  >GET</kbd> `/pro
1480: 6a 65 63 74 73 2f 3c 6e 61 6d 65 3e 2e 6a 73 6f  jects/<name>.jso
1490: 6e 60 0d 0a 0d 0a 52 65 74 75 72 6e 73 20 61 6e  n`....Returns an
14a0: 20 61 6c 6d 6f 73 74 20 6c 69 74 65 72 61 6c 20   almost literal 
14b0: 64 61 74 61 62 61 73 65 20 64 75 6d 70 3a 0d 0a  database dump:..
14c0: 0d 0a 20 20 20 20 7b 0d 0a 20 20 20 20 20 20 20  ..    {..       
14d0: 20 22 70 72 6f 6a 65 63 74 22 3a 20 7b 0d 0a 20   "project": {.. 
14e0: 20 20 20 20 20 20 20 20 20 20 20 22 6e 61 6d 65             "name
14f0: 22 3a 20 22 66 6f 6f 2d 62 61 72 22 2c 0d 0a 20  ": "foo-bar",.. 
1500: 20 20 20 20 20 20 20 20 20 20 20 22 74 69 74 6c             "titl
1510: 65 22 3a 20 22 46 6f 6f 20 42 61 72 22 2c 0d 0a  e": "Foo Bar",..
1520: 20 20 20 20 20 20 20 20 20 20 20 20 22 73 75 6d              "sum
1530: 6d 61 72 79 22 3a 20 22 69 43 61 6c 2d 63 6f 6d  mary": "iCal-com
1540: 70 61 74 69 62 6c 65 20 63 61 6c 65 6e 64 61 72  patible calendar
1550: 69 6e 67 20 61 70 70 22 2c 0d 0a 20 20 20 20 20  ing app",..     
1560: 20 20 20 20 20 20 20 22 64 65 73 63 72 69 70 74         "descript
1570: 69 6f 6e 22 3a 20 22 48 65 72 65 20 63 6f 6d 65  ion": "Here come
1580: 73 20 61 20 76 65 72 79 20 6c 6f 6e 67 20 64 65  s a very long de
1590: 73 63 72 69 70 74 69 6f 6e 20 2e 2e 2e 22 2c 0d  scription ...",.
15a0: 0a 20 20 20 20 20 20 20 20 20 20 20 20 22 69 6d  .            "im
15b0: 61 67 65 22 3a 20 22 22 2c 0d 0a 20 20 20 20 20  age": "",..     
15c0: 20 20 20 20 20 20 20 22 61 75 74 68 6f 72 22 3a         "author":
15d0: 20 22 42 6f 62 22 2c 0d 0a 20 20 20 20 20 20 20   "Bob",..       
15e0: 20 20 20 20 20 22 6c 69 63 65 6e 73 65 5f 6c 69       "license_li
15f0: 73 74 22 3a 20 22 4d 49 54 4c 2c 20 43 43 2d 42  st": "MITL, CC-B
1600: 59 2d 53 41 22 2c 0d 0a 20 20 20 20 20 20 20 20  Y-SA",..        
1610: 20 20 20 20 22 70 72 6f 6a 65 63 74 5f 74 61 67      "project_tag
1620: 73 22 3a 20 22 64 65 73 6b 74 6f 70 2c 20 63 2b  s": "desktop, c+
1630: 2b 2c 20 71 74 35 2c 20 63 61 6c 65 6e 64 61 72  +, qt5, calendar
1640: 22 2c 0d 0a 20 20 20 20 20 20 20 20 20 20 20 20  ",..            
1650: 22 68 6f 6d 65 70 61 67 65 22 3a 20 22 68 74 74  "homepage": "htt
1660: 70 3a 2f 2f 65 78 61 6d 70 6c 65 2e 6f 72 67 22  p://example.org"
1670: 2c 0d 0a 20 20 20 20 20 20 20 20 20 20 20 20 22  ,..            "
1680: 64 6f 77 6e 6c 6f 61 64 22 3a 20 22 68 74 74 70  download": "http
1690: 3a 2f 2f 65 78 61 6d 70 6c 65 2e 6f 72 67 2f 64  ://example.org/d
16a0: 77 6e 6c 64 2f 22 2c 0d 0a 20 20 20 20 20 20 20  wnld/",..       
16b0: 20 20 20 20 20 22 75 72 6c 73 22 3a 20 7b 0d 0a       "urls": {..
16c0: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20                  
16d0: 22 48 6f 6d 65 70 61 67 65 22 3a 20 22 68 74 74  "Homepage": "htt
16e0: 70 3a 2f 2f 65 78 61 6d 70 6c 65 2e 6f 72 67 22  p://example.org"
16f0: 2c 0d 0a 20 20 20 20 20 20 20 20 20 20 20 20 20  ,..             
1700: 20 20 20 22 43 68 61 6e 67 65 6c 6f 67 22 3a 20     "Changelog": 
1710: 22 68 74 74 70 73 3a 2f 2f 65 78 61 6d 70 6c 65  "https://example
1720: 2e 6f 72 67 2f 64 6f 77 6e 6c 2f 4e 45 57 53 2e  .org/downl/NEWS.
1730: 6d 64 22 2c 0d 0a 20 20 20 20 20 20 20 20 20 20  md",..          
1740: 20 20 20 20 20 20 22 44 45 42 22 3a 20 22 68 74        "DEB": "ht
1750: 74 70 3a 2f 2f 65 78 61 6d 70 6c 65 2e 6f 72 67  tp://example.org
1760: 2f 64 6f 77 6e 6c 2f 66 6f 6f 2d 62 61 72 5f 31  /downl/foo-bar_1
1770: 2e 64 65 62 22 2c 0d 0a 20 20 20 20 20 20 20 20  .deb",..        
1780: 20 20 20 20 20 20 20 20 22 44 6f 77 6e 6c 6f 61          "Downloa
1790: 64 22 3a 20 22 68 74 74 70 3a 2f 2f 65 78 61 6d  d": "http://exam
17a0: 70 6c 65 2e 6f 72 67 2f 64 77 6e 6c 64 2f 22 0d  ple.org/dwnld/".
17b0: 0a 20 20 20 20 20 20 20 20 20 20 20 20 7d 2c 0d  .            },.
17c0: 0a 20 20 20 20 20 20 20 20 20 20 20 20 22 76 65  .            "ve
17d0: 72 73 69 6f 6e 22 3a 20 22 35 2e 30 2e 31 22 2c  rsion": "5.0.1",
17e0: 0d 0a 20 20 20 20 20 20 20 20 20 20 20 20 22 73  ..            "s
17f0: 74 61 74 65 22 3a 20 22 73 74 61 62 6c 65 22 2c  tate": "stable",
1800: 0d 0a 20 20 20 20 20 20 20 20 20 20 20 20 22 73  ..            "s
1810: 63 6f 70 65 22 3a 20 22 6d 69 6e 6f 72 20 62 75  cope": "minor bu
1820: 67 66 69 78 22 2c 0d 0a 20 20 20 20 20 20 20 20  gfix",..        
1830: 20 20 20 20 22 72 65 6c 65 61 73 65 5f 74 61 67      "release_tag
1840: 73 22 3a 20 22 73 74 61 62 6c 65 2c 20 6d 69 6e  s": "stable, min
1850: 6f 72 20 62 75 67 66 69 78 22 2c 0d 0a 20 20 20  or bugfix",..   
1860: 20 20 20 20 20 20 20 20 20 22 63 68 61 6e 67 65           "change
1870: 73 22 3a 20 22 46 69 78 65 64 20 74 68 65 20 74  s": "Fixed the t
1880: 68 69 6e 67 2c 20 61 6e 64 20 61 64 64 65 64 20  hing, and added 
1890: 74 68 65 20 73 74 75 66 66 2e 22 2c 0d 0a 20 20  the stuff.",..  
18a0: 20 20 20 20 20 20 20 20 20 20 22 64 6f 77 6e 6c            "downl
18b0: 6f 61 64 22 3a 20 22 68 74 74 70 3a 2f 2f 65 78  oad": "http://ex
18c0: 61 6d 70 6c 65 2e 6f 72 67 2f 64 77 6e 6c 64 2f  ample.org/dwnld/
18d0: 22 2c 0d 0a 20 20 20 20 20 20 20 20 20 20 20 20  ",..            
18e0: 22 74 5f 70 75 62 6c 69 73 68 65 64 22 3a 20 22  "t_published": "
18f0: 31 34 32 37 34 36 31 35 30 31 22 2c 0d 0a 20 20  1427461501",..  
1900: 20 20 20 20 20 20 20 20 20 20 22 74 5f 63 68 61            "t_cha
1910: 6e 67 65 64 22 3a 20 22 31 34 35 32 34 31 33 31  nged": "14524131
1920: 33 35 22 0d 0a 20 20 20 20 20 20 20 20 7d 2c 0d  35"..        },.
1930: 0a 20 20 20 20 20 20 20 20 22 24 66 65 65 64 2d  .        "$feed-
1940: 6c 69 63 65 6e 73 65 22 3a 20 22 43 43 2d 42 59  license": "CC-BY
1950: 2d 53 41 20 33 2e 30 22 2c 0d 0a 20 20 20 20 20  -SA 3.0",..     
1960: 20 20 20 22 24 66 65 65 64 2d 6f 72 69 67 69 6e     "$feed-origin
1970: 22 3a 20 22 68 74 74 70 3a 2f 2f 66 72 65 73 68  ": "http://fresh
1980: 63 6f 64 65 2e 63 6c 75 62 2f 22 0d 0a 20 20 20  code.club/"..   
1990: 20 7d 0d 0a 0d 0a 54 68 65 20 72 65 6c 65 61 73   }....The releas
19a0: 65 20 66 69 65 6c 64 73 20 28 73 65 63 6f 6e 64  e fields (second
19b0: 20 68 61 6c 66 20 69 6e 20 74 68 65 20 65 78 61   half in the exa
19c0: 6d 70 6c 65 29 20 72 65 70 72 65 73 65 6e 74 20  mple) represent 
19d0: 74 68 65 20 6c 61 74 65 73 74 0d 0a 6b 6e 6f 77  the latest..know
19e0: 6e 20 76 65 72 73 69 6f 6e 2e 0d 0a 0d 0a 20 20  n version.....  
19f0: 2a 20 54 68 65 20 55 52 4c 73 20 61 72 65 20 70  * The URLs are p
1a00: 61 72 74 6c 79 20 64 75 70 6c 69 63 61 74 65 64  artly duplicated
1a10: 2e 20 42 65 63 61 75 73 65 20 22 68 6f 6d 65 70  . Because "homep
1a20: 61 67 65 22 20 61 6e 64 20 22 64 6f 77 6e 6c 6f  age" and "downlo
1a30: 61 64 22 20 61 72 65 0d 0a 20 20 20 20 63 6f 72  ad" are..    cor
1a40: 65 20 66 69 65 6c 64 73 2c 20 74 68 65 79 20 73  e fields, they s
1a50: 68 6f 77 20 75 70 20 69 6e 20 74 77 6f 20 70 6c  how up in two pl
1a60: 61 63 65 73 2e 0d 0a 20 20 2a 20 54 68 69 73 20  aces...  * This 
1a70: 47 45 54 20 72 65 73 70 6f 6e 73 65 20 62 6c 6f  GET response blo
1a80: 62 20 6d 69 67 68 74 20 63 61 72 72 79 20 61 20  b might carry a 
1a90: 66 65 77 20 6d 6f 72 65 20 69 6e 74 65 72 6e 61  few more interna
1aa0: 6c 20 66 69 65 6c 64 73 20 28 61 75 74 6f 75 70  l fields (autoup
1ab0: 64 61 74 65 5f 2a 2c 0d 0a 20 20 20 20 6c 6f 63  date_*,..    loc
1ac0: 6b 2c 20 74 5f 70 75 62 6c 69 73 68 65 64 2c 20  k, t_published, 
1ad0: 66 6c 61 67 2c 20 65 64 69 74 6f 72 5f 6e 6f 74  flag, editor_not
1ae0: 65 29 20 69 66 20 61 6e 20 60 3f 61 75 74 68 5f  e) if an `?auth_
1af0: 63 6f 64 65 3d 60 20 77 61 73 20 73 75 70 70 6c  code=` was suppl
1b00: 69 65 64 2e 0d 0a 0d 0a 0d 0a 23 23 20 55 70 64  ied.......## Upd
1b10: 61 74 65 20 63 6f 72 65 2b 72 65 6c 65 61 73 65  ate core+release
1b20: 20 3c 6b 62 64 3e 50 55 54 3c 2f 6b 62 64 3e 20   <kbd>PUT</kbd> 
1b30: 60 2f 70 72 6f 6a 65 63 74 73 2f 3c 6e 61 6d 65  `/projects/<name
1b40: 3e 2e 6a 73 6f 6e 60 0d 0a 0d 0a 46 6f 72 20 63  >.json`....For c
1b50: 68 61 6e 67 69 6e 67 20 67 65 6e 65 72 61 6c 20  hanging general 
1b60: 70 72 6f 6a 65 63 74 20 69 6e 66 6f 72 6d 61 74  project informat
1b70: 69 6f 6e 2c 20 61 6c 6c 20 66 69 65 6c 64 73 20  ion, all fields 
1b80: 63 61 6e 20 62 65 20 73 65 6e 74 20 77 72 61 70  can be sent wrap
1b90: 70 65 64 0d 0a 69 6e 20 74 68 65 20 73 61 6d 65  ped..in the same
1ba0: 20 73 74 72 75 63 74 75 72 65 2e 20 54 68 65 20   structure. The 
1bb0: 6f 6e 6c 79 20 64 69 66 66 65 72 65 6e 63 65 20  only difference 
1bc0: 69 73 20 74 68 65 20 72 65 71 75 69 72 65 64 20  is the required 
1bd0: 60 61 75 74 68 5f 63 6f 64 65 60 2e 0d 0a 0d 0a  `auth_code`.....
1be0: 20 20 20 20 7b 0d 0a 20 20 20 20 20 20 20 20 22      {..        "
1bf0: 61 75 74 68 5f 63 6f 64 65 22 3a 20 22 70 6c 61  auth_code": "pla
1c00: 69 6e 5f 70 77 5f 31 32 33 22 2c 0d 0a 20 20 20  in_pw_123",..   
1c10: 20 20 20 20 20 22 70 72 6f 6a 65 63 74 22 3a 20       "project": 
1c20: 7b 0d 0a 20 20 20 20 20 20 20 20 20 20 20 20 22  {..            "
1c30: 74 69 74 6c 65 22 3a 20 22 4e 65 77 20 54 69 74  title": "New Tit
1c40: 6c 65 22 2c 0d 0a 20 20 20 20 20 20 20 20 20 20  le",..          
1c50: 20 20 22 73 75 6d 6d 61 72 79 22 3a 20 22 53 68    "summary": "Sh
1c60: 6f 72 74 65 72 20 70 72 6f 6a 65 63 74 20 73 6c  orter project sl
1c70: 6f 67 61 6e 22 2c 0d 0a 20 20 20 20 20 20 20 20  ogan",..        
1c80: 20 20 20 20 22 64 65 73 63 72 69 70 74 69 6f 6e      "description
1c90: 22 3a 20 22 4e 65 77 20 61 6e 64 20 6c 6f 6e 67  ": "New and long
1ca0: 65 72 20 64 65 73 63 72 69 70 74 69 6f 6e 2e 2e  er description..
1cb0: 2e 22 2c 0d 0a 20 20 20 20 20 20 20 20 20 20 20  .",..           
1cc0: 20 22 69 6d 61 67 65 22 3a 20 22 68 74 74 70 3a   "image": "http:
1cd0: 2f 2f 6e 65 77 2e 70 6e 67 22 2c 0d 0a 20 20 20  //new.png",..   
1ce0: 20 20 20 20 20 20 20 20 20 22 6c 69 63 65 6e 73           "licens
1cf0: 65 5f 6c 69 73 74 22 3a 20 22 42 53 44 4c 22 2c  e_list": "BSDL",
1d00: 0d 0a 20 20 20 20 20 20 20 20 20 20 20 20 22 70  ..            "p
1d10: 72 6f 6a 65 63 74 5f 74 61 67 73 22 3a 20 22 71  roject_tags": "q
1d20: 74 36 2c 20 64 6c 61 6e 67 2c 20 64 65 73 6b 74  t6, dlang, deskt
1d30: 6f 70 2c 20 63 61 6c 65 6e 64 61 72 22 2c 0d 0a  op, calendar",..
1d40: 20 20 20 20 20 20 20 20 20 20 20 20 22 61 75 74              "aut
1d50: 68 6f 72 22 3a 20 22 45 6c 69 73 65 20 45 78 65  hor": "Elise Exe
1d60: 6d 70 6c 61 72 79 2c 20 64 6a 5f 69 63 61 6c 40  mplary, dj_ical@
1d70: 6c 61 75 6e 63 68 70 61 64 22 2c 0d 0a 20 20 20  launchpad",..   
1d80: 20 20 20 20 20 20 20 20 20 22 75 72 6c 73 22 3a           "urls":
1d90: 20 7b 0d 0a 20 20 20 20 20 20 20 20 20 20 20 20   {..            
1da0: 20 20 20 20 22 68 6f 6d 65 70 61 67 65 22 3a 20      "homepage": 
1db0: 22 68 74 74 70 3a 2f 2f 67 6f 6f 67 6c 65 2d 63  "http://google-c
1dc0: 6f 64 65 2e 63 6f 6d 22 2c 0d 0a 20 20 20 20 20  ode.com",..     
1dd0: 20 20 20 20 20 20 20 20 20 20 20 22 44 45 42 22             "DEB"
1de0: 3a 20 22 68 74 74 70 3a 2f 2f 65 78 61 6d 70 6c  : "http://exampl
1df0: 65 2e 6f 72 67 2f 53 45 43 4f 4e 44 2d 52 45 41  e.org/SECOND-REA
1e00: 4c 45 41 53 45 2e 64 65 62 22 2c 0d 0a 20 20 20  LEASE.deb",..   
1e10: 20 20 20 20 20 20 20 20 20 20 20 20 20 22 64 6f               "do
1e20: 77 6e 6c 6f 61 64 22 3a 20 22 68 74 74 70 3a 2f  wnload": "http:/
1e30: 2f 65 78 61 6d 70 6c 65 2e 6f 72 67 2f 64 77 6e  /example.org/dwn
1e40: 6c 64 2f 22 0d 0a 20 20 20 20 20 20 20 20 20 20  ld/"..          
1e50: 20 20 7d 2c 0d 0a 20 20 20 20 20 20 20 20 20 20    },..          
1e60: 20 20 22 76 65 72 73 69 6f 6e 22 3a 20 22 36 2e    "version": "6.
1e70: 30 2e 32 22 2c 0d 0a 20 20 20 20 20 20 20 20 20  0.2",..         
1e80: 20 20 20 22 72 65 6c 65 61 73 65 5f 74 61 67 73     "release_tags
1e90: 22 3a 20 22 73 74 61 62 6c 65 2c 20 6d 69 6e 6f  ": "stable, mino
1ea0: 72 20 62 75 67 66 69 78 2c 20 73 65 63 75 72 69  r bugfix, securi
1eb0: 74 79 22 2c 0d 0a 20 20 20 20 20 20 20 20 20 20  ty",..          
1ec0: 20 20 22 63 68 61 6e 67 65 73 22 3a 20 22 46 69    "changes": "Fi
1ed0: 78 65 64 20 74 68 65 20 74 68 69 6e 67 2c 20 61  xed the thing, a
1ee0: 6e 64 20 61 64 64 65 64 20 74 68 65 20 73 74 75  nd added the stu
1ef0: 66 66 2e 22 2c 0d 0a 20 20 20 20 20 20 20 20 20  ff.",..         
1f00: 20 20 20 22 64 6f 77 6e 6c 6f 61 64 22 3a 20 22     "download": "
1f10: 68 74 74 70 3a 2f 2f 65 78 61 6d 70 6c 65 2e 6f  http://example.o
1f20: 72 67 2f 64 77 6e 6c 64 2f 22 2c 0d 0a 20 20 20  rg/dwnld/",..   
1f30: 20 20 20 20 20 7d 0d 0a 20 20 20 20 7d 0d 0a 0d       }..    }...
1f40: 0a 4e 6f 77 20 69 6e 74 65 72 65 73 74 69 6e 67  .Now interesting
1f50: 6c 79 2c 20 74 68 69 73 20 73 63 68 65 6d 65 20  ly, this scheme 
1f60: 63 61 6e 20 62 65 20 75 73 65 64 20 74 6f 3a 0d  can be used to:.
1f70: 0a 20 0d 0a 20 31 2e 20 4a 75 73 74 20 75 70 64  . .. 1. Just upd
1f80: 61 74 65 20 74 68 65 20 62 61 73 69 63 20 70 72  ate the basic pr
1f90: 6f 6a 65 63 74 20 64 65 73 63 72 69 70 74 69 6f  oject descriptio
1fa0: 6e 2e 0d 0a 20 32 2e 20 4f 72 20 70 75 62 6c 69  n... 2. Or publi
1fb0: 73 68 20 6e 65 77 20 72 65 6c 65 61 73 65 20 22  sh new release "
1fc0: 76 65 72 73 69 6f 6e 22 20 61 6e 64 20 22 63 68  version" and "ch
1fd0: 61 6e 67 65 73 22 20 72 69 67 68 74 20 61 6c 6f  anges" right alo
1fe0: 6e 67 2e 0d 0a 0d 0a 45 69 74 68 65 72 2c 20 6f  ng.....Either, o
1ff0: 72 2c 20 61 6e 64 20 62 6f 74 68 2e 0d 0a 0d 0a  r, and both.....
2000: 0d 0a 23 23 23 23 20 53 65 63 74 69 6f 6e 65 64  ..#### Sectioned
2010: 20 76 61 72 69 61 6e 74 0d 0a 0d 0a 41 73 20 76   variant....As v
2020: 61 72 69 61 74 69 6f 6e 20 6f 66 20 74 68 61 74  ariation of that
2030: 2c 20 74 68 65 20 4a 53 4f 4e 20 73 74 72 75 63  , the JSON struc
2040: 74 20 2a 2a 2a 6d 61 79 2a 2a 2a 20 62 65 20 73  t ***may*** be s
2050: 70 6c 69 74 20 69 6e 74 6f 3a 0d 0a 0d 0a 20 20  plit into:....  
2060: 20 20 7b 0d 0a 20 20 20 20 20 20 20 20 22 61 75    {..        "au
2070: 74 68 5f 63 6f 64 65 22 3a 20 22 70 6c 61 69 6e  th_code": "plain
2080: 5f 70 77 5f 31 32 33 22 2c 0d 0a 20 20 20 20 20  _pw_123",..     
2090: 20 20 20 22 70 72 6f 6a 65 63 74 22 3a 20 7b 0d     "project": {.
20a0: 0a 20 20 20 20 20 20 20 20 20 20 20 20 22 74 69  .            "ti
20b0: 74 6c 65 22 3a 20 22 4e 65 77 20 54 69 74 6c 65  tle": "New Title
20c0: 22 2c 0d 0a 20 20 20 20 20 20 20 20 20 20 20 20  ",..            
20d0: 22 73 75 6d 6d 61 72 79 22 3a 20 22 53 68 6f 72  "summary": "Shor
20e0: 74 65 72 20 70 72 6f 6a 65 63 74 20 73 6c 6f 67  ter project slog
20f0: 61 6e 22 2c 0d 0a 20 20 20 20 20 20 20 20 20 20  an",..          
2100: 20 20 22 64 65 73 63 72 69 70 74 69 6f 6e 22 3a    "description":
2110: 20 22 4e 65 77 20 61 6e 64 20 6c 6f 6e 67 65 72   "New and longer
2120: 20 64 65 73 63 72 69 70 74 69 6f 6e 2e 2e 2e 22   description..."
2130: 2c 0d 0a 20 20 20 20 20 20 20 20 20 20 20 20 22  ,..            "
2140: 69 6d 61 67 65 22 3a 20 22 68 74 74 70 3a 2f 2f  image": "http://
2150: 6e 65 77 2e 70 6e 67 22 2c 0d 0a 20 20 20 20 20  new.png",..     
2160: 20 20 20 20 20 20 20 22 6c 69 63 65 6e 73 65 5f         "license_
2170: 6c 69 73 74 22 3a 20 22 42 53 44 4c 22 2c 0d 0a  list": "BSDL",..
2180: 20 20 20 20 20 20 20 20 20 20 20 20 22 70 72 6f              "pro
2190: 6a 65 63 74 5f 74 61 67 73 22 3a 20 22 71 74 36  ject_tags": "qt6
21a0: 2c 20 64 6c 61 6e 67 2c 20 64 65 73 6b 74 6f 70  , dlang, desktop
21b0: 2c 20 63 61 6c 65 6e 64 61 72 22 2c 0d 0a 20 20  , calendar",..  
21c0: 20 20 20 20 20 20 20 20 20 20 22 75 72 6c 73 22            "urls"
21d0: 3a 20 7b 0d 0a 20 20 20 20 20 20 20 20 20 20 20  : {..           
21e0: 20 20 20 20 20 22 68 6f 6d 65 70 61 67 65 22 3a       "homepage":
21f0: 20 22 68 74 74 70 3a 2f 2f 67 6f 6f 67 6c 65 2d   "http://google-
2200: 63 6f 64 65 2e 63 6f 6d 22 2c 0d 0a 20 20 20 20  code.com",..    
2210: 20 20 20 20 20 20 20 20 20 20 20 20 22 44 45 42              "DEB
2220: 22 3a 20 22 68 74 74 70 3a 2f 2f 65 78 61 6d 70  ": "http://examp
2230: 6c 65 2e 6f 72 67 2f 53 45 43 4f 4e 44 2d 52 45  le.org/SECOND-RE
2240: 41 4c 45 41 53 45 2e 64 65 62 22 2c 0d 0a 20 20  ALEASE.deb",..  
2250: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 22 64                "d
2260: 6f 77 6e 6c 6f 61 64 22 3a 20 22 68 74 74 70 3a  ownload": "http:
2270: 2f 2f 65 78 61 6d 70 6c 65 2e 6f 72 67 2f 64 77  //example.org/dw
2280: 6e 6c 64 2f 22 0d 0a 20 20 20 20 20 20 20 20 20  nld/"..         
2290: 20 20 20 7d 0d 0a 20 20 20 20 20 20 20 20 7d 2c     }..        },
22a0: 0d 0a 20 20 20 20 20 20 20 20 22 72 65 6c 65 61  ..        "relea
22b0: 73 65 22 3a 20 7b 0d 0a 20 20 20 20 20 20 20 20  se": {..        
22c0: 20 20 20 20 22 76 65 72 73 69 6f 6e 22 3a 20 22      "version": "
22d0: 36 2e 30 2e 32 22 2c 0d 0a 20 20 20 20 20 20 20  6.0.2",..       
22e0: 20 20 20 20 20 22 72 65 6c 65 61 73 65 5f 74 61       "release_ta
22f0: 67 73 22 3a 20 22 73 74 61 62 6c 65 2c 20 6d 69  gs": "stable, mi
2300: 6e 6f 72 20 62 75 67 66 69 78 22 2c 0d 0a 20 20  nor bugfix",..  
2310: 20 20 20 20 20 20 20 20 20 20 22 63 68 61 6e 67            "chang
2320: 65 73 22 3a 20 22 46 69 78 65 64 20 74 68 65 20  es": "Fixed the 
2330: 74 68 69 6e 67 2c 20 61 6e 64 20 61 64 64 65 64  thing, and added
2340: 20 74 68 65 20 73 74 75 66 66 2e 22 2c 0d 0a 20   the stuff.",.. 
2350: 20 20 20 20 20 20 20 20 20 20 20 22 64 6f 77 6e             "down
2360: 6c 6f 61 64 22 3a 20 22 68 74 74 70 3a 2f 2f 65  load": "http://e
2370: 78 61 6d 70 6c 65 2e 6f 72 67 2f 64 77 6e 6c 64  xample.org/dwnld
2380: 2f 22 2c 0d 0a 20 20 20 20 20 20 20 20 20 20 20  /",..           
2390: 20 22 68 69 64 65 22 3a 20 66 61 6c 73 65 2c 0d   "hide": false,.
23a0: 0a 20 20 20 20 20 20 20 20 7d 0d 0a 20 20 20 20  .        }..    
23b0: 7d 0d 0a 0d 0a 49 74 27 6c 6c 20 73 69 6d 70 6c  }....It'll simpl
23c0: 79 20 62 65 20 72 65 6a 6f 69 6e 65 64 20 73 65  y be rejoined se
23d0: 72 76 65 72 2d 73 69 64 65 2e 20 57 68 69 63 68  rver-side. Which
23e0: 20 64 6f 65 73 6e 27 74 20 6d 61 6b 65 20 61 20   doesn't make a 
23f0: 64 69 66 66 65 72 65 6e 63 65 0d 0a 74 6f 20 74  difference..to t
2400: 68 65 20 69 6e 74 65 72 6e 61 6c 20 64 61 74 61  he internal data
2410: 62 61 73 65 20 73 63 68 65 6d 65 2e 20 4d 69 67  base scheme. Mig
2420: 68 74 20 62 65 20 6d 6f 72 65 20 63 6f 6e 76 65  ht be more conve
2430: 6e 69 65 6e 74 20 74 6f 20 69 6d 70 6c 65 6d 65  nient to impleme
2440: 6e 74 2e 0d 0a 0d 0a 0d 0a 23 23 23 23 20 55 52  nt.......#### UR
2450: 4c 20 73 65 63 74 69 6f 6e 20 6d 6f 76 65 64 20  L section moved 
2460: 6f 75 74 0d 0a 0d 0a 41 6e 64 20 61 73 20 66 75  out....And as fu
2470: 72 74 68 65 72 20 76 61 72 69 61 74 69 6f 6e 2c  rther variation,
2480: 20 79 6f 75 20 63 61 6e 20 61 6c 73 6f 20 73 70   you can also sp
2490: 6c 69 74 20 6f 75 74 20 74 68 65 20 60 75 72 6c  lit out the `url
24a0: 3a 7b 7d 60 20 64 69 63 74 3a 0d 0a 0d 0a 20 20  :{}` dict:....  
24b0: 20 20 7b 0d 0a 20 20 20 20 20 20 20 20 22 61 75    {..        "au
24c0: 74 68 5f 63 6f 64 65 22 3a 20 22 70 6c 61 69 6e  th_code": "plain
24d0: 5f 70 77 5f 31 32 33 22 2c 0d 0a 20 20 20 20 20  _pw_123",..     
24e0: 20 20 20 22 70 72 6f 6a 65 63 74 22 3a 20 7b 0d     "project": {.
24f0: 0a 20 20 20 20 20 20 20 20 20 20 20 20 22 74 69  .            "ti
2500: 74 6c 65 22 3a 20 22 4e 65 77 20 54 69 74 6c 65  tle": "New Title
2510: 22 2c 0d 0a 20 20 20 20 20 20 20 20 20 20 20 20  ",..            
2520: 22 64 65 73 63 72 69 70 74 69 6f 6e 22 3a 20 22  "description": "
2530: 2e 2e 2e 2e 2e 2e 2e 2e 2e 2e 2e 2e 2e 2e 2e 2e  ................
2540: 22 0d 0a 20 20 20 20 20 20 20 20 20 20 20 20 22  "..            "
2550: 65 64 69 74 6f 72 5f 6e 6f 74 65 22 3a 20 22 50  editor_note": "P
2560: 6c 65 61 73 65 20 72 65 73 65 74 20 74 68 65 20  lease reset the 
2570: 73 6f 63 69 61 6c 20 62 6f 6f 6b 6d 61 72 6b 20  social bookmark 
2580: 63 6f 75 6e 74 65 72 21 0d 0a 20 20 20 20 20 20  counter!..      
2590: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20                  
25a0: 20 20 20 20 20 20 50 72 6f 6a 65 63 74 20 6d 6f        Project mo
25b0: 76 65 64 20 66 72 6f 6d 20 53 6f 75 72 63 65 66  ved from Sourcef
25c0: 6f 72 67 65 20 74 6f 20 47 69 74 48 75 62 2e 22  orge to GitHub."
25d0: 0d 0a 20 20 20 20 20 20 20 20 7d 2c 0d 0a 20 20  ..        },..  
25e0: 20 20 20 20 20 20 22 75 72 6c 73 22 3a 20 7b 0d        "urls": {.
25f0: 0a 20 20 20 20 20 20 20 20 20 20 20 20 22 68 6f  .            "ho
2600: 6d 65 70 61 67 65 22 3a 20 22 68 74 74 70 3a 2f  mepage": "http:/
2610: 2f 65 78 61 6d 70 6c 65 2e 6f 72 67 2f 22 2c 0d  /example.org/",.
2620: 0a 20 20 20 20 20 20 20 20 20 20 20 20 22 70 72  .            "pr
2630: 6f 70 72 69 65 74 61 72 79 2d 68 6f 73 74 65 72  oprietary-hoster
2640: 22 3a 20 22 68 74 74 70 3a 2f 2f 67 69 74 68 75  ": "http://githu
2650: 62 2e 63 6f 6d 2f 70 72 6f 6a 2f 6e 61 6d 65 2f  b.com/proj/name/
2660: 22 2c 0d 0a 20 20 20 20 20 20 20 20 20 20 20 20  ",..            
2670: 22 50 59 5a 2d 70 61 63 6b 61 67 65 22 3a 20 22  "PYZ-package": "
2680: 68 74 74 70 3a 2f 2f 65 78 61 6d 70 6c 65 2e 6f  http://example.o
2690: 72 67 2f 63 61 6c 65 6e 64 61 72 2e 70 79 7a 77  rg/calendar.pyzw
26a0: 22 2c 0d 0a 20 20 20 20 20 20 20 20 7d 0d 0a 20  ",..        }.. 
26b0: 20 20 20 20 20 20 20 22 72 65 6c 65 61 73 65 22         "release"
26c0: 3a 20 7b 0d 0a 20 20 20 20 20 20 20 20 20 20 20  : {..           
26d0: 20 22 76 65 72 73 69 6f 6e 22 3a 20 22 37 2e 35   "version": "7.5
26e0: 2e 33 22 2c 0d 0a 20 20 20 20 20 20 20 20 20 20  .3",..          
26f0: 20 20 22 63 68 61 6e 67 65 73 22 3a 20 22 52 6f    "changes": "Ro
2700: 6d 65 20 73 70 72 61 6e 67 20 75 70 2e 2e 2e 22  me sprang up..."
2710: 2c 0d 0a 20 20 20 20 20 20 20 20 7d 0d 0a 20 20  ,..        }..  
2720: 20 20 7d 0d 0a 0d 0a 54 68 65 20 41 50 49 20 69    }....The API i
2730: 73 20 70 72 65 74 74 79 20 6d 75 63 68 20 69 6e  s pretty much in
2740: 64 69 66 66 65 72 65 6e 74 20 69 66 20 74 68 69  different if thi
2750: 73 20 77 72 61 70 73 20 75 70 20 6a 75 73 74 20  s wraps up just 
2760: 74 68 65 20 22 70 72 6f 6a 65 63 74 22 0d 0a 62  the "project"..b
2770: 61 73 65 20 69 6e 66 6f 72 6d 61 74 69 6f 6e 2c  ase information,
2780: 20 61 20 6c 6f 6e 65 20 22 75 72 6c 73 22 20 64   a lone "urls" d
2790: 69 63 74 2c 20 6f 72 20 6a 75 73 74 20 61 20 22  ict, or just a "
27a0: 72 65 6c 65 61 73 65 22 20 6f 72 20 61 6e 79 0d  release" or any.
27b0: 0a 63 6f 6d 62 69 6e 61 74 69 6f 6e 20 74 68 65  .combination the
27c0: 72 65 6f 66 2e 0d 0a 0d 0a 0d 0a 23 23 20 55 52  reof.......## UR
27d0: 4c 73 20 64 69 63 74 20 3c 6b 62 64 3e 47 45 54  Ls dict <kbd>GET
27e0: 3c 2f 6b 62 64 3e 2f 3c 6b 62 64 3e 50 55 53 48  </kbd>/<kbd>PUSH
27f0: 3c 2f 6b 62 64 3e 20 60 2f 70 72 6f 6a 65 63 74  </kbd> `/project
2800: 73 2f 3c 6e 61 6d 65 3e 2f 75 72 6c 73 2e 6a 73  s/<name>/urls.js
2810: 6f 6e 60 0d 0a 0d 0a 54 68 65 72 65 27 73 20 73  on`....There's s
2820: 74 69 6c 6c 20 61 20 73 65 70 61 72 61 74 65 20  till a separate 
2830: 41 50 49 20 65 6e 64 70 6f 69 6e 74 20 66 6f 72  API endpoint for
2840: 20 6a 75 73 74 20 72 65 74 72 69 65 76 69 6e 67   just retrieving
2850: 20 6f 72 20 75 70 64 61 74 69 6e 67 0d 0a 74 68   or updating..th
2860: 65 20 55 52 4c 73 20 74 68 6f 75 67 68 3a 0d 0a  e URLs though:..
2870: 0d 0a 20 20 20 20 7b 0d 0a 20 20 20 20 20 20 20  ..    {..       
2880: 20 22 61 75 74 68 5f 63 6f 64 65 22 3a 20 22 70   "auth_code": "p
2890: 6c 61 69 6e 5f 70 77 5f 31 32 33 22 2c 0d 0a 20  lain_pw_123",.. 
28a0: 20 20 20 20 20 20 20 22 75 72 6c 73 22 3a 20 7b         "urls": {
28b0: 0d 0a 20 20 20 20 20 20 20 20 20 20 20 20 22 48  ..            "H
28c0: 6f 6d 65 70 61 67 65 22 3a 20 22 68 74 74 70 3a  omepage": "http:
28d0: 2f 2f 65 78 61 6d 70 6c 65 2e 6f 72 67 2f 22 2c  //example.org/",
28e0: 0d 0a 20 20 20 20 20 20 20 20 20 20 20 20 22 53  ..            "S
28f0: 63 72 65 65 6e 73 68 6f 74 22 3a 20 22 68 74 74  creenshot": "htt
2900: 70 3a 2f 2f 6c 61 75 6e 63 68 70 61 64 2e 63 6f  p://launchpad.co
2910: 6d 2f 70 72 6f 6a 2f 73 63 72 65 65 6e 73 68 6f  m/proj/screensho
2920: 74 2e 70 6e 67 22 2c 0d 0a 20 20 20 20 20 20 20  t.png",..       
2930: 20 20 20 20 20 22 43 75 73 74 6f 6d 2d 6c 69 6e       "Custom-lin
2940: 6b 22 3a 20 22 68 74 74 70 3a 2f 2f 65 78 61 6d  k": "http://exam
2950: 70 6c 65 2e 63 6f 6d 2f 73 68 61 72 65 2f 68 65  ple.com/share/he
2960: 6c 70 2f 43 2f 70 69 6e 67 2f 69 6e 64 65 78 2e  lp/C/ping/index.
2970: 70 61 67 65 22 2c 0d 0a 20 20 20 20 20 20 20 20  page",..        
2980: 7d 0d 0a 20 20 20 20 7d 0d 0a 0d 0a 4e 6f 74 65  }..    }....Note
2990: 20 74 68 61 74 20 61 20 70 72 6f 6a 65 63 74 73   that a projects
29a0: 20 22 68 6f 6d 65 70 61 67 65 22 20 6f 72 20 22   "homepage" or "
29b0: 64 6f 77 6e 6c 6f 61 64 22 20 6f 72 20 22 69 6d  download" or "im
29c0: 61 67 65 22 20 55 52 4c 20 6f 6e 6c 79 20 67 65  age" URL only ge
29d0: 74 0d 0a 75 70 64 61 74 65 64 20 77 68 65 6e 20  t..updated when 
29e0: 6c 69 73 74 65 64 20 68 65 72 65 69 6e 2e 20 41  listed herein. A
29f0: 6c 6c 20 6f 74 68 65 72 20 70 72 6f 6a 65 63 74  ll other project
2a00: 20 6c 69 6e 6b 73 20 67 65 74 20 63 6f 6d 70 6c   links get compl
2a10: 65 74 65 6c 79 0d 0a 64 69 73 63 61 72 64 65 64  etely..discarded
2a20: 20 61 6e 64 20 72 65 70 6c 61 63 65 64 20 62 79   and replaced by
2a30: 20 77 68 61 74 65 76 65 72 20 69 73 20 69 6e 20   whatever is in 
2a40: 74 68 65 20 6e 65 77 20 6c 69 73 74 2e 0d 0a 0d  the new list....
2a50: 0a 20 2a 20 49 6e 63 6f 6d 69 6e 67 20 6c 69 6e  . * Incoming lin
2a60: 6b 20 74 69 74 6c 65 73 20 61 72 65 20 2a 66 72  k titles are *fr
2a70: 65 65 2d 66 6f 72 6d 2a 2e 0d 0a 20 2a 20 54 68  ee-form*... * Th
2a80: 65 20 63 61 73 65 20 69 73 20 70 72 65 73 65 72  e case is preser
2a90: 76 65 64 20 66 6f 72 20 63 75 73 74 6f 6d 20 65  ved for custom e
2aa0: 6e 74 72 69 65 73 2e 0d 0a 20 2a 20 4e 6f 6e 2d  ntries... * Non-
2ab0: 77 6f 72 64 20 63 68 61 72 61 63 74 65 72 73 20  word characters 
2ac0: 61 72 65 20 72 65 70 6c 61 63 65 64 2e 0d 0a 20  are replaced... 
2ad0: 2a 20 54 69 74 6c 65 73 20 77 69 6c 6c 20 61 6c  * Titles will al
2ae0: 77 61 79 73 20 62 65 20 73 74 6f 72 65 64 20 77  ways be stored w
2af0: 69 74 68 20 22 44 61 73 68 65 64 2d 4e 61 6d 65  ith "Dashed-Name
2b00: 73 22 20 28 69 74 27 73 20 69 6e 74 65 72 6e 61  s" (it's interna
2b10: 6c 6c 79 0d 0a 20 20 20 61 20 60 4b 65 79 3d 55  lly..   a `Key=U
2b20: 72 6c 60 20 74 65 78 74 2f 79 61 6d 6c 20 66 69  rl` text/yaml fi
2b30: 65 6c 64 29 2e 0d 0a 20 2a 20 54 68 65 20 63 6f  eld)... * The co
2b40: 72 65 20 55 52 4c 73 20 28 68 6f 6d 65 70 61 67  re URLs (homepag
2b50: 65 2c 20 64 6f 77 6e 6c 6f 61 64 2c 20 73 63 72  e, download, scr
2b60: 65 65 6e 73 68 6f 74 29 20 68 6f 77 65 76 65 72  eenshot) however
2b70: 20 61 72 65 20 61 6c 77 61 79 73 0d 0a 20 20 20   are always..   
2b80: 6c 6f 77 65 72 63 61 73 65 64 20 28 77 68 65 6e  lowercased (when
2b90: 20 72 65 74 75 72 6e 65 64 20 6f 6e 20 47 45 54   returned on GET
2ba0: 20 72 65 71 75 65 73 74 73 29 2e 0d 0a 20 2a 20   requests)... * 
2bb0: 54 68 65 20 41 50 49 20 69 73 20 69 6e 64 69 66  The API is indif
2bc0: 66 65 72 65 6e 74 20 69 66 20 79 6f 75 20 70 61  ferent if you pa
2bd0: 73 73 20 74 68 65 20 22 68 6f 6d 65 70 61 67 65  ss the "homepage
2be0: 22 20 6f 72 20 22 64 6f 77 6e 6c 6f 61 64 22 0d  " or "download".
2bf0: 0a 20 20 20 6c 69 6e 6b 20 61 73 20 6c 69 74 65  .   link as lite
2c00: 72 61 6c 20 60 70 72 6f 6a 65 63 74 3a 7b e2 80  ral `project:{..
2c10: a6 7d 60 20 64 69 63 74 20 65 6e 74 72 79 2c 20  .}` dict entry, 
2c20: 6f 72 20 77 72 61 70 70 65 64 20 69 6e 20 60 75  or wrapped in `u
2c30: 72 6c 73 3a 7b e2 80 a6 7d 60 2e 0d 0a 0d 0a 0d  rls:{...}`......
2c40: 0a 23 23 20 52 65 6c 65 61 73 65 20 70 75 62 6c  .## Release publ
2c50: 69 73 68 69 6e 67 20 3c 6b 62 64 3e 50 4f 53 54  ishing <kbd>POST
2c60: 3c 2f 6b 62 64 3e 20 60 2f 70 72 6f 6a 65 63 74  </kbd> `/project
2c70: 73 2f 3c 6e 61 6d 65 3e 2f 72 65 6c 65 61 73 65  s/<name>/release
2c80: 73 2e 6a 73 6f 6e 60 0d 0a 0d 0a 54 68 69 73 20  s.json`....This 
2c90: 69 73 20 65 6e 74 69 72 65 6c 79 20 72 65 64 75  is entirely redu
2ca0: 6e 64 61 6e 74 20 6e 6f 77 2e 20 42 75 74 20 61  ndant now. But a
2cb0: 20 6e 65 77 20 72 65 6c 65 61 73 65 20 63 61 6e   new release can
2cc0: 20 62 65 20 70 75 62 6c 69 73 68 65 64 0d 0a 77   be published..w
2cd0: 69 74 68 20 74 68 61 74 20 61 6c 74 65 72 6e 61  ith that alterna
2ce0: 74 69 76 65 20 55 52 4c 20 73 63 68 65 6d 65 2e  tive URL scheme.
2cf0: 20 49 74 27 73 20 62 61 73 69 63 61 6c 6c 79 20   It's basically 
2d00: 69 64 65 6e 74 69 63 61 6c 20 74 6f 0d 0a 22 50  identical to.."P
2d10: 55 54 20 60 2f 70 72 6f 6a 65 63 74 2f 3c 6e 61  UT `/project/<na
2d20: 6d 65 3e 2e 6a 73 6f 6e 60 22 20 6e 6f 77 3a 0d  me>.json`" now:.
2d30: 0a 0d 0a 20 20 20 20 7b 0d 0a 20 20 20 20 20 20  ...    {..      
2d40: 20 20 22 61 75 74 68 5f 63 6f 64 65 22 3a 20 22    "auth_code": "
2d50: 70 6c 61 69 6e 5f 70 77 5f 31 32 33 22 2c 0d 0a  plain_pw_123",..
2d60: 20 20 20 20 20 20 20 20 22 72 65 6c 65 61 73 65          "release
2d70: 22 3a 20 7b 0d 0a 20 20 20 20 20 20 20 20 20 20  ": {..          
2d80: 20 20 22 76 65 72 73 69 6f 6e 22 3a 20 22 30 2e    "version": "0.
2d90: 30 2e 31 22 2c 0d 0a 20 20 20 20 20 20 20 20 20  0.1",..         
2da0: 20 20 20 22 72 65 6c 65 61 73 65 5f 74 61 67 73     "release_tags
2db0: 22 3a 20 22 62 65 74 61 2c 20 63 6c 65 61 6e 75  ": "beta, cleanu
2dc0: 70 22 2c 0d 0a 20 20 20 20 20 20 20 20 20 20 20  p",..           
2dd0: 20 22 63 68 61 6e 67 65 73 22 3a 20 22 49 6e 69   "changes": "Ini
2de0: 74 69 61 6c 20 72 65 6c 65 61 73 65 2e 20 4e 6f  tial release. No
2df0: 20 64 6f 63 73 20 6f 72 20 63 6f 64 65 2e 22 2c   docs or code.",
2e00: 0d 0a 20 20 20 20 20 20 20 20 20 20 20 20 22 68  ..            "h
2e10: 69 64 65 22 3a 20 74 72 75 65 2c 0d 0a 20 20 20  ide": true,..   
2e20: 20 20 20 20 20 7d 0d 0a 20 20 20 20 7d 0d 0a 0d       }..    }...
2e30: 0a 4e 6f 74 65 20 74 68 61 74 20 65 76 65 6e 20  .Note that even 
2e40: 74 68 65 20 22 68 69 64 65 22 20 66 6c 61 67 20  the "hide" flag 
2e50: 69 73 20 61 6c 72 65 61 64 79 20 61 76 61 69 6c  is already avail
2e60: 61 62 6c 65 20 77 69 74 68 20 72 65 67 75 6c 61  able with regula
2e70: 72 0d 0a 70 72 6f 6a 65 63 74 20 50 55 54 20 2f  r..project PUT /
2e80: 20 63 6f 72 65 20 75 70 64 61 74 65 73 2e 0d 0a   core updates...
2e90: 0d 0a 0d 0a 23 23 20 57 69 74 68 64 72 61 77 5f  ....## Withdraw_
2ea0: 72 65 6c 65 61 73 65 20 3c 6b 62 64 3e 44 45 4c  release <kbd>DEL
2eb0: 45 54 45 3c 2f 6b 62 64 3e 20 60 2f 70 72 6f 6a  ETE</kbd> `/proj
2ec0: 65 63 74 73 2f 3c 6e 61 6d 65 3e 2f 3c 76 65 72  ects/<name>/<ver
2ed0: 73 69 6f 6e 73 74 72 3e 2e 6a 73 6f 6e 60 0d 0a  sionstr>.json`..
2ee0: 0d 0a 4e 6f 77 20 72 65 6c 65 61 73 65 20 72 65  ..Now release re
2ef0: 74 72 61 63 74 69 6f 6e 20 62 65 63 61 6d 65 20  traction became 
2f00: 73 69 6d 70 6c 65 72 20 61 73 20 77 65 6c 6c 2e  simpler as well.
2f10: 20 54 68 65 72 65 20 61 72 65 20 6e 6f 20 6c 6f   There are no lo
2f20: 6e 67 65 72 0d 0a 61 72 62 69 74 72 61 72 79 20  nger..arbitrary 
2f30: 6e 75 6d 65 72 69 63 20 49 44 73 20 65 78 70 6f  numeric IDs expo
2f40: 73 65 64 2e 20 28 54 68 65 79 20 77 65 72 65 20  sed. (They were 
2f50: 66 61 6b 65 64 20 61 6e 79 77 61 79 2e 29 0d 0a  faked anyway.)..
2f60: 0d 0a 49 6e 73 74 65 61 64 20 74 68 65 20 2a 6c  ..Instead the *l
2f70: 69 74 65 72 61 6c 20 76 65 72 73 69 6f 6e 20 6e  iteral version n
2f80: 75 6d 62 65 72 2a 20 20 63 61 6e 20 6e 6f 77 20  umber*  can now 
2f90: 62 65 20 75 73 65 64 20 74 6f 20 64 65 6c 65 74  be used to delet
2fa0: 65 0d 0a 61 20 72 65 6c 65 61 73 65 20 65 6e 74  e..a release ent
2fb0: 72 79 2e 0d 0a 0d 0a 20 20 2d 20 20 3c 6b 62 64  ry.....  -  <kbd
2fc0: 3e 44 45 4c 45 54 45 3c 2f 6b 62 64 3e 20 60 2f  >DELETE</kbd> `/
2fd0: 70 72 6f 6a 65 63 74 73 2f 3c 6e 61 6d 65 3e 2f  projects/<name>/
2fe0: 60 2a 31 2e 32 2e 33 2d 72 63 32 2a 60 2e 6a 73  `*1.2.3-rc2*`.js
2ff0: 6f 6e 3f 61 75 74 68 5f 63 6f 64 65 3d 70 77 31  on?auth_code=pw1
3000: 32 33 60 0d 0a 0d 0a 54 68 65 20 76 65 72 73 69  23`....The versi
3010: 6f 6e 20 73 74 72 69 6e 67 20 68 61 73 20 74 6f  on string has to
3020: 20 62 65 20 55 52 4c 2d 65 6e 63 6f 64 65 64 20   be URL-encoded 
3030: 61 73 20 6e 65 65 64 65 64 20 6f 66 20 63 6f 75  as needed of cou
3040: 72 73 65 2e 0d 0a 0d 0a 0d 0a 23 23 20 4e 65 77  rse.......## New
3050: 5f 70 72 6f 6a 65 63 74 20 3c 6b 62 64 3e 43 52  _project <kbd>CR
3060: 45 41 54 45 3c 2f 6b 62 64 3e 20 60 2f 70 72 6f  EATE</kbd> `/pro
3070: 6a 65 63 74 73 2f 3c 6e 61 6d 65 3e 2e 6a 73 6f  jects/<name>.jso
3080: 6e 60 0d 0a 0d 0a 54 68 65 20 4a 53 4f 4e 20 70  n`....The JSON p
3090: 61 79 6c 6f 61 64 20 66 6f 72 20 63 72 65 61 74  ayload for creat
30a0: 69 6e 67 20 61 20 6e 65 77 20 70 72 6f 6a 65 63  ing a new projec
30b0: 74 20 6d 69 67 68 74 20 6c 6f 6f 6b 20 66 61 6d  t might look fam
30c0: 69 6c 69 61 72 2e 0d 0a 57 65 6c 6c 20 69 6e 20  iliar...Well in 
30d0: 66 61 63 74 2c 20 2a 69 74 20 69 73 2a 20 69 64  fact, *it is* id
30e0: 65 6e 74 69 63 61 6c 20 74 6f 20 74 68 65 20 72  entical to the r
30f0: 65 67 75 6c 61 72 20 50 55 54 20 70 61 79 6c 6f  egular PUT paylo
3100: 61 64 3a 0d 0a 0d 0a 20 20 20 20 7b 0d 0a 20 20  ad:....    {..  
3110: 20 20 20 20 20 20 22 61 75 74 68 5f 63 6f 64 65        "auth_code
3120: 22 3a 20 22 74 68 69 73 3a 69 73 2d 61 2f 62 72  ": "this:is-a/br
3130: 61 6e 64 23 6e 65 77 2b 70 61 73 73 77 6f 72 64  and#new+password
3140: 5f 35 36 37 22 2c 0d 0a 20 20 20 20 20 20 20 20  _567",..        
3150: 22 70 72 6f 6a 65 63 74 22 3a 20 7b 0d 0a 20 20  "project": {..  
3160: 20 20 20 20 20 20 20 20 20 20 22 74 69 74 6c 65            "title
3170: 22 3a 20 22 49 6e 69 74 69 61 6c 20 54 69 74 6c  ": "Initial Titl
3180: 65 22 2c 0d 0a 20 20 20 20 20 20 20 20 20 20 20  e",..           
3190: 20 22 73 75 6d 6d 61 72 79 22 3a 20 22 4f 4e 45   "summary": "ONE
31a0: 4c 49 4e 45 52 22 2c 0d 0a 20 20 20 20 20 20 20  LINER",..       
31b0: 20 20 20 20 20 22 64 65 73 63 72 69 70 74 69 6f       "descriptio
31c0: 6e 22 3a 20 22 44 65 73 63 72 69 70 74 69 6f 6e  n": "Description
31d0: 20 52 45 51 55 49 52 45 44 2e 22 2c 0d 0a 20 20   REQUIRED.",..  
31e0: 20 20 20 20 20 20 20 20 20 20 22 70 72 6f 6a 65            "proje
31f0: 63 74 5f 74 61 67 73 22 3a 20 22 62 61 73 68 2c  ct_tags": "bash,
3200: 20 73 63 72 69 70 74 22 2c 0d 0a 20 20 20 20 20   script",..     
3210: 20 20 20 20 20 20 20 22 6c 69 63 65 6e 73 65 22         "license"
3220: 3a 20 6e 75 6c 6c 2c 0d 0a 20 20 20 20 20 20 20  : null,..       
3230: 20 20 20 20 20 22 61 75 74 68 6f 72 22 3a 20 22       "author": "
3240: 55 73 65 72 6e 61 6d 65 2c 20 75 73 65 72 40 6c  Username, user@l
3250: 6f 63 61 6c 68 6f 73 74 22 2c 0d 0a 20 20 20 20  ocalhost",..    
3260: 20 20 20 20 20 20 20 20 22 75 72 6c 73 22 3a 20          "urls": 
3270: 7b 0d 0a 20 20 20 20 20 20 20 20 20 20 20 20 20  {..             
3280: 20 20 20 22 73 63 72 65 65 6e 73 68 6f 74 22 3a     "screenshot":
3290: 20 6e 75 6c 6c 2c 0d 0a 20 20 20 20 20 20 20 20   null,..        
32a0: 20 20 20 20 20 20 20 20 22 48 6f 6d 65 70 61 67          "Homepag
32b0: 65 22 3a 20 22 68 74 74 70 3a 2f 2f 65 78 61 6d  e": "http://exam
32c0: 70 6c 65 2e 6f 72 67 2f 22 2c 0d 0a 20 20 20 20  ple.org/",..    
32d0: 20 20 20 20 20 20 20 20 7d 2c 0d 0a 20 20 20 20          },..    
32e0: 20 20 20 20 20 20 20 20 22 76 65 72 73 69 6f 6e          "version
32f0: 22 3a 20 6e 75 6c 6c 2c 0d 0a 20 20 20 20 20 20  ": null,..      
3300: 20 20 20 20 20 20 22 72 65 6c 65 61 73 65 5f 74        "release_t
3310: 61 67 73 22 3a 20 22 69 6e 69 74 69 61 6c 2c 20  ags": "initial, 
3320: 73 65 63 75 72 69 74 79 20 62 75 67 66 69 78 22  security bugfix"
3330: 2c 0d 0a 20 20 20 20 20 20 20 20 20 20 20 20 22  ,..            "
3340: 63 68 61 6e 67 65 73 22 3a 20 22 2e 2e 2e 22 0d  changes": "...".
3350: 0a 20 20 20 20 20 20 20 20 7d 0d 0a 20 20 20 20  .        }..    
3360: 7d 0d 0a 0d 0a 54 68 65 20 60 6e 75 6c 6c 60 20  }....The `null` 
3370: 66 69 65 6c 64 73 20 61 72 65 20 6a 75 73 74 20  fields are just 
3380: 66 6f 72 20 62 72 65 76 69 74 79 2e 20 49 6e 20  for brevity. In 
3390: 66 61 63 74 20 74 68 65 20 66 69 72 73 74 20 70  fact the first p
33a0: 72 6f 6a 65 63 74 0d 0a 73 75 62 6d 69 73 73 69  roject..submissi
33b0: 6f 6e 20 2a 63 61 6e 20 61 6e 64 20 2a 2a 73 68  on *can and **sh
33c0: 6f 75 6c 64 2a 2a 20 65 76 65 6e 2a 20 63 6f 6e  ould** even* con
33d0: 74 61 69 6e 20 61 20 66 75 6c 6c 20 72 65 63 6f  tain a full reco
33e0: 72 64 20 2d 20 69 6e 63 6c 75 64 69 6e 67 0d 0a  rd - including..
33f0: 74 68 65 20 63 75 72 72 65 6e 74 20 72 65 6c 65  the current rele
3400: 61 73 65 20 76 65 72 73 69 6f 6e 2f 69 6e 66 6f  ase version/info
3410: 2e 20 28 43 52 45 41 54 45 20 63 61 6e 6e 6f 74  . (CREATE cannot
3420: 20 62 65 20 75 73 65 64 20 74 6f 20 72 65 67 69   be used to regi
3430: 73 74 65 72 0d 0a 61 6c 6c 2d 65 6d 70 74 79 20  ster..all-empty 
3440: 6f 72 20 73 74 75 62 20 70 72 6f 6a 65 63 74 20  or stub project 
3450: 72 65 63 6f 72 64 73 2e 29 0d 0a 0d 0a 49 74 20  records.)....It 
3460: 63 61 6e 20 68 6f 77 65 76 65 72 20 61 6c 73 6f  can however also
3470: 20 6a 75 73 74 20 62 65 20 63 6f 6d 70 6c 65 74   just be complet
3480: 65 64 20 77 69 74 68 20 74 68 65 20 6e 65 78 74  ed with the next
3490: 20 3c 6b 62 64 3e 50 55 54 3c 2f 6b 62 64 3e 2f   <kbd>PUT</kbd>/
34a0: 55 70 64 61 74 65 2e 0d 0a 54 68 65 20 6f 6e 6c  Update...The onl
34b0: 79 20 72 65 71 75 69 72 65 6d 65 6e 74 73 20 66  y requirements f
34c0: 6f 72 20 3c 6b 62 64 3e 43 52 45 41 54 45 3c 2f  or <kbd>CREATE</
34d0: 6b 62 64 3e 20 61 72 65 20 61 20 6e 65 77 20 55  kbd> are a new U
34e0: 6e 69 78 20 70 72 6f 6a 65 63 74 60 3c 6e 61 6d  nix project`<nam
34f0: 65 3e 60 0d 0a 28 74 61 6b 65 6e 20 66 72 6f 6d  e>`..(taken from
3500: 20 74 68 65 20 72 65 71 75 65 73 74 20 55 52 4c   the request URL
3510: 29 2c 20 61 6e 64 20 61 20 22 60 74 69 74 6c 65  ), and a "`title
3520: 60 22 20 61 6e 64 20 22 60 64 65 73 63 72 69 70  `" and "`descrip
3530: 74 69 6f 6e 60 22 2c 0d 0a 22 60 6c 69 63 65 6e  tion`",.."`licen
3540: 73 65 60 22 20 6f 72 20 22 60 70 72 6f 6a 65 63  se`" or "`projec
3550: 74 5f 74 61 67 73 60 22 2c 20 61 6e 64 20 61 20  t_tags`", and a 
3560: 22 60 68 6f 6d 65 70 61 67 65 60 22 20 55 52 4c  "`homepage`" URL
3570: 2e 0d 0a 0d 0a 41 6e 64 20 6f 62 76 69 6f 75 73  .....And obvious
3580: 6c 79 20 74 68 69 73 20 69 73 20 74 68 65 20 6f  ly this is the o
3590: 6e 6c 79 20 74 69 6d 65 20 74 68 65 20 e2 80 b9  nly time the ...
35a0: 60 61 75 74 68 5f 63 6f 64 65 60 e2 80 ba 20 69  `auth_code`... i
35b0: 73 20 75 73 65 64 20 66 6f 72 0d 0a 70 6f 70 75  s used for..popu
35c0: 6c 61 74 69 6e 67 20 74 68 65 20 69 6e 74 65 72  lating the inter
35d0: 6e 61 6c 20 61 75 74 68 6f 72 69 7a 61 74 69 6f  nal authorizatio
35e0: 6e 20 68 61 73 68 2e 20 41 6c 6c 20 6f 74 68 65  n hash. All othe
35f0: 72 20 72 65 71 75 65 73 74 73 20 6a 75 73 74 0d  r requests just.
3600: 0a 63 6f 6d 70 61 72 65 20 69 74 2c 20 62 75 74  .compare it, but
3610: 20 43 52 45 41 54 45 20 64 6f 65 73 20 74 68 65   CREATE does the
3620: 20 63 72 65 61 74 69 76 65 20 73 74 65 70 2e 0d   creative step..
3630: 0a 0d 0a 43 6c 69 65 6e 74 20 53 53 4c 20 63 65  ...Client SSL ce
3640: 72 74 20 61 73 20 43 52 45 41 54 45 20 73 70 61  rt as CREATE spa
3650: 6d 67 75 61 72 64 3a 20 2a 2a 55 6e 64 65 63 69  mguard: **Undeci
3660: 64 65 64 2a 2a 20 2f 20 2a 54 65 73 74 69 6e 67  ded** / *Testing
3670: 2a 2e 20 20 0d 0a 53 65 65 20 61 6c 73 6f 20 5b  *.  ..See also [
3680: 2f 64 6f 63 2f 74 72 75 6e 6b 2f 64 6f 63 2f 73  /doc/trunk/doc/s
3690: 75 62 6d 69 74 2e 70 65 6d 5d 28 64 6f 63 2f 74  ubmit.pem](doc/t
36a0: 72 75 6e 6b 2f 64 6f 63 2f 73 75 62 6d 69 74 2e  runk/doc/submit.
36b0: 70 65 6d 29 20 66 6f 72 20 70 75 62 6c 69 63 0d  pem) for public.
36c0: 0a 61 75 74 68 6f 72 69 7a 61 74 69 6f 6e 20 6b  .authorization k
36d0: 65 79 2e 0d 0a 0d 0a 0d 0a 23 23 20 52 65 73 70  ey.......## Resp
36e0: 6f 6e 73 65 73 0d 0a 0d 0a 53 75 63 63 65 73 73  onses....Success
36f0: 66 75 6c 20 73 75 62 6d 69 73 73 69 6f 6e 73 20  ful submissions 
3700: 77 69 6c 6c 20 62 65 20 61 6e 73 77 65 72 65 64  will be answered
3710: 20 77 69 74 68 20 48 54 54 50 20 53 74 61 74 75   with HTTP Statu
3720: 73 20 32 30 31 20 61 6e 64 3a 0d 0a 0d 0a 20 20  s 201 and:....  
3730: 20 20 7b 0d 0a 20 20 20 20 20 20 20 20 22 73 75    {..        "su
3740: 63 63 65 73 73 22 3a 20 74 72 75 65 0d 0a 20 20  ccess": true..  
3750: 20 20 7d 0d 0a 0d 0a 57 68 65 72 65 61 73 20 65    }....Whereas e
3760: 72 72 6f 72 73 20 77 69 6c 6c 20 74 79 70 69 63  rrors will typic
3770: 61 6c 6c 79 20 63 61 72 72 79 20 61 20 48 54 54  ally carry a HTT
3780: 50 20 73 74 61 74 75 73 20 65 72 72 6f 72 20 61  P status error a
3790: 6e 64 20 73 6f 6d 65 20 76 61 67 75 65 6c 79 0d  nd some vaguely.
37a0: 0a 69 6e 74 65 72 65 73 74 69 6e 67 20 6e 6f 74  .interesting not
37b0: 65 73 20 69 6e 3a 0d 0a 0d 0a 20 20 20 20 7b 0d  es in:....    {.
37c0: 0a 20 20 20 20 20 20 20 20 22 65 72 72 6f 72 22  .        "error"
37d0: 3a 20 22 4d 69 73 73 69 6e 67 20 70 72 6f 6a 65  : "Missing proje
37e0: 63 74 20 74 69 74 6c 65 2c 20 73 75 6d 6d 61 72  ct title, summar
37f0: 79 2c 20 64 65 73 63 72 69 70 74 69 6f 6e 2c 20  y, description, 
3800: 68 6f 6d 65 70 61 67 65 2e 22 2c 0d 0a 20 20 20  homepage.",..   
3810: 20 20 20 20 20 22 70 72 6f 6a 65 63 74 22 3a 20       "project": 
3820: 7b 0d 0a 20 20 20 20 20 20 20 20 20 20 20 20 22  {..            "
3830: 6e 61 6d 65 22 3a 20 6e 75 6c 6c 0d 0a 20 20 20  name": null..   
3840: 20 20 20 20 20 7d 2c 0d 0a 20 20 20 20 20 20 20       },..       
3850: 20 22 64 61 74 61 22 3a 20 6e 75 6c 6c 0d 0a 20   "data": null.. 
3860: 20 20 20 7d 0d 0a 0d 0a 48 54 54 50 20 73 74 61     }....HTTP sta
3870: 74 75 73 20 63 6f 64 65 73 3a 0d 0a 0d 0a 20 2a  tus codes:.... *
3880: 20 22 32 30 30 20 4e 6f 20 63 6f 6e 74 65 6e 74   "200 No content
3890: 22 20 66 6f 72 20 75 6e 6b 6e 6f 77 20 70 72 6f  " for unknow pro
38a0: 6a 65 63 74 20 6e 61 6d 65 73 2e 0d 0a 20 2a 20  ject names... * 
38b0: 22 32 30 31 20 43 72 65 61 74 65 64 22 20 66 6f  "201 Created" fo
38c0: 72 20 73 75 63 63 65 73 73 66 75 6c 20 70 75 62  r successful pub
38d0: 6c 69 63 61 74 69 6f 6e 2e 0d 0a 20 2a 20 22 34  lication... * "4
38e0: 30 31 20 55 6e 61 75 74 68 6f 72 69 7a 65 64 22  01 Unauthorized"
38f0: 20 66 6f 72 20 61 6e 20 69 6e 76 61 6c 69 64 20   for an invalid 
3900: 60 61 75 74 68 5f 63 6f 64 65 60 2e 0d 0a 20 2a  `auth_code`... *
3910: 20 22 34 31 30 20 4f 62 73 6f 6c 65 74 65 22 20   "410 Obsolete" 
3920: 66 6f 72 20 47 45 54 20 2f 70 72 6f 6a 2f 72 65  for GET /proj/re
3930: 6c 65 61 73 65 73 2e 6a 73 6f 6e 2e 0d 0a 20 2a  leases.json... *
3940: 20 22 34 39 35 20 43 6c 69 65 6e 74 20 43 65 72   "495 Client Cer
3950: 74 22 20 6f 6e 20 43 52 45 41 54 45 20 72 65 71  t" on CREATE req
3960: 75 65 73 74 73 20 77 69 74 68 6f 75 74 20 73 75  uests without su
3970: 62 6d 69 74 2e 70 65 6d 0d 0a 20 2a 20 22 35 30  bmit.pem.. * "50
3980: 30 20 44 42 20 45 72 72 6f 72 22 20 66 6f 72 20  0 DB Error" for 
3990: 73 65 72 76 65 72 20 66 61 69 6c 75 72 65 73 2e  server failures.
39a0: 0d 0a 20 2a 20 22 35 30 31 20 4e 6f 74 20 69 6d  .. * "501 Not im
39b0: 70 6c 65 6d 65 6e 74 65 64 22 20 66 6f 72 20 75  plemented" for u
39c0: 6e 6b 6e 6f 77 6e 20 72 65 71 75 65 73 74 20 6d  nknown request m
39d0: 65 74 68 6f 64 73 2f 70 61 74 68 73 2e 0d 0a 20  ethods/paths... 
39e0: 2a 20 22 35 30 33 20 55 6e 61 76 61 69 6c 61 62  * "503 Unavailab
39f0: 6c 65 22 20 69 73 20 75 6e 6c 69 6b 65 6c 79 20  le" is unlikely 
3a00: 74 6f 20 68 61 70 70 65 6e 2e 0d 0a 0d 0a 0d 0a  to happen.......
3a10: 23 23 20 53 65 63 75 72 69 74 79 20 63 6f 6e 73  ## Security cons
3a20: 69 64 65 72 61 74 69 6f 6e 73 0d 0a 0d 0a 4e 6f  iderations....No
3a30: 77 20 74 68 61 74 27 73 20 73 6c 69 67 68 74 6c  w that's slightl
3a40: 79 20 69 72 72 65 6c 65 76 61 6e 74 20 66 6f 72  y irrelevant for
3a50: 20 41 50 49 20 75 73 61 67 65 2c 20 69 6e 20 70   API usage, in p
3a60: 61 72 74 69 63 75 6c 61 72 20 66 6f 72 20 6a 75  articular for ju
3a70: 73 74 20 70 6f 6c 6c 69 6e 67 0d 0a 6f 72 20 75  st polling..or u
3a80: 70 64 61 74 69 6e 67 20 79 6f 75 72 20 6f 77 6e  pdating your own
3a90: 20 70 72 6f 6a 65 63 74 20 72 65 63 6f 72 64 73   project records
3aa0: 2e 0d 0a 0d 0a 20 20 2d 20 42 75 74 20 74 68 65  .....  - But the
3ab0: 20 6e 61 6d 69 6e 67 20 73 63 68 65 6d 65 20 6f   naming scheme o
3ac0: 6e 20 66 72 65 73 68 63 6f 64 65 20 61 6c 73 6f  n freshcode also
3ad0: 20 70 65 72 6d 69 74 73 20 70 72 6f 6a 65 63 74   permits project
3ae0: 20 6e 61 6d 65 73 20 6c 69 6b 65 0d 0a 20 20 20   names like..   
3af0: 20 60 63 6f 6d 6d 6f 6e 6d 61 72 6b 2e 6a 73 60   `commonmark.js`
3b00: 20 6f 72 20 60 74 61 62 6c 65 2d 67 65 6e 65 72   or `table-gener
3b10: 61 74 6f 72 2e 73 68 60 2e 20 20 53 6f 20 73 6f  ator.sh`.  So so
3b20: 6d 65 20 63 61 72 65 20 73 68 6f 75 6c 64 20 62  me care should b
3b30: 65 20 74 61 6b 65 6e 0d 0a 20 20 20 20 62 65 66  e taken..    bef
3b40: 6f 72 65 20 75 73 69 6e 67 20 74 68 65 20 72 65  ore using the re
3b50: 74 75 72 6e 65 64 20 70 72 6f 6a 65 63 74 20 6e  turned project n
3b60: 61 6d 65 73 20 61 73 20 6c 69 74 65 72 61 6c 20  ames as literal 
3b70: 66 69 6c 65 6e 61 6d 65 73 2e 0d 0a 20 20 2d 20  filenames...  - 
3b80: 44 65 73 63 72 69 70 74 69 6f 6e 20 66 69 65 6c  Description fiel
3b90: 64 73 20 61 72 65 20 6d 6f 73 74 6c 79 20 6a 75  ds are mostly ju
3ba0: 73 74 20 66 69 6c 74 65 72 65 64 20 66 6f 72 20  st filtered for 
3bb0: 70 72 69 6e 74 61 62 6c 65 20 63 68 61 72 61 63  printable charac
3bc0: 74 65 72 73 2e 20 0d 0a 20 20 2d 20 4f 6e 6c 79  ters. ..  - Only
3bd0: 20 48 6f 6d 65 70 61 67 65 20 61 6e 64 20 44 6f   Homepage and Do
3be0: 77 6e 6c 6f 61 64 20 55 52 4c 73 20 61 72 65 20  wnload URLs are 
3bf0: 67 75 61 72 61 6e 74 65 65 64 20 74 6f 20 62 65  guaranteed to be
3c00: 20 48 54 54 50 20 72 65 66 65 72 65 6e 63 65 73   HTTP references
3c10: 2e 0d 0a 0d 0a 0d 0a 0a 5a 20 63 38 63 35 37 37  ........Z c8c577
3c20: 34 38 30 61 37 34 64 37 66 64 61 35 32 65 32 34  480a74d7fda52e24
3c30: 35 63 32 30 38 65 66 39 37 32 0a                 5c208ef972.