Commit b12752db authored by Muhammad Hamza's avatar Muhammad Hamza
Browse files

update IETF RFCs references

parent 2a2a21f6
Loading
Loading
Loading
Loading
Loading
+2 −2
Original line number Diff line number Diff line
@@ -648,7 +648,7 @@ components:
            type: string
        Content-Type:
          description: |
            The MIME type of the body of the response. Reference: IETF RFC 7231
            The MIME type of the body of the response. Reference: IETF RFC 9110
          style: simple
          explode: false
          schema:
@@ -856,7 +856,7 @@ components:
            type: string
        Content-Type:
          description: |
            The MIME type of the body of the response. Reference: IETF RFC 7231
            The MIME type of the body of the response. Reference: IETF RFC 9110
          style: simple
          explode: false
          schema:
+9 −9
Original line number Diff line number Diff line
@@ -462,7 +462,7 @@ components:
            type: string
        Content-Type:
          description: |
            The MIME type of the body of the response. Reference: IETF RFC 7231
            The MIME type of the body of the response. Reference: IETF RFC 9110
          style: simple
          explode: false
          schema:
@@ -504,7 +504,7 @@ components:
            type: string
        Content-Type:
          description: |
            The MIME type of the body of the response. Reference: IETF RFC 7231
            The MIME type of the body of the response. Reference: IETF RFC 9110
          style: simple
          explode: false
          schema:
@@ -562,7 +562,7 @@ components:
            type: string
        Content-Type:
          description: |
            The MIME type of the body of the response. Reference: IETF RFC 7231
            The MIME type of the body of the response. Reference: IETF RFC 9110
          style: simple
          explode: false
          schema:
@@ -605,7 +605,7 @@ components:
            type: string
        Content-Type:
          description: |
            The MIME type of the body of the response. Reference: IETF RFC 7231
            The MIME type of the body of the response. Reference: IETF RFC 9110
          style: simple
          explode: false
          schema:
@@ -648,7 +648,7 @@ components:
            type: string
        Content-Type:
          description: |
            The MIME type of the body of the response. Reference: IETF RFC 7231
            The MIME type of the body of the response. Reference: IETF RFC 9110
          style: simple
          explode: false
          schema:
@@ -695,7 +695,7 @@ components:
            type: string
        Content-Type:
          description: |
            The MIME type of the body of the response. Reference: IETF RFC 7231
            The MIME type of the body of the response. Reference: IETF RFC 9110
          style: simple
          explode: false
          schema:
@@ -738,7 +738,7 @@ components:
            type: string
        Content-Type:
          description: |
            The MIME type of the body of the response. Reference: IETF RFC 7231
            The MIME type of the body of the response. Reference: IETF RFC 9110
          style: simple
          explode: false
          schema:
@@ -779,7 +779,7 @@ components:
            type: string
        Content-Type:
          description: |
            The MIME type of the body of the response. Reference: IETF RFC 7231
            The MIME type of the body of the response. Reference: IETF RFC 9110
          style: simple
          explode: false
          schema:
@@ -821,7 +821,7 @@ components:
            type: string
        Content-Type:
          description: |
            The MIME type of the body of the response. Reference: IETF RFC 7231
            The MIME type of the body of the response. Reference: IETF RFC 9110
          style: simple
          explode: false
          schema:
+3 −3
Original line number Diff line number Diff line
@@ -12,7 +12,7 @@ components:
    Accept:
      name: Accept
      description: >
        Content-Types that are acceptable for the response. Reference: IETF RFC 7231.
        Content-Types that are acceptable for the response. Reference: IETF RFC 9110.
      in: header
      required: true
      schema:
@@ -21,7 +21,7 @@ components:
    Authorization:
      name: Authorization
      description: >
        The authorization token for the request. Reference: IETF RFC 7235.
        The authorization token for the request. Reference: IETF RFC 9110.
      in: header
      required: false
      schema:
@@ -30,7 +30,7 @@ components:
    ContentType:
      name: Content-Type
      description: |
        The MIME type of the body of the request. Reference: IETF RFC 7231
        The MIME type of the body of the request. Reference: IETF RFC 9110
      in: header
      required: true
      schema:
+2 −2
Original line number Diff line number Diff line
@@ -170,12 +170,12 @@ definitions:
          A short, human-readable summary of the problem
          type.  It SHOULD NOT change from occurrence to occurrence of the
          problem, except for purposes of localization (e.g., using
          proactive content negotiation; see [RFC7231], Section 3.4).
          proactive content negotiation; see [RFC9110], Section 3.4).
        type: string
      status:
        description: >
          The HTTP status code for this occurrence of the problem.
          The HTTP status code ([RFC7231], Section 6) generated by the origin
          The HTTP status code ([RFC9110], Section 6) generated by the origin
          server for this occurrence of the problem.
        type: integer
      detail:
+29 −24
Original line number Diff line number Diff line
@@ -45,27 +45,32 @@ responses:
      400 code can be returned in the following specified cases, the specific cause has to be proper specified in the
      "ProblemDetails" structure to be returned.

      If the request is malformed or syntactically incorrect (e.g. if the request URI contains incorrect
      query parameters or the payload body contains a syntactically incorrect data structure),
      the API producer shall respond with this response code. The "ProblemDetails" structure shall be provided,
      and should include in the "detail" attribute more information about the source of the problem.

      If the response to a GET request which queries a container resource would be so big that the performance
      of the API producer is adversely affected, and the API producer does not support paging for the affected resource,
      it shall respond with this response code. The "ProblemDetails" structure shall be provided, and should include
      in the "detail" attribute more information about the source of the problem.

      If there is an application error related to the client's input that cannot be easily mapped to any other
      HTTP response code ("catch all error"), the API producer shall respond with this response code.
      The "ProblemDetails" structure shall be provided, and shall include in the "detail" attribute more information
      If the request is malformed or syntactically incorrect (e.g. if the request URI
      contains incorrect query parameters or the message content contains a syntactically
      incorrect data structure), the API producer shall respond with this response code.
      More details are defined in IETF RFC 9110 [24]. The "ProblemDetails" structure
      shall be provided, and should include in the "detail" attribute more information
      about the source of the problem. 

      If the request contains a malformed access token, the API producer should respond with this response.
      The details of the error shall be returned in the WWW Authenticate HTTP header, as defined in IETF RFC 6750
      and IETF RFC 7235. The ProblemDetails structure may be provided.

      The use of this HTTP error response code described above is applicable to the use of the OAuth 2.0
      for the authorization of API requests and notifications, as defined in clauses 4.5.3.3 and 4.5.3.4.
      If the response to a GET request which queries a container resource would be so big
      that the performance of the API producer is adversely affected, and the API
      producer does not support paging for the affected resource, it shall respond with this
      response code. Clause 5.4.2.2 specifies provisions for the "ProblemDetails" structure
      provided in the response body. 

      If there is an application error related to the client's input that cannot be easily
      mapped to any other HTTP response code ("catch all error"), the API producer shall
      respond with this response code. The "ProblemDetails" structure shall be provided,
      and shall include in the "detail" attribute more information about the source of the
      problem. 

      If the request contains a malformed access token, the API producer should respond
      with this response. The details of the error shall be returned in the
      WWW-Authenticate HTTP header, as defined in IETF RFC 6750 [8]. The
      ProblemDetails structure may be provided. 

      The use of this HTTP error response code described above is applicable to the use of the OAuth 2.0 for
      the authorization of API requests and notifications, as defined in clauses 8.3.3 and 8.3.4. 
    headers:
      Content-Type:
        description: The MIME type of the body of the response.
@@ -101,7 +106,7 @@ responses:
      If the request contains no access token even though one is required, or if the request contains an authorization
      token that is invalid (e.g. expired or revoked), the API producer should respond with this response.
      The details of the error shall be returned in the WWW-Authenticate HTTP header, as defined in IETF RFC 6750
      and IETF RFC 7235. The ProblemDetails structure may be provided.
      and IETF RFC 9110. The ProblemDetails structure may be provided.
    headers:
      Content-Type:
        description: The MIME type of the body of the response.
@@ -348,7 +353,7 @@ responses:
      413 PAYLOAD TOO LARGE

      If the payload body of a request is larger than the amount of data the API producer is willing or able to process,
      it shall respond with this response code, following the provisions in IETF RFC 7231 for the use
      it shall respond with this response code, following the provisions in IETF RFC 9110 for the use
      of the "Retry-After" HTTP header and for closing the connection. The "ProblemDetails" structure may be omitted.
    headers:
      Content-Type:
@@ -563,7 +568,7 @@ responses:
      503 SERVICE UNAVAILABLE

      If the API producer encounters an internal overload situation of itself or of a system it relies on,
      it should respond with this response code, following the provisions in IETF RFC 7231 for the use of
      it should respond with this response code, following the provisions in IETF RFC 9110 for the use of
      the "Retry-After" HTTP header and for the alternative to refuse the connection. The "ProblemDetails"
      structure may be omitted.
    headers: