Document 406 error for all endpoints

metabrainz · Jul 31, 2019 · 7633f5c · 7633f5c
1 parent 22ee080
commit 7633f5c
Show file tree

Hide file tree

Showing 5 changed files with 40 additions and 1 deletion.
diff --git a/src/api/routes/author.js b/src/api/routes/author.js
@@ -100,6 +100,8 @@ const authorError = 'Author not found';
  *             $ref: '#/definitions/AuthorDetail'
  *       404:
  *         description: Author not found
+ *       406:
+ *         description: Invalid BBID
  */
 
 router.get('/:bbid',
@@ -134,6 +136,8 @@ router.get('/:bbid',
  *             $ref: '#/definitions/Aliases'
  *       404:
  *         description: Author not found
+ *       406:
+ *         description: Invalid BBID
  */
 
 router.get('/:bbid/aliases',
@@ -167,6 +171,8 @@ router.get('/:bbid/aliases',
  *             $ref: '#/definitions/Identifiers'
  *       404:
  *         description: Author not found
+ *       406:
+ *         description: Invalid BBID
  */
 router.get('/:bbid/identifiers',
 	makeEntityLoader('Author', identifiersRelation, authorError),
@@ -199,6 +205,8 @@ router.get('/:bbid/identifiers',
  *             $ref: '#/definitions/Relationships'
  *       404:
  *         description: Author not found
+ *       406:
+ *         description: Invalid BBID
  */
 
 router.get('/:bbid/relationships',

diff --git a/src/api/routes/edition-group.js b/src/api/routes/edition-group.js
@@ -78,7 +78,8 @@ const editionGroupError = 'Edition Group not found';
  *              $ref: '#/definitions/EditionGroupDetail'
  *        404:
  *          description: Edition Group not found
- *
+ *        406:
+ *          description: Invalid BBID
  */
 
 router.get('/:bbid',
@@ -112,6 +113,8 @@ router.get('/:bbid',
  *             $ref: '#/definitions/Aliases'
  *       404:
  *         description: Edition Group not found
+ *       406:
+ *         description: Invalid BBID
  */
 
 router.get('/:bbid/aliases',
@@ -145,6 +148,8 @@ router.get('/:bbid/aliases',
  *             $ref: '#/definitions/Identifiers'
  *       404:
  *         description: Edition Group not found
+ *       406:
+ *         description: Invalid BBID
  */
 
 router.get('/:bbid/identifiers',
@@ -179,6 +184,8 @@ router.get('/:bbid/identifiers',
  *             $ref: '#/definitions/Relationships'
  *       404:
  *         description: Edition Group not found
+ *       406:
+ *         description: Invalid BBID
  */
 
 router.get('/:bbid/relationships',

diff --git a/src/api/routes/edition.js b/src/api/routes/edition.js
@@ -113,6 +113,8 @@ const editionError = 'Edition not found';
  *              $ref: '#/definitions/EditionDetail'
  *        404:
  *          description: Edition not found
+ *        406:
+ *          description: Invalid BBID
  */
 
 
@@ -147,6 +149,8 @@ router.get('/:bbid',
  *             $ref: '#/definitions/Aliases'
  *       404:
  *         description: Edition not found
+ *       406:
+ *         description: Invalid BBID
  */
 
 router.get('/:bbid/aliases',
@@ -180,6 +184,8 @@ router.get('/:bbid/aliases',
  *             $ref: '#/definitions/Identifiers'
  *       404:
  *         description: Edition not found
+ *       406:
+ *         description: Invalid BBID
  */
 
 router.get('/:bbid/identifiers',
@@ -213,6 +219,8 @@ router.get('/:bbid/identifiers',
  *             $ref: '#/definitions/Relationships'
  *       404:
  *         description: Edition not found
+ *       406:
+ *         description: Invalid BBID
  */
 
 router.get('/:bbid/relationships',

diff --git a/src/api/routes/publisher.js b/src/api/routes/publisher.js
@@ -95,6 +95,8 @@ const publisherError = 'Publisher not found';
  *              $ref: '#/definitions/PublisherDetail'
  *        404:
  *          description: Publisher not found
+ *        406:
+ *          description: Invalid BBID
  */
 
 router.get('/:bbid',
@@ -128,6 +130,8 @@ router.get('/:bbid',
  *              $ref: '#/definitions/Aliases'
  *        404:
  *          description: Publisher not found
+ *        406:
+ *          description: Invalid BBID
  */
 router.get('/:bbid/aliases',
 	makeEntityLoader('Publisher', aliasesRelation, publisherError),
@@ -160,6 +164,8 @@ router.get('/:bbid/aliases',
  *             $ref: '#/definitions/Identifiers'
  *       404:
  *         description: Publisher not found
+ *       406:
+ *         description: Invalid BBID
  */
 
 router.get('/:bbid/identifiers',
@@ -193,6 +199,8 @@ router.get('/:bbid/identifiers',
  *             $ref: '#/definitions/Relationships'
  *       404:
  *         description: Publisher not found
+ *       406:
+ *         description: Invalid BBID
  */
 
 router.get('/:bbid/relationships',

diff --git a/src/api/routes/work.js b/src/api/routes/work.js
@@ -87,6 +87,8 @@ const workError = 'Work not found';
  *             $ref: '#/definitions/WorkDetail'
  *       404:
  *         description: Work not found
+ *       406:
+ *         description: Invalid BBID
  */
 
 router.get('/:bbid',
@@ -121,6 +123,8 @@ router.get('/:bbid',
  *              $ref: '#/definitions/Aliases'
  *        404:
  *          description: Work not found
+ *        406:
+ *          description: Invalid BBID
  */
 
 
@@ -155,6 +159,8 @@ router.get('/:bbid/aliases',
  *             $ref: '#/definitions/Identifiers'
  *       404:
  *         description: Work not found
+ *       406:
+ *         description: Invalid BBID
  */
 
 router.get('/:bbid/identifiers',
@@ -189,6 +195,8 @@ router.get('/:bbid/identifiers',
  *             $ref: '#/definitions/Relationships'
  *       404:
  *         description: Work not found
+ *       406:
+ *         description: Invalid BBID
  */
 
 router.get('/:bbid/relationships',