are the headers the same in every endpoint?
one way to look at it is that if they are the same across all the endpoints maybe we want to explain it once in a separate page?
or is it necessary in every page ?
WDYT?

this is an example of a custom header in the CoCo responses as well but we defined it once in a page

are the headers the same in every endpoint? one way to look at it is that if they are the same across all the endpoints maybe we want to explain it once in a separate page? or is it necessary in every page ? WDYT?

this is an example of a custom header in the CoCo responses as well but we defined it once in a page

@FFawzy sorry for the late reply. I must have missed the notification.
Nope, the headers are not always the same. Furthermore, some are standard headers while some are "frontend-custom" headers. Therefore, I think that having a shared separate page would not be ideal.

@timonrey First step is to make and analysis of the ticket and the expected outcome is a tech proposal on how to implement the feature (check if rmfgen is supporting this feature)

I tried out the raml file that is provided in the description with the custom header to see if rmf-codegen supports this data structure, but it looks like the headers are not being generated.

@jenschude maybe you can double-check, but we will probably need an update from the rmf-codegen to support this use-case. Any thoughts from your side are welcome as always ;)

I tried out the raml file provided in the description with the custom header to see if rmf-codegen supports this data structure, but it looks like the headers are not being generated.

@jenschude maybe you can double-check, but we will probably need an update from the rmf-codegen to support this use-case. Any thoughts from your side are welcome as always ;)

@timonrey (cc @jenschude) what I did was moving the first headers "in the method" like this:

get:
  is:
    - right-header
    - frontastic-locale
  headers:
    Frontastic-Path:
      displayName: Frontastic Path
      type: string
      description: Path
      required: true
      pattern: ^/.*$
  description: |

I forgot to update the issue description, now it's updated. They are rendered in the cURL examples now, but we would also need to render them in the endpoint description. For the moment, they're handwritten.

Update to at least version 13.23. of the codegen. Then the headers are in the resource files and the curl examples

Why is this issue blocked? If you need more input to groom it, please reach out to me 🙂

@timonrey can we help clarify anything to unblock this issue?

If I remember correctly, there was still a problem with the data structure rmf-codegen can work with. But maybe that's not the case anymore. I will unblock it and revisit the issue.

Update: The rmf codegen is generating the required fields correctly so we can move forward with the implementation as soon as agreed on the design. @zbalek

The docs-team agreed on the visual implementation:
https://commercetools.atlassian.net/wiki/spaces/DOCS/pages/699793472/Docs+Team+Weekly+2024-04-17

Hi @timonrey, we need to do some work on Frontend API docs before this feature goes live on the published docs. Do you have a timeline for the release of this change? So we can prepare.

@Anshuman71 We can release it whenever you feel ready. If it's not too much work you could also adjust the frontend API in the release preview PR in the docs repo.

Hi @timonrey, thanks. Can you link the preview PR here? I'll start the work on it.

#1978
And the smoke-test example:
https://docskit-tt-display-request-headers.commercetools.vercel.app/api-docs-smoke-test/endpoints/endpoints-for-resource#projectkeyresourcenamespace-action-with-headers