Project

General

Profile

Task #1330

Story #1906: Review, revise, and update architecture documentation

REST interface docs

Added by Roger Dahl almost 11 years ago. Updated about 7 years ago.

Status:
Closed
Priority:
Normal
Assignee:
Category:
Documentation
Target version:
Start date:
2011-02-09
Due date:
% Done:

100%

Milestone:
CCI-1.0.0
Product Version:
*
Story Points:
Sprint:

Description

We need some notation to describe how the different arguments are passed in the REST interface. For instance, MN_crud.update() has PID in the URL, and obsoletedPID in an MMP field, but there’s no difference between them in the argument list. Possibilities include URL, HTTP header, MMP field, MMP file.

History

#1 Updated by Roger Dahl about 10 years ago

  • Category set to Documentation
  • Assignee set to Dave Vieglais
  • Parent task changed from #1329 to #1906
  • Milestone set to CCI-1.0.0

#2 Updated by Dave Vieglais about 10 years ago

  • Status changed from New to Closed

Parameters passed in the URL are indicated as such in the URL template. All other parameters are placed in the request body unless explicitly indicated otherwise, such as values transmitted in the HTTP header of the request. This is documented in http://mule1.dataone.org/ArchitectureDocs-current/apis/REST_overview.html

#3 Updated by Dave Vieglais about 7 years ago

  • Target version set to Maintenance Backlog

Also available in: Atom PDF

Add picture from clipboard (Maximum size: 14.8 MB)