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

Add documentation and sample for OpenApi configuration #602

Closed
64J0 opened this issue Jul 11, 2024 · 11 comments · Fixed by #624
Closed

Add documentation and sample for OpenApi configuration #602

64J0 opened this issue Jul 11, 2024 · 11 comments · Fixed by #624
Labels
documentation Request to change or extend documentation

Comments

@64J0
Copy link
Member

64J0 commented Jul 11, 2024

Description:

Follow-up from this PR: #599.

We basically need:

  • Some paragraphs explaining how this configuration works and how to use it;
  • A new sample project.
@64J0 64J0 added the documentation Request to change or extend documentation label Jul 11, 2024
@nojaf
Copy link
Contributor

nojaf commented Jul 11, 2024

@64J0 are you also on board with moving https://github.com/mrtz-j/Giraffe.OpenApi to https://github.com/giraffe-fsharp?

@64J0
Copy link
Member Author

64J0 commented Jul 11, 2024

@64J0 are you also on board with moving https://github.com/mrtz-j/Giraffe.OpenApi to https://github.com/giraffe-fsharp?

@nojaf +/-, I know the intention exists, but I'm not aware of how the move process is going.

@nojaf
Copy link
Contributor

nojaf commented Jul 12, 2024

Well @mrtz-j would need to transfer it (via https://github.com/mrtz-j/Giraffe.OpenApi/transfer) to giraffe-fsharp.

Once that happens I believe some administrator in that organization would need to accept and that would move it. A next step would then be to setup NuGet publishing similar to how it work for the other packages in Giraffe.

@mrtz-j
Copy link
Contributor

mrtz-j commented Jul 12, 2024

I am ready to transfer it. I just need to know if I need to be invited into the organization or if I can simply transfer it and then create PRs to finish the Nuget-setup/README.

@nojaf
Copy link
Contributor

nojaf commented Jul 12, 2024

Did you try

image

@mrtz-j
Copy link
Contributor

mrtz-j commented Jul 12, 2024

Yes. I tried to do that, but I got the following error message: You don’t have the permission to create public repositories on giraffe-fsharp.

@nojaf
Copy link
Contributor

nojaf commented Jul 12, 2024

Ok, I see. Could you add me as administrator to the repo? I believe I'm admin in the giraffe-org

@nojaf
Copy link
Contributor

nojaf commented Jul 12, 2024

@mrtz-j thanks for the invite, I need to be admin on that repo as well to transfer it.

@mrtz-j
Copy link
Contributor

mrtz-j commented Jul 12, 2024

It seems that I can only give you write/read access, but not admin. I'll try to transfer the repo to you instead, and then you can add it to the Giraffe org.

@64J0
Copy link
Member Author

64J0 commented Jul 17, 2024

Imported the repo here: https://github.com/giraffe-fsharp/Giraffe.OpenApi.

@mrtz-j
Copy link
Contributor

mrtz-j commented Jul 20, 2024

I've added some documentation and update the sample app here. It will use the available ENV-variables to push it to NuGet.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Request to change or extend documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants