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.

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

Update to Content-Type #27

Closed
commbankoss opened this issue Oct 24, 2019 · 3 comments
Closed

Update to Content-Type #27

commbankoss opened this issue Oct 24, 2019 · 3 comments

Comments

@commbankoss
Copy link

Content-Type is currently listed as a mandatory request header. We recommend that it is only mandatory for verbs where there is a body (most commonly PUT and POST) and optional for the verbs where there is no body. It should not be mandatory to send a request type as the content may not be present in all scenarios.

@CDR-API-Stream CDR-API-Stream added this to Full Backlog in Data Standards Maintenance via automation Oct 25, 2019
@CDR-API-Stream CDR-API-Stream moved this from Full Backlog to Iteration Candidates in Data Standards Maintenance Oct 25, 2019
@perlboy
Copy link

perlboy commented Nov 1, 2019

Content-type is currently specified within FAPI Part 1 Section 6.2.1 as:
shall send the Content-type HTTP header Content-Type: application/json; charset=UTF-8 if applicable;

However, as of the past 2 weeks the FAPI specification is proposed to change to:
shall send the Content-type HTTP header Content-Type: application/json; if applicable;

Which aligns with ACDS, on this basis the ACDS could change this section to simply refer to FAPI Part 1 Section 6.2.1, add if applicable or both.

@CDR-API-Stream CDR-API-Stream moved this from Iteration Candidates to In progress in Data Standards Maintenance Nov 5, 2019
@CDR-API-Stream
Copy link
Collaborator

This highlights something we will need to address in the near term within the CDR standards.

Basically, if the normative standards iterate what are the implications on data holder and data recipient compliance with those changes? As we are nearing our second implementation milestone and the first to include substantial normative references this will become an issue to manage within the standards. This will be raised internally within the DSB for discussion to consider the implications.

To ensure clarity for the time being the treatment of Content-Type will be retained in the standards.

In response to this specific change request the recommended approach would be to clarify the mandatory status of the Content-Type request header to PUT and POST calls only.

@CDR-API-Stream CDR-API-Stream moved this from In progress to Awaiting Chair Approval in Data Standards Maintenance Nov 6, 2019
@CDR-API-Stream
Copy link
Collaborator

For normative standards the DSB will also recommend that the normative reference table have an additional version/date column indicating the version of the normative reference that is applicable to the CDR standards.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Archived in project
Development

No branches or pull requests

3 participants